WriteChannelDesc Struct Reference

The channel to write a selection to. More...

#include <PIGeneral.h>

Public Member Functions
	WriteChannelDesc ()
	WriteChannelDesc constructor.
Data Fields
int32	minVersion
	Informs the host of the minimum version needed to interpret this record.
int32	maxVersion
	The maximum version allowable to interpret this record.
struct WriteChannelDesc *	next
	Next descriptor in the list.
ChannelWritePort	port
	Port to write to.
VRect	bounds
	Channel data bounds.
int32	depth
	Depth of the data.
VPoint	tileSize
	Size of the tiles.
VPoint	tileOrigin
	Origin of the tiles.
int16	channelType
	Channel type.
int16	padding
	Reserved.
void *	contextInfo
	Pointer to additional information dependent on context.
const char *	name
	Name of the channel.
const uint16 *	unicodeName
	Name of the channel as a Unicode string.

---

Detailed Description

The channel to write a selection to.

---

Constructor & Destructor Documentation

WriteChannelDesc::WriteChannelDesc

(

)

[inline]

WriteChannelDesc constructor.

---

Field Documentation

int32 WriteChannelDesc::minVersion

Informs the host of the minimum version needed to interpret this record.

int32 WriteChannelDesc::maxVersion

The maximum version allowable to interpret this record.

struct WriteChannelDesc* WriteChannelDesc::next

Next descriptor in the list.

ChannelWritePort WriteChannelDesc::port

Port to write to.

Provided by the host.

VRect WriteChannelDesc::bounds

Channel data bounds.

int32 WriteChannelDesc::depth

Depth of the data.

Horizontal and vertical resolution.

VPoint WriteChannelDesc::tileSize

Size of the tiles.

VPoint WriteChannelDesc::tileOrigin

Origin of the tiles.

int16 WriteChannelDesc::channelType

Channel type.

See ChannelTypes.

int16 WriteChannelDesc::padding

Reserved.

Defaults to zero.

void* WriteChannelDesc::contextInfo

Pointer to additional information dependent on context.

const char* WriteChannelDesc::name

Name of the channel.

const uint16* WriteChannelDesc::unicodeName

Name of the channel as a Unicode string.

(Platform endianess). For Version 1.

---

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

• PIGeneral.h