PDFEdit_Layer.PDESoftMask (PDFL)

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

	Enumeration
	`PDESoftMaskCreateFlags` Flags for use with PDESoftMaskCreate().

	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: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDESoftMask* PDESoftMask;

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

File: PEExpT.h

Line: 382

Enumeration Detail

PDESoftMaskCreateFlags

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDESoftMaskCreateFlags {

  kPDESoftMaskTypeLuminosity = 0x0001,


 


  kPDESoftMaskTypeAlpha = 0x0002

}

See Also

PDESoftMaskCreate

File: PEExpT.h

Line: 1953

Elements

	kPDESoftMaskTypeLuminosity	Specifies how the mask is to be computed.

	kPDESoftMaskTypeAlpha	Specifies how the mask is to be computed.

Method Detail

PDESoftMaskAcquireForm

()

Product availability: 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: 2116

PDESoftMaskAcquireFormEx

()

Product availability: 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: 3447

PDESoftMaskCreate

()

Product availability: 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: 1899

PDESoftMaskCreateFromCosObj

()

Product availability: 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: 1881

PDESoftMaskCreateFromName

()

Product availability: 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: 2491

PDESoftMaskGetBackdropColor

()

Product availability: 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: 2136

PDESoftMaskGetCosObj

()

Product availability: 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: 2097

PDESoftMaskGetName

()

Product availability: 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: 2545

PDESoftMaskGetTransferFunction

()

Product availability: 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: 2146

PDESoftMaskSetBackdropColor

()

Product availability: 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: 1924

PDESoftMaskSetTransferFunction

()

Product availability: 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: 1937

PDESoftMaskSetXGroup

()

Product availability: 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: 1910

Copyright 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Adobe and the Adobe logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. This product contains either BSAFE and/or TIPEM software by RSA Security, Inc. Portions utilize Microsoft Windows Media Technologies. Copyright © 2006 Microsoft Corporation. All Rights Reserved. Notices, terms and conditions pertaining to other third party software are located at http://www.adobe.com/go/thirdparty/ and incorporated herein by reference.
Tue Jun 23 2020, 12:30 AM GMT+05:30

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
PDESoftMask	Typedefs \| Enumerations \| Methods

	kPDESoftMaskTypeLuminosity = 0x0001,

	kPDESoftMaskTypeAlpha = 0x0002

Layer	PDFEdit_Layer
Object	PDESoftMask