PDFEdit_Layer.JPX (Acrobat)

	Typedef
	JPXColorSpace A reference to a JPXColorSpace.
	JPXCSEnumAttrs
	JPXCSEnumAttrsP
	JPXPalette A reference to a JPXPalette.

	Enumeration
	`JPXColorSpaceType` JPX Color Space types.

	Structure
	_t_JPXCSEnumAttrs Attributes of a JPXCSEnumerated JPXColorSpace.

	Method
	JPXColorSpace JPXColorSpaceAcquireNext(INJPXColorSpace jpxColorSpace) Acquires the next JPX color space defined with the JPX encoded image in the link list, if one exists. This object is acquired and must be released using PDERelease() when it is no longer in use.
	ASBool JPXColorSpaceGetEnumAttrs(INJPXColorSpace jpxColorSpace, OUTJPXCSEnumAttrsP jpxCSEnumAttrsP) Gets the attributes of an enumerated color space. It returns false if the color space is not kJPXCSEnumerated.
	ASInt32 JPXColorSpaceGetProfile(INJPXColorSpace jpxColorSpace, OUTASUns8* profile, INASInt32 profileLength) Gets the color profile of an ICC-based JPX color space. If profile is 0, it returns the length of the profile in bytes; otherwise it returns the number of bytes copied to profile.
	JPXColorSpaceType JPXColorSpaceGetType(INJPXColorSpace jpxColorSpace) Returns the type of JPX color space: kJPXCSUnknown kJPXCSEnumerated kJPXCSRestrictedICC kJPXCSAnyICC kJPXCSVenderColor
	void JPXPaletteGetBitDepths(INJPXPalette jpxPalette, OUTASInt32* bitDepths) Returns the bit depths of the color values represented in the palette. The length of the array must be at least the number of components.
	ASInt32 JPXPaletteGetNumComponents(INJPXPalette jpxPalette) Returns the number of color components represented by the palette.
	ASInt32 JPXPaletteGetNumEntries(INJPXPalette jpxPalette) Returns the number of palette entries.
	ASStm JPXPaletteGetTable(INJPXPalette jpxPalette, OUTASInt32* paletteLength) Returns the palette data as a read only non-seekable ASStm. The returned ASStm should be read with ASStmRead(). Each component entry in the palette is represented by the number of bytes needed to contain the bit depth for that component.

Typedefs Detail

JPXColorSpace

Product availability: All

Platform availability: All

Syntax

typedef struct _t_JPXColorSpace* JPXColorSpace;

A reference to a JPXColorSpace.

File: PEExpT.h

Line: 439

JPXCSEnumAttrs

Product availability: All

Platform availability: All

Syntax

typedef _t_JPXCSEnumAttrs JPXCSEnumAttrs;

File: PEExpT.h

Line: 2214

JPXCSEnumAttrsP

Product availability: All

Platform availability: All

Syntax

typedef _t_JPXCSEnumAttrs JPXCSEnumAttrsP;

File: PEExpT.h

Line: 2214

JPXPalette

Product availability: All

Platform availability: All

Syntax

typedef struct _t_JPXPalette* JPXPalette;

A reference to a JPXPalette.

File: PEExpT.h

Line: 444

Enumeration Detail

JPXColorSpaceType

Product availability: All

Platform availability: All

Syntax

enum JPXColorSpaceType {

  kJPXCSUnknown = 0x0000,


 


  kJPXCSEnumerated = 0x0001,


 


  kJPXCSRestrictedICC = 0x0002,


 


  kJPXCSAnyICC = 0x0003,


 


  kJPXCSVenderColor = 0x0004

}

File: PEExpT.h

Line: 2191

Structure Detail

_t_JPXCSEnumAttrs

Product availability: All

Platform availability: All

Syntax

struct _t_JPXCSEnumAttrs {

  ASUns32 enumNumber;  


 


  ASBool stdIlluminant;  


 


  ASUns32 illuminant;  


 


  ASUns32 labRange[3];  


 


  ASUns32 labOffset[3];  

}

Attributes of a JPXCSEnumerated JPXColorSpace.

File: PEExpT.h

Line: 2203

Elements

	enumNumber	The enumerated color space number.

	stdIlluminant	The standard illuminant is used.

	illuminant	A 4-byte illuminant value.

	labRange	L, A, and B range values.

	labOffset	L, A, and B offset values.

Method Detail

JPXColorSpaceAcquireNext

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





JPXColorSpace JPXColorSpaceAcquireNext(INJPXColorSpace jpxColorSpace)

Acquires the next JPX color space defined with the JPX encoded image in the link list, if one exists. This object is acquired and must be released using PDERelease() when it is no longer in use.

Parameters

jpxColorSpace —

IN/OUT A JPX color space object.

Returns

The next JPX color space associated with the JPX encoded image.

See Also

PDEImageJPXAcquireJPXColorSpace

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3223

JPXColorSpaceGetEnumAttrs

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool JPXColorSpaceGetEnumAttrs(INJPXColorSpace jpxColorSpace, OUTJPXCSEnumAttrsP jpxCSEnumAttrsP)

Gets the attributes of an enumerated color space. It returns false if the color space is not kJPXCSEnumerated.

Parameters

	`jpxColorSpace` —	IN/OUT A JPX color space object.

	`jpxCSEnumAttrsP` —	IN/OUT (filled in by the method) Attributes of a JPX enumerated color space.

Returns

true if the JPX color space is kJPXCSEnumerated

See Also

PDEImageJPXAcquireJPXColorSpace

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3260

JPXColorSpaceGetProfile

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 JPXColorSpaceGetProfile(INJPXColorSpace jpxColorSpace, OUTASUns8* profile, INASInt32 profileLength)

Gets the color profile of an ICC-based JPX color space. If profile is 0, it returns the length of the profile in bytes; otherwise it returns the number of bytes copied to profile.

Parameters

	`jpxColorSpace` —	IN/OUT A JPX color space object.

	`profile` —	IN/OUT (Filled by the method) The profile of the JPX color space.

	`profileLength` —	IN/OUT The byte length of the user-supplied profile buffer.

Returns

The byte length of the profile, if profile is 0; otherwise returns the byte length copied to profile.

See Also

PDEImageJPXAcquireJPXColorSpace

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3280

JPXColorSpaceGetType

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





JPXColorSpaceType JPXColorSpaceGetType(INJPXColorSpace jpxColorSpace)

Returns the type of JPX color space:

kJPXCSUnknown
kJPXCSEnumerated
kJPXCSRestrictedICC
kJPXCSAnyICC
kJPXCSVenderColor

Parameters

jpxColorSpace —

IN/OUT A JPX color space object.

Returns

The JPX color space type, JPXColorSpaceType.

See Also

PDEImageJPXAcquireJPXColorSpace

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3243

JPXPaletteGetBitDepths

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void JPXPaletteGetBitDepths(INJPXPalette jpxPalette, OUTASInt32* bitDepths)

Returns the bit depths of the color values represented in the palette. The length of the array must be at least the number of components.

Parameters

	`jpxPalette` —	IN/OUT A JPX-encoded image object.

	`bitDepths` —	IN/OUT (Filled by the method) An array of bit depths for each component.

See Also

PDEImageJPXAcquirePalette

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3174

JPXPaletteGetNumComponents

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 JPXPaletteGetNumComponents(INJPXPalette jpxPalette)

Returns the number of color components represented by the palette.

Parameters

jpxPalette —

IN/OUT A JPX encoded image object.

Returns

The number of components of the JPX image represented by the palette.

See Also

PDEImageJPXAcquirePalette

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3187

JPXPaletteGetNumEntries

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 JPXPaletteGetNumEntries(INJPXPalette jpxPalette)

Returns the number of palette entries.

Parameters

jpxPalette —

IN/OUT A JPX encoded image object.

Returns

The number of palette entries.

See Also

PDEImageJPXAcquirePalette

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3159

JPXPaletteGetTable

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASStm JPXPaletteGetTable(INJPXPalette jpxPalette, OUTASInt32* paletteLength)

Returns the palette data as a read only non-seekable ASStm. The returned ASStm should be read with ASStmRead(). Each component entry in the palette is represented by the number of bytes needed to contain the bit depth for that component.

Parameters

	`jpxPalette` —	IN/OUT A JPX encoded image object.

	`paletteLength` —	IN/OUT (Filled by the method) The length of the palette data.

Returns

A stream for the palette data.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 3206

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

	kJPXCSUnknown = 0x0000,

	kJPXCSEnumerated = 0x0001,

	kJPXCSRestrictedICC = 0x0002,

	kJPXCSAnyICC = 0x0003,

	kJPXCSVenderColor = 0x0004

	ASUns32 enumNumber;

	ASBool stdIlluminant;

	ASUns32 illuminant;

	ASUns32 labRange[3];

	ASUns32 labOffset[3];

Layer	PDFEdit_Layer
Object	JPX