DL Logo

PDESoftMask Enumerations

PDESoftMaskCreateFlags

Header: PEExpT.h:2046

Description

Flags for use with PDESoftMaskCreate().

Enum Constants

kPDESoftMaskTypeLuminosity=0x0001
Specifies how the mask is to be computed.
kPDESoftMaskTypeAlpha=0x0002
Specifies how the mask is to be computed.

Used By

PDESoftMask Typedefs

PDESoftMask

Header: PEExpT.h:375

Description

An object for creating and manipulating a soft mask in a PDF file.

Related Methods

Syntax

typedef struct _t_PDESoftMask *PDESoftMask;

Returned From

Used By

PDESoftMask Functions

PDESoftMaskAcquireForm

Header: PERProcs.h:1930

Description

Superseded by PDESoftMaskAcquireFormEx() in Acrobat 10.0. Acquires the PDEForm that defines the soft mask.

Call PDERelease() to dispose of the PDEForm when finished with it.

Related Methods

Syntax

PDEForm PDESoftMaskAcquireForm(IN PDESoftMask pdeSoftMask, IN ASFixedMatrixP matrixP);

Parameters

pdeSoftMask
IN/OUT An object of type PDESoftMask.
matrixP
IN/OUT A matrix defining the transformation from coordinate space to user space.

Returns

The XObject form of the soft mask.

Exceptions

PDESoftMaskAcquireFormEx

Header: PERProcs.h:3134

Description

Supersedes PDESoftMaskAcquireForm() in Acrobat 10.0. Acquires the PDEForm that defines the soft mask.

Call PDERelease() to dispose of the PDEForm when finished with it.

Related Methods

Syntax

PDEForm PDESoftMaskAcquireFormEx(IN PDESoftMask pdeSoftMask, IN ASDoubleMatrixP matrixP);

Parameters

pdeSoftMask
IN/OUT An object of type PDESoftMask.
matrixP
IN/OUT A matrix defining the transformation from coordinate space to user space.

Returns

The XObject form of the soft mask.

Exceptions

PDESoftMaskCreate

Header: PEWProcs.h:1734

Description

Creates a new soft mask object.

Call PDERelease() to dispose of the returned PDESoftMask object when finished with it.

Syntax

PDESoftMask PDESoftMaskCreate(IN CosDoc cosDoc, IN PDESoftMaskCreateFlags type, IN PDEForm pdeForm);

Parameters

cosDoc
IN/OUT The container document.
type
IN/OUT Specifies how the mask is to be computed. It is one of the PDESoftMaskCreateFlags.
pdeForm
IN/OUT The form XObject that defines the soft mask. It is the source of the mask values and the PDColorSpace in which the composite computation is to be done.

Returns

The newly created object.

PDESoftMaskCreateFromCosObj

Header: PEWProcs.h:1719

Description

Creates a new soft mask object from its Cos representation.

Call PDERelease() to dispose of the returned PDESoftMask object when finished with it.

Syntax

PDESoftMask PDESoftMaskCreateFromCosObj(IN const CosObj *cosObjP);

Parameters

cosObjP
IN/OUT The soft mask dictionary.

Returns

The newly created object.

PDESoftMaskCreateFromName

Header: PEWProcs.h:2256

Description

Create a new soft mask from a name.

Call PDERelease() to dispose of the returned PDESoftMask object when finished with it.

Syntax

PDESoftMask PDESoftMaskCreateFromName(IN ASAtom name);

Parameters

name
IN/OUT The new name for the soft mask. Note that, currently, the only valid name is None.

Returns

The newly created object.

PDESoftMaskGetBackdropColor

Header: PERProcs.h:1947

Description

Gets the array of color values of the backdrop color. Given a pointer to an array and the length of the array, it copies the color values to that array and returns the number of values copied. If the pointer to the array is NULL, the number of color values is returned.

Syntax

ASInt32 PDESoftMaskGetBackdropColor(IN PDESoftMask pdeSoftMask, IN ASFixed *pColorValues, IN ASInt32 numValues);

Parameters

pdeSoftMask
IN/OUT An object of type PDESoftMask.
pColorValues
IN/OUT (Filled by the method) A pointer to an array of color values. If it is NULL, the number of color values is returned.
numValues
IN/OUT The length of the array pColorValues.

Returns

The number of values copied.

PDESoftMaskGetCosObj

Header: PERProcs.h:1913

Description

Gets the associated CosObj of the soft mask.

Syntax

void PDESoftMaskGetCosObj(IN PDESoftMask pdeSoftMask, OUT CosObj *cosObjP);

Parameters

pdeSoftMask
IN/OUT The soft mask.
cosObjP
IN/OUT (Filled by the method) A pointer to the Cos object.

Exceptions

PDESoftMaskGetName

Header: PERProcs.h:2322

Description

Gets the soft mask name.

Syntax

ASAtom PDESoftMaskGetName(IN PDESoftMask pdeSoftMask);

Parameters

pdeSoftMask
IN/OUT The soft mask.

Returns

The soft mask name if it is a name; it returns ASAtomNull otherwise.

PDESoftMaskGetTransferFunction

Header: PERProcs.h:1957

Description

Gets the transfer function as a CosObj.

Syntax

CosObj PDESoftMaskGetTransferFunction(IN PDESoftMask pdeSoftMask);

Parameters

pdeSoftMask
IN/OUT The soft mask.

Returns

The transfer function as a CosObj.

PDESoftMaskSetBackdropColor

Header: PEWProcs.h:1754

Description

Sets the backdrop color values.

Syntax

void PDESoftMaskSetBackdropColor(IN PDESoftMask pdeSoftMask, IN ASFixed *pColorValues, IN ASInt32 numValues);

Parameters

pdeSoftMask
IN/OUT The soft mask object.
pColorValues
IN/OUT A series of color values.
numValues
IN/OUT The number of values pointed to by pColorValues.

PDESoftMaskSetTransferFunction

Header: PEWProcs.h:1766

Description

Sets the transfer function associated with the soft mask.

Syntax

void PDESoftMaskSetTransferFunction(IN PDESoftMask pdeSoftMask, IN CosObj cosTransferFunction);

Parameters

pdeSoftMask
IN/OUT The soft mask object.
cosTransferFunction
IN/OUT The transfer function dictionary.

PDESoftMaskSetXGroup

Header: PEWProcs.h:1743

Description

Sets the PDEForm that defines the soft mask.

Syntax

void PDESoftMaskSetXGroup(IN PDESoftMask pdeSoftMask, IN PDEForm pdeForm);

Parameters

pdeSoftMask
IN/OUT The soft mask object.
pdeForm
IN/OUT The form XObject.