Adobe Photoshop SDK

ReadChannelDesc Struct Reference
[Channel Ports Suite Callbacks (DEPRECATED Standard Suite)]

#include <PIGeneral.h>

Detailed Description

A channel to read from.


Public Member Functions
	ReadChannelDesc ()
Data Fields
int32	minVersion
	The minimum version needed to interpret this record.
int32	maxVersion
	The maximum version allowable to interpret this record.
ReadChannelDesc *	next
	Next descriptor in the list.
PIChannelPort	port
	Port to use for reading.
VRect	bounds
	Bounds of the channel data.
int32	depth
	Depth of the data; horizontal and vertical resolution.
VPoint	tileSize
	Size of the tiles, set by the host.
VPoint	tileOrigin
	Origin for the tiles, set by host.
Boolean	target
	Indicates if this a target channel.
Boolean	shown
	Indicates if this channel is visible.
int16	channelType
	Channel type.
void *	contextInfo
	Pointer to additional information dependent on context.
const char *	name
	Name of the channel as a C string.
New in version 1
PIChannelPort	writePort
	Port to use for writing if writing is allowed.
New in version 2
unsigned32	alphaID
	Persistent ID for the channel.
New in version 3
const uint16 *	unicodeName
	Name of the channel as a Unicode string.
New in version 4
Boolean	isEnabled
	Indicates if the read channel is enabled.
New in version 5
VRect	limitBounds
	Bounds trimmed to transparency.

Constructor & Destructor Documentation

ReadChannelDesc::ReadChannelDesc ( ) [inline]

Field Documentation

int32 ReadChannelDesc::minVersion

The minimum version needed to interpret this record.

int32 ReadChannelDesc::maxVersion

The maximum version allowable to interpret this record.

struct ReadChannelDesc* ReadChannelDesc::next

Next descriptor in the list.

PIChannelPort ReadChannelDesc::port

Port to use for reading.

Provided by host.

VRect ReadChannelDesc::bounds

Bounds of the channel data.

int32 ReadChannelDesc::depth

Depth of the data; horizontal and vertical resolution.

VPoint ReadChannelDesc::tileSize

Size of the tiles, set by the host.

The plug-in should use this size if possible to optimize and match the host memory scheme.

VPoint ReadChannelDesc::tileOrigin

Origin for the tiles, set by host.

Boolean ReadChannelDesc::target

Indicates if this a target channel.

TRUE if so.

Boolean ReadChannelDesc::shown

Indicates if this channel is visible.

TRUE if so.

int16 ReadChannelDesc::channelType

Channel type.

See ChannelTypes.

void* ReadChannelDesc::contextInfo

Pointer to additional information dependent on context.

const char* ReadChannelDesc::name

Name of the channel as a C string.

PIChannelPort ReadChannelDesc::writePort

Port to use for writing if writing is allowed.

This generally does not point back to the same collection of pixels.

unsigned32 ReadChannelDesc::alphaID

Persistent ID for the channel.

Only set for alpha channels.

const uint16* ReadChannelDesc::unicodeName

Name of the channel as a Unicode string.

(platform endianess)

Boolean ReadChannelDesc::isEnabled

Indicates if the read channel is enabled.

Used for layer masks and vector masks that can be disabled.

VRect ReadChannelDesc::limitBounds

Bounds trimmed to transparency.

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

PIGeneral.h