ReadImageDocumentDesc Struct Reference

The document information, used by the Export, Filter, and Selection module parameter blocks. More...

#include <PIGeneral.h>

Public Member Functions
	ReadImageDocumentDesc ()
Data Fields
int32	minVersion
	The minimum version needed to interpret this record.
int32	maxVersion
	The maximum version allowable to interpret this record.
int32	imageMode
	Color mode for the document.
int32	depth
	Default bit depth for the document.
VRect	bounds
	Document bounds.
Fixed	hResolution
	Horizontal resolution for the document.
Fixed	vResolution
	Vertical resolution for the document.
LookUpTable	redLUT
	Red color table, applicable when imageMode is indexed color or duotone.
LookUpTable	greenLUT
	Green color table, applicable when imageMode is indexed color or duotone.
LookUpTable	blueLUT
	Blue color table, applicable when imageMode is indexed color or duotone.
ReadChannelDesc *	targetCompositeChannels
	Composite channels in the target layer.
ReadChannelDesc *	targetTransparency
	Transparency channel for the target layer.
ReadChannelDesc *	targetLayerMask
	Layer mask for the target channel.
ReadChannelDesc *	mergedCompositeChannels
	Composite channels in the merged data.
ReadChannelDesc *	mergedTransparency
	Transparency channel for the merged data.
ReadChannelDesc *	alphaChannels
	Alpha channels for masks.
ReadChannelDesc *	selection
	Selection mask, if any.
struct SPPlatformFileSpecification_t *	fileSpec
	The file specification, if any.
ReadLayerDesc *	layersDescriptor
	Descriptor for a linked list of layers, if any.
int32	documentType
	Document type.
struct ReadImageDocumentDesc *	next
	The next descriptor in the list.
void *	iCCprofileData
	ICC Profile Data.
int32	iCCprofileSize
	Size of the ICC profile; zero if there is no profile.
int32	compositeChannelCount
	Number of composite color channels in this document.
int32	layerCount
	Total number of layers in this document; ignores visbility, adjustments, etc.
int32	alphaChannelCount
	Number of alpha channels in this document.
ReadChannelDesc *	targetSmartFilterMask
struct SPPlatformFileSpecificationW *	fileSpecW
struct XPlatFileSpec *	fileSpecX

---

Detailed Description

The document information, used by the Export, Filter, and Selection module parameter blocks.

Describes the document as a collection of channels and layers. The host provides a read port for each channel, so the pixel data can be read by using ReadPixelsProc in the Channel Ports Suite Callbacks (deprecated Standard Suite).

---

Constructor & Destructor Documentation

ReadImageDocumentDesc::ReadImageDocumentDesc

(

)

[inline]

---

Field Documentation

int32 ReadImageDocumentDesc::minVersion

The minimum version needed to interpret this record.

int32 ReadImageDocumentDesc::maxVersion

The maximum version allowable to interpret this record.

int32 ReadImageDocumentDesc::imageMode

Color mode for the document.

See Image Modes for supported modes.

int32 ReadImageDocumentDesc::depth

Default bit depth for the document.

VRect ReadImageDocumentDesc::bounds

Document bounds.

Fixed ReadImageDocumentDesc::hResolution

Horizontal resolution for the document.

Fixed ReadImageDocumentDesc::vResolution

Vertical resolution for the document.

LookUpTable ReadImageDocumentDesc::redLUT

Red color table, applicable when imageMode is indexed color or duotone.

LookUpTable ReadImageDocumentDesc::greenLUT

Green color table, applicable when imageMode is indexed color or duotone.

LookUpTable ReadImageDocumentDesc::blueLUT

Blue color table, applicable when imageMode is indexed color or duotone.

ReadChannelDesc* ReadImageDocumentDesc::targetCompositeChannels

Composite channels in the target layer.

ReadChannelDesc* ReadImageDocumentDesc::targetTransparency

Transparency channel for the target layer.

ReadChannelDesc* ReadImageDocumentDesc::targetLayerMask

Layer mask for the target channel.

ReadChannelDesc* ReadImageDocumentDesc::mergedCompositeChannels

Composite channels in the merged data.

Merged data is either merged layer data or merged document data.

ReadChannelDesc* ReadImageDocumentDesc::mergedTransparency

Transparency channel for the merged data.

ReadChannelDesc* ReadImageDocumentDesc::alphaChannels

Alpha channels for masks.

ReadChannelDesc* ReadImageDocumentDesc::selection

Selection mask, if any.

struct SPPlatformFileSpecification_t* ReadImageDocumentDesc::fileSpec

The file specification, if any.

ReadLayerDesc* ReadImageDocumentDesc::layersDescriptor

Descriptor for a linked list of layers, if any.

int32 ReadImageDocumentDesc::documentType

Document type.

See Document Types.

struct ReadImageDocumentDesc* ReadImageDocumentDesc::next

The next descriptor in the list.

void* ReadImageDocumentDesc::iCCprofileData

ICC Profile Data.

NULL if there is no profile

int32 ReadImageDocumentDesc::iCCprofileSize

Size of the ICC profile; zero if there is no profile.

int32 ReadImageDocumentDesc::compositeChannelCount

Number of composite color channels in this document.

int32 ReadImageDocumentDesc::layerCount

Total number of layers in this document; ignores visbility, adjustments, etc.

int32 ReadImageDocumentDesc::alphaChannelCount

Number of alpha channels in this document.

ReadChannelDesc* ReadImageDocumentDesc::targetSmartFilterMask

struct SPPlatformFileSpecificationW* ReadImageDocumentDesc::fileSpecW

struct XPlatFileSpec* ReadImageDocumentDesc::fileSpecX

---

The documentation for this struct was generated from the following file:

• PIGeneral.h