LayerPDFEdit_Layer
ObjectPDESoftMask

A PDESoftMask is a reference to a SoftMask resource used to support transparency.


Typedef Summary
 Typedef
 PDESoftMask
An object for creating and manipulating a soft mask in a PDF file.
Enumeration Summary
 Enumeration
  PDESoftMaskCreateFlags
Flags for use with PDESoftMaskCreate().
Method Summary
 Method
 
PDEForm PDESoftMaskAcquireForm(INPDESoftMask pdeSoftMask, INASFixedMatrixP matrixP)
Superseded by PDESoftMaskAcquireFormEx() in Acrobat 10.0.
 
PDEForm PDESoftMaskAcquireFormEx(INPDESoftMask pdeSoftMask, INASDoubleMatrixP matrixP)
Supersedes PDESoftMaskAcquireForm() in Acrobat 10.0.
 
PDESoftMask PDESoftMaskCreate(INCosDoc cosDoc, INPDESoftMaskCreateFlags type, INPDEForm pdeForm)
Creates a new soft mask object.
 
PDESoftMask PDESoftMaskCreateFromCosObj(const CosObj* cosObjP)
Creates a new soft mask object from its Cos representation.
 
PDESoftMask PDESoftMaskCreateFromName(INASAtom name)
Create a new soft mask from a name.
 
ASInt32 PDESoftMaskGetBackdropColor(INPDESoftMask pdeSoftMask, INASFixed* pColorValues, INASInt32 numValues)
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.
 
void PDESoftMaskGetCosObj(INPDESoftMask pdeSoftMask, OUTCosObj* cosObjP)
Gets the associated CosObj of the soft mask.
 
ASAtom PDESoftMaskGetName(INPDESoftMask pdeSoftMask)
Gets the soft mask name.
 
CosObj PDESoftMaskGetTransferFunction(INPDESoftMask pdeSoftMask)
Gets the transfer function as a CosObj.
 
void PDESoftMaskSetBackdropColor(INPDESoftMask pdeSoftMask, INASFixed* pColorValues, INASInt32 numValues)
Sets the backdrop color values.
 
void PDESoftMaskSetTransferFunction(INPDESoftMask pdeSoftMask, INCosObj cosTransferFunction)
Sets the transfer function associated with the soft mask.
 
void PDESoftMaskSetXGroup(INPDESoftMask pdeSoftMask, INPDEForm pdeForm)
Sets the PDEForm that defines the soft mask.

Typedefs Detail
PDESoftMask 
Product availability: All
Platform availability: All

Syntax

typedef struct _t_PDESoftMask* PDESoftMask;

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

See Also

PDEElement (superclass)
PDESoftMaskCreate
PDESoftMaskCreateFromCosObj
PDESoftMaskCreateFromName
PDERelease

File: PEExpT.h
Line: 382

Enumeration Detail
PDESoftMaskCreateFlags
Product availability: All
Platform availability: All

Syntax

enum PDESoftMaskCreateFlags {
 kPDESoftMaskTypeLuminosity = 0x0001,
 
 kPDESoftMaskTypeAlpha = 0x0002
}

See Also

PDESoftMaskCreate

File: PEExpT.h
Line: 1817

Elements
kPDESoftMaskTypeLuminosity  

Specifies how the mask is to be computed.

 
kPDESoftMaskTypeAlpha  

Specifies how the mask is to be computed.



Method Detail
PDESoftMaskAcquireForm()
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDEForm PDESoftMaskAcquireForm(INPDESoftMask pdeSoftMask, INASFixedMatrixP matrixP)

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.

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.

See Also

PDESoftMaskAcquireFormEx

Exceptions

genErrBadParm
peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h
Line: 2114
PDESoftMaskAcquireFormEx() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDEForm PDESoftMaskAcquireFormEx(INPDESoftMask pdeSoftMask, INASDoubleMatrixP matrixP)

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.

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.

See Also

PDESoftMaskAcquireForm

Exceptions

genErrBadParm
peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x000A0000

File: PERProcs.h
Line: 3443
PDESoftMaskCreate() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDESoftMask PDESoftMaskCreate(INCosDoc cosDoc, INPDESoftMaskCreateFlags type, INPDEForm pdeForm)

Creates a new soft mask object.

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

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.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 1895
PDESoftMaskCreateFromCosObj() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDESoftMask PDESoftMaskCreateFromCosObj(const CosObj* cosObjP)

Creates a new soft mask object from its Cos representation.

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

Parameters

cosObjP — 

IN/OUT The soft mask dictionary.

Returns

The newly created object.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 1877
PDESoftMaskCreateFromName() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDESoftMask PDESoftMaskCreateFromName(INASAtom name)

Create a new soft mask from a name.

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

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.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 2483
PDESoftMaskGetBackdropColor() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDESoftMaskGetBackdropColor(INPDESoftMask pdeSoftMask, INASFixed* pColorValues, INASInt32 numValues)

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.

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.

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h
Line: 2134
PDESoftMaskGetCosObj() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDESoftMaskGetCosObj(INPDESoftMask pdeSoftMask, OUTCosObj* cosObjP)

Gets the associated CosObj of the soft mask.

Parameters

pdeSoftMask — 

IN/OUT The soft mask.

 
cosObjP — 

IN/OUT (Filled by the method) A pointer to the Cos object.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h
Line: 2095
PDESoftMaskGetName() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom PDESoftMaskGetName(INPDESoftMask pdeSoftMask)

Gets the soft mask name.

Parameters

pdeSoftMask — 

IN/OUT The soft mask.

Returns

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

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h
Line: 2542
PDESoftMaskGetTransferFunction() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

CosObj PDESoftMaskGetTransferFunction(INPDESoftMask pdeSoftMask)

Gets the transfer function as a CosObj.

Parameters

pdeSoftMask — 

IN/OUT The soft mask.

Returns

The transfer function as a CosObj.

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h
Line: 2144
PDESoftMaskSetBackdropColor() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDESoftMaskSetBackdropColor(INPDESoftMask pdeSoftMask, INASFixed* pColorValues, INASInt32 numValues)

Sets the backdrop color values.

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.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 1920
PDESoftMaskSetTransferFunction() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDESoftMaskSetTransferFunction(INPDESoftMask pdeSoftMask, INCosObj cosTransferFunction)

Sets the transfer function associated with the soft mask.

Parameters

pdeSoftMask — 

IN/OUT The soft mask object.

 
cosTransferFunction — 

IN/OUT The transfer function dictionary.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 1933
PDESoftMaskSetXGroup() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDESoftMaskSetXGroup(INPDESoftMask pdeSoftMask, INPDEForm pdeForm)

Sets the PDEForm that defines the soft mask.

Parameters

pdeSoftMask — 

IN/OUT The soft mask object.

 
pdeForm — 

IN/OUT The form XObject.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 1906



© 2004-2013 Adobe Systems Incorporated. All rights reserved.
Thu Jan 21 2016, 11:19 AM IST