AIColorConversionSuite Struct Reference
[API Suite List]

Provides functions for converting color values and image sample values between color spaces. More...

Public Attributes
AIAPI AIErr(*	ConvertSampleColorEx )(const ai::ColorSpace &srcSpace, AIFloatSampleComponent srcColor, const ai::ColorSpace &dstSpace, AIFloatSampleComponent dstColor, const AIColorConvertOptions &options, ASBoolean *inGamut)
	Converts a sample-component color from one color space to another.
AIAPI AIErr(*	ConvertImageColorEx )(const ai::ColorSpace &srcSpace, ai::int32 srcBitsPerPixel, AIImageComponent srcColor, const ai::ColorSpace &dstSpace, ai::int32 dstBitsPerPixel, AIImageComponent dstColor, ai::int32 pixelCount, ai::uint16 flags, const AIColorConvertOptions &options)
	Converts an array of image pixels from one color space to another.
AIAPI AIErr(*	ConvertSampleColor )(ai::int32 srcSpace, AIFloatSampleComponent srcColor, ai::int32 dstSpace, AIFloatSampleComponent dstColor, const AIColorConvertOptions &options, AIBoolean *inGamut)
	Converts a sample-component color from one color space to another.
AIAPI AIErr(*	ConvertImageColor )(ai::int32 srcSpace, AIImageComponent srcColor, ai::int32 dstSpace, AIImageComponent dstColor, ai::int32 pixelCount, ai::uint16 flags, const AIColorConvertOptions &options)
	Converts an array of image pixels from one color space to another.

Detailed Description

Provides functions for converting color values and image sample values between color spaces.

If color management is on, the functions use the document profile if it has one, otherwise they use the profiles from the Color Settings dialog.
If color management is off, the functions perform device conversions.

AIAPI AIErr(* AIColorConversionSuite::ConvertImageColor)(ai::int32 srcSpace, AIImageComponent *srcColor, ai::int32 dstSpace, AIImageComponent *dstColor, ai::int32 pixelCount, ai::uint16 flags, const AIColorConvertOptions &options)

Converts an array of image pixels from one color space to another.

Parameters:

	srcSpace	The source color space, an `AIColorConversionSpaceValue`.
	srcColor	The color to convert, an array containing the number of pixels specified by `pixelCount`, where each pixel contains the number of color values appropriate to the source color space.
	dstSpace	The destination color space, an `AIColorConversionSpaceValue`.
	dstColor	[out] A buffer in which to return the converted color, an array big enough to hold `pixelCount` pixels using the number of color values appropriate to the destination color space.
	pixelCount	The number of pixels in the source image.
	flags	To specify that the bits of a 1-bit color space (`kAIMonoColorSpace`) are inverted, pass the constant `kRasterInvertBits`.
	options	The options structure appropriate to the purpose of the conversion (preview or export). See `AIColorConvertOptions`.

AIAPI AIErr(* AIColorConversionSuite::ConvertImageColorEx)(const ai::ColorSpace &srcSpace, ai::int32 srcBitsPerPixel, AIImageComponent *srcColor, const ai::ColorSpace &dstSpace, ai::int32 dstBitsPerPixel, AIImageComponent *dstColor, ai::int32 pixelCount, ai::uint16 flags, const AIColorConvertOptions &options)

Converts an array of image pixels from one color space to another.

(This version uses the colorspace data type and specific bits-per-pixel values.)

Parameters:

	srcSpace	The source color space.
	srcBitsPerPixel	The bits-per-pixel in the source color.
	srcColor	The color to convert, an array containing the number of pixels specified by `pixelCount`, using the bits-per-pixel specified by `srcBitsPerPixel`.
	dstSpace	The destination color space.
	dstBitsPerPixel	The bits-per-pixel in the destination color.
	dstColor	[out] A buffer in which to return the converted image, an array big enough to contain the number of pixels specified by `pixelCount`, using the bits-per-pixel specified by `dstBitsPerPixel`.
	pixelCount	The number of pixels in the image.
	flags	To specify that the bits of a 1-bit color space (`kAIMonoColorSpace`) are inverted, pass the constant `kRasterInvertBits`.
	options	The options structure appropriate to the purpose of the conversion (preview or export). See `AIColorConvertOptions`.

Converts a sample-component color from one color space to another.

Parameters:

	srcSpace	The source color space, an `AIColorConversionSpaceValue`.
	srcColor	The color to convert, an array containing the number of color values appropriate to the source color space.
	dstSpace	The destination color space, an `AIColorConversionSpaceValue`.
	dstColor	[out] A buffer in which to return the converted color, an array big enough to hold the number of color values appropriate to the destination color space.
	options	The options structure appropriate to the purpose of the conversion (preview or export). See `AIColorConvertOptions`.
	inGamut	[out] A buffer in which to return true if the source color was within the gamut of the destination space.

Converts a sample-component color from one color space to another.

(This version uses colorspace data types.)

Parameters:

	srcSpace	The source color space.
	srcColor	The color to convert, a color sample object.
	dstSpace	The destination color space.
	dstColor	[out] A buffer in which to return the converted color sample object.
	options	The options structure appropriate to the purpose of the conversion (preview or export). See `AIColorConvertOptions`.
	inGamut	[out] A buffer in which to return true if the source color was within the gamut of the destination space. Can be `NULL`.

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