AIColorSpaceSuite Struct Reference
[API Suite List]

These function allow you to manipulate color-space objects and the application's global list of color spaces. More...

#include <AIColorSpace.h>

List of all members.

Public Attributes
AIAPI AIErr(*	NewColorSpaceList )(ai::ColorSpaceList &csList, const ai::ColorSpace &cs)
	Creates a new color-space list containing a given color space.
AIAPI AIErr(*	AddColorSpace )(ai::ColorSpaceList &csList, const ai::ColorSpace &cs)
	Adds a color space to a color-space list.
AIAPI ai::int32(*	GetNumColorSpaces )(const ai::ColorSpaceList &csList)
	Reports the number of color space objects in a color-space list.
AIAPI AIErr(*	GetNthColorSpace )(const ai::ColorSpaceList &csList, ai::int32 n, ai::ColorSpace &cs)
	Retrieves a color space object from a color-space list.
AIAPI AIErr(*	CopyColorSpaceList )(ai::ColorSpaceList &out, const ai::ColorSpaceList &in)
	Duplicates a color space list.
AIAPI AIErr(*	DeleteColorSpaceList )(ai::ColorSpaceList &csList)
	Frees a color-space list object.
AIAPI AIErr(*	Normalize )(ai::ColorSpaceList &csList, ai::int16 docColorModel, AIBoolean convertGrayToFullProcess)
	Normalizes a color space list by flattening any NChannel color space, removing duplicates, compacting 4-process separation color spaces into a single CMYK-process color space, and sorting the color spaces.
AIAPI AIErr(*	NewSimpleColorSpace )(ai::ColorSpace &cs, ai::ColorSpace::Family family, AIBoolean hasAlpha)
	Creates a standard color space (Gray, RGB, CMYK, or LAB) with optional alpha channel.
AIAPI AIErr(*	NewProcessSeparationColorSpace )(ai::ColorSpace &cs, ai::int32 separationNum, AIBoolean hasAlpha)
	Creates a process-separation CMYK color space.
AIAPI AIErr(*	NewGlobalColorSpace )(ai::ColorSpace &cs, const AICustomColorHandle customColor, AIBoolean hasAlpha)
	Creates a color space based on a global custom color.
AIAPI AIErr(*	NewNChannelColorSpace )(ai::ColorSpace &cs, const ai::ColorSpaceList &csList, AIBoolean hasAlpha, AIBoolean promoteToProcess)
	Creates an NChannel color space using a fully specified color space list.
AIAPI AIErr(*	NewIndexedColorSpace )(ai::ColorSpace &cs, const ai::ColorSpace &baseCs, ai::int32 numComponents, ai::int32 numEntries, const ASUInt8 *lookup)
	Creates an indexed color space from a base color space, which can be any valid color space except indexed, including Separation and NChannel.
AIAPI AIErr(*	NewColorSpace )(ai::ColorSpace &cs, const ai::ColorSpace &baseCs, AIBoolean hasAlpha)
	Creates a color space based on another color space, ignoring the alpha channel if present.
AIAPI AIErr(*	CopyColorSpace )(ai::ColorSpace &out, const ai::ColorSpace &in)
	Duplicates a color space.
AIAPI AIErr(*	DeleteColorSpace )(ai::ColorSpace &cs)
	Frees a color-space object.
AIAPI ai::ColorSpace::Family(*	GetFamily )(const ai::ColorSpace &cs)
	Retrieves the family of a color space (Gray, RGB, CMYK, or LAB).
AIAPI AIBoolean(*	HasAlpha )(const ai::ColorSpace &cs)
	Reports whether a color space has an alpha component.
AIAPI ai::int32(*	GetNumComponents )(const ai::ColorSpace &cs)
	Reports the number of components in a color space, including the alpha channel if it exists.
AIAPI ai::int32(*	GetNumColorComponents )(const ai::ColorSpace &cs)
	Reports the number of color components in a color space.
AIAPI ai::int32(*	GetNumSpotComponents )(const ai::ColorSpace &cs)
	Reports the number of spot components in a color space.
AIAPI AIErr(*	GetBaseColorSpace )(const ai::ColorSpace &cs, ai::ColorSpace &baseCs)
	Returns the base color space for an Indexed color space, or the alternate color space for a Separation/NChannel color space.
AIAPI ai::int32(*	GetIndexedNumComponents )(const ai::ColorSpace &cs)
	Reports the number of components in an indexed color table.
AIAPI ai::int32(*	GetIndexedNumEntries )(const ai::ColorSpace &cs)
	Reports the number of color table entries in an indexed color table.
AIAPI const ASUInt8 *(*	GetIndexedTable )(const ai::ColorSpace &cs)
	Retrieves the color table of an indexed color space.
AIAPI const AIFloat *(*	GetSeparationAltColors )(const ai::ColorSpace &cs)
	Retrieves the alternate color values in the alternate color space for a separation color space.
AIAPI AIErr(*	GetColorSpaceList )(const ai::ColorSpace &cs, ai::ColorSpaceList &csList)
	Retrieves the fully-specified color-space list that contains a non-indexed color space.
AIAPI AIErr(*	GetNthColorant )(const ai::ColorSpace &cs, ai::int32 n, ai::UnicodeString &name)
	Retrieves the colorant name of a component of a color space.
AIAPI AIBoolean(*	HasFullSetOfProcessComponents )(const ai::ColorSpace &cs)
	Reports whether a color space has all process components.
AIAPI AIBoolean(*	Equal )(const ai::ColorSpace &cs1, const ai::ColorSpace &cs2)
	Reports whether two color spaces are identical.

---

Detailed Description

These function allow you to manipulate color-space objects and the application's global list of color spaces.

See also:

ai::ColorSpace class, AIColor,h, AIColorConversionSuite

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIColorSpaceSuite and kAIColorSpaceVersion.

---

Member Data Documentation

AIAPI AIErr(* AIColorSpaceSuite::AddColorSpace)(ai::ColorSpaceList &csList, const ai::ColorSpace &cs)

Adds a color space to a color-space list.

Parameters:

	csList	The color-space list object.
	The	color space object.

AIAPI AIErr(* AIColorSpaceSuite::CopyColorSpace)(ai::ColorSpace &out, const ai::ColorSpace &in)

Duplicates a color space.

Parameters:

	out	[out] A buffer in which to return the new color-space object.
	in	The color-space object to copy.

AIAPI AIErr(* AIColorSpaceSuite::CopyColorSpaceList)(ai::ColorSpaceList &out, const ai::ColorSpaceList &in)

Duplicates a color space list.

Parameters:

	out	[out] A buffer in which to return the new color-space list object.
	in	The color-space list object to duplicate.

AIAPI AIErr(* AIColorSpaceSuite::DeleteColorSpace)(ai::ColorSpace &cs)

Frees a color-space object.

Parameters:

cs

The color-space object. Upon return, this is an invalid object.

AIAPI AIErr(* AIColorSpaceSuite::DeleteColorSpaceList)(ai::ColorSpaceList &csList)

Frees a color-space list object.

Parameters:

csList

The color-space list object. Upon return, this is an invalid object.

AIAPI AIBoolean(* AIColorSpaceSuite::Equal)(const ai::ColorSpace &cs1, const ai::ColorSpace &cs2)

Reports whether two color spaces are identical.

(Note that this function returns an boolean value, not an error code.)

Parameters:

	cs1	The first color-space object.
	cs2	The second color-space object.

Returns:

True if the objects are identical, false otherwise.

AIAPI AIErr(* AIColorSpaceSuite::GetBaseColorSpace)(const ai::ColorSpace &cs, ai::ColorSpace &baseCs)

Returns the base color space for an Indexed color space, or the alternate color space for a Separation/NChannel color space.

For a standard color space, returns the color space itself.

Parameters:

	cs	The color-space object.
	baseCs	[out] A buffer in which to return the base color-space object.

AIAPI AIErr(* AIColorSpaceSuite::GetColorSpaceList)(const ai::ColorSpace &cs, ai::ColorSpaceList &csList)

Retrieves the fully-specified color-space list that contains a non-indexed color space.

Parameters:

	cs	The color-space object.
	csList	[out] A buffer in which to return the color-space list object. This is an invalid object if the color space is indexed.

AIAPI ai::ColorSpace::Family(* AIColorSpaceSuite::GetFamily)(const ai::ColorSpace &cs)

Retrieves the family of a color space (Gray, RGB, CMYK, or LAB).

(Note that this function returns a constant value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

The color-space family constant.

AIAPI ai::int32(* AIColorSpaceSuite::GetIndexedNumComponents)(const ai::ColorSpace &cs)

Reports the number of components in an indexed color table.

(Note that this function returns an integer value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

The number of components, or 0 for non-indexed color spaces.

AIAPI ai::int32(* AIColorSpaceSuite::GetIndexedNumEntries)(const ai::ColorSpace &cs)

Reports the number of color table entries in an indexed color table.

(Note that this function returns an integer value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

The number of entries, or 0 for non-indexed color spaces.

AIAPI const ASUInt8*(* AIColorSpaceSuite::GetIndexedTable)(const ai::ColorSpace &cs)

Retrieves the color table of an indexed color space.

(Note that this function returns an numeric value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

The number of entries, or NULL for non-indexed color spaces.

AIAPI AIErr(* AIColorSpaceSuite::GetNthColorant)(const ai::ColorSpace &cs, ai::int32 n, ai::UnicodeString &name)

Retrieves the colorant name of a component of a color space.

Use with GetNumColorComponents() to iterate through components.

Parameters:

	cs	The color-space object.
	n	The 0-based position index of the color component.
	name	[out] A buffer in which to return the name string, or the empty string if the index is out of range. The names are: "Gray" for Gray colorspaces "Red","Green","Blue" for RGB colorspaces "Cyan","Magenta","Yellow","Black" for CMYK colorspaces Empty for LAB colorspaces

AIAPI AIErr(* AIColorSpaceSuite::GetNthColorSpace)(const ai::ColorSpaceList &csList, ai::int32 n, ai::ColorSpace &cs)

Retrieves a color space object from a color-space list.

Use with GetNumColorSpaces() to iterate through the list.

Parameters:

	csList	The color-space list object.
	n	The 0-based position index of the color space object.
	cs	[out] A buffer in which to return the color-space object. This is an invalid object if the index is out of range.

AIAPI ai::int32(* AIColorSpaceSuite::GetNumColorComponents)(const ai::ColorSpace &cs)

Reports the number of color components in a color space.

Does not count the alpha channel, if any. For the Indexed color space, this is the number of color components in its base color space. (Note that this function returns an integer value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

The number of color components.

See also:

GetNumComponents()

AIAPI ai::int32(* AIColorSpaceSuite::GetNumColorSpaces)(const ai::ColorSpaceList &csList)

Reports the number of color space objects in a color-space list.

Use with GetNthColorSpace() to iterate through the list. (Note that this function returns an integer value, not an error code.)

Parameters:

csList

The color-space list object.

Returns:

The number of color space objects.

AIAPI ai::int32(* AIColorSpaceSuite::GetNumComponents)(const ai::ColorSpace &cs)

Reports the number of components in a color space, including the alpha channel if it exists.

An Indexed color space is considered to have only one component in addition to the possible alpha component (not the number of color components in the base color space). (Note that this function returns an integer value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

The number of components.

See also:

GetNumColorComponents()

AIAPI ai::int32(* AIColorSpaceSuite::GetNumSpotComponents)(const ai::ColorSpace &cs)

Reports the number of spot components in a color space.

Does not count the alpha channel, if any. This is 0 for CMYK, RGB, Gray, Lab, and for "process" separations. It is 1 for "spot" separations. For the Indexed color space, this is the number of spot color components in its base color space. (Note that this function returns an integer value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

The number of spot components.

AIAPI const AIFloat*(* AIColorSpaceSuite::GetSeparationAltColors)(const ai::ColorSpace &cs)

Retrieves the alternate color values in the alternate color space for a separation color space.

(Note that this function returns an numeric array value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

A pointer to an array of color values, or NULL for non-separation color spaces.

AIAPI AIBoolean(* AIColorSpaceSuite::HasAlpha)(const ai::ColorSpace &cs)

Reports whether a color space has an alpha component.

An Indexed color space has an alpha component if and only if its base color space has an alpha component. (Note that this function returns a boolean value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

True if the color space has an alpha component.

AIAPI AIBoolean(* AIColorSpaceSuite::HasFullSetOfProcessComponents)(const ai::ColorSpace &cs)

Reports whether a color space has all process components.

(Note that this function returns an boolean value, not an error code.)

Parameters:

cs

The color-space object.

Returns:

True if the CMYK, RGB, Gray, or Lab color space has all process components. False if the color space has no process components, or the color space is a spot or process separation.

AIAPI AIErr(* AIColorSpaceSuite::NewColorSpace)(ai::ColorSpace &cs, const ai::ColorSpace &baseCs, AIBoolean hasAlpha)

Creates a color space based on another color space, ignoring the alpha channel if present.

Parameters:

	cs	[out] A buffer in which to return the new color-space object.
	baseCs	The color-space objectto copy.
	hasAlpha	True to create a color space with an alpha channel, false otherwise.

AIAPI AIErr(* AIColorSpaceSuite::NewColorSpaceList)(ai::ColorSpaceList &csList, const ai::ColorSpace &cs)

Creates a new color-space list containing a given color space.

Parameters:

	csList	[out] A buffer in which to return the new color-space list object.
	The	color space object.

AIAPI AIErr(* AIColorSpaceSuite::NewGlobalColorSpace)(ai::ColorSpace &cs, const AICustomColorHandle customColor, AIBoolean hasAlpha)

Creates a color space based on a global custom color.

This can be a spot color. or a global process color.

Parameters:

	cs	[out] A buffer in which to return the new color-space object.
	customColor	The custom color.
	hasAlpha	True to create a color space with an alpha channel, false otherwise.

AIAPI AIErr(* AIColorSpaceSuite::NewIndexedColorSpace)(ai::ColorSpace &cs, const ai::ColorSpace &baseCs, ai::int32 numComponents, ai::int32 numEntries, const ASUInt8 *lookup)

Creates an indexed color space from a base color space, which can be any valid color space except indexed, including Separation and NChannel.

Parameters:

	cs	[out] A buffer in which to return the new color-space object.
	baseCs	The base color-space object.
	numComponents	The number of components in the base color space, 3 or 4. A 4-component RGB table is in 0RGB order.
	numEntries	The number of entries in the lookup table.
	lookup	[out] A buffer in which to return the lookup table. The table size must be numEntries * numComponents.

AIAPI AIErr(* AIColorSpaceSuite::NewNChannelColorSpace)(ai::ColorSpace &cs, const ai::ColorSpaceList &csList, AIBoolean hasAlpha, AIBoolean promoteToProcess)

Creates an NChannel color space using a fully specified color space list.

The list must conform to all requirements of an NChannel color space, including at most one process color space and no duplicate channels, with all RGB and Lab channels present and in order.

Parameters:

	cs	[out] A buffer in which to return the new color-space object.
	csList	The color-space list.
	hasAlpha	True to create a color space with an alpha channel, false otherwise.
	promoteToProcess	True to construct an equivalent process color space instead of an NChannel color space, if possible. For example, if the input color space list contains the full process components and has no spot components, an equivalent process color space representation exists and is returned.

AIAPI AIErr(* AIColorSpaceSuite::NewProcessSeparationColorSpace)(ai::ColorSpace &cs, ai::int32 separationNum, AIBoolean hasAlpha)

Creates a process-separation CMYK color space.

Parameters:

	cs	[out] A buffer in which to return the new color-space object.
	separationNum	The process-separation plate of the base color space. The separation is never a spot color plate.
	hasAlpha	True to create a color space with an alpha channel, false otherwise.

AIAPI AIErr(* AIColorSpaceSuite::NewSimpleColorSpace)(ai::ColorSpace &cs, ai::ColorSpace::Family family, AIBoolean hasAlpha)

Creates a standard color space (Gray, RGB, CMYK, or LAB) with optional alpha channel.

Parameters:

	cs	[out] A buffer in which to return the new color-space object.
	family	The color family constant, Gray, RGB, CMYK, or LAB.
	hasAlpha	True to create a color space with an alpha channel, false otherwise.

AIAPI AIErr(* AIColorSpaceSuite::Normalize)(ai::ColorSpaceList &csList, ai::int16 docColorModel, AIBoolean convertGrayToFullProcess)

Normalizes a color space list by flattening any NChannel color space, removing duplicates, compacting 4-process separation color spaces into a single CMYK-process color space, and sorting the color spaces.

The order of the spot-separation color spaces in the original list is preserved.

Parameters:

	csList	[in, out] The color-space list object.
	docColorModel	The document color model, an AIDocumentSuite::AIDocumentColorModelValue.
	convertGrayToFullProcess	When false, if the color model is kDocCMYKColor, a gray color space is converted to separation Black. Otherwise, a gray color space is converted to the full process in the document color space.

---

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

• AIColorSpace.h