AIImageOptSuite Struct Reference
[API Suite List]

These functions allow you to rasterize an art object and stream the resulting raster to a data filter in various image formats. More...

#include <AIImageOptimization.h>

List of all members.

Public Attributes
AIAPI AIErr(*	AsGIF )(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptGIFParams &params)
	Rasterize art to GIF format.
AIAPI AIErr(*	AsJPEG )(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptJPEGParams &params)
	Rasterize art to JPEG format.
AIAPI AIErr(*	AsPNG )(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptPNGParams &params)
	Rasterize art to PNG24 format.
AIAPI AIErr(*	AsZLIB )(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptZLIBParams &params)
	Rasterize art to ZLIB format.
AIAPI AIErr(*	MakePNG24 )(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptPNGParams2 &params, AIRasterizeProgressProc progressProc)
	Rasterize art to PNG24 format.
AIAPI AIErr(*	CreatePalette )(AIArtHandle raster, const AIPaletteOptions *options, AIColorPaletteHandle *palette)
	Creates a color palette for art.
AIAPI AIErr(*	DisposePalette )(AIColorPaletteHandle palette)
	Frees the memory associated with a palette object when it is no longer needed.
AIAPI AIErr(*	GetPaletteColor )(AIColorPaletteHandle palette, ai::int32 index, AIPaletteColor *color)
	Retrieves a color from a color palette.
AIAPI AIErr(*	SetPaletteColor )(AIColorPaletteHandle palette, ai::int32 index, AIPaletteColor *color)
	Sets a color in a color palette.
AIAPI AIErr(*	CreateInversePalette )(AIColorPaletteHandle palette, AIInverseColorPaletteHandle *inverse)
	Creates an inverse color palette.
AIAPI AIErr(*	DisposeInversePalette )(AIInverseColorPaletteHandle inverse)
	Frees the memory associated with an inverse palette object when it is no longer needed.
AIAPI AIErr(*	GetPaletteIndex )(AIInverseColorPaletteHandle inverse, const AIPaletteColor *color, ai::int32 *index)
	Retrieves the closest match to a color from an inverse color palette.
AIAPI AIErr(*	CreateReducedPalette )(AIPaletteColor *colorList, int colorListCount, int reduceColorCount, AIColorPaletteHandle *palette)
	Creates a color palette by posterizing the colors in a list.

---

Detailed Description

These functions allow you to rasterize an art object and stream the resulting raster to a data filter in various image formats.

See also:

AIDataFilterSuite.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIImageOptSuite and kAIImageOptVersion.

---

Member Data Documentation

AIAPI AIErr(* AIImageOptSuite::AsGIF)(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptGIFParams &params)

Rasterize art to GIF format.

Parameters:

	aiArt	The art object or art tree root.
	aiDataFilter	The data filter to which to send the resulting raster data.
	params	How to perform the rasterization.

AIAPI AIErr(* AIImageOptSuite::AsJPEG)(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptJPEGParams &params)

Rasterize art to JPEG format.

Parameters:

	aiArt	The art object or art tree root.
	aiDataFilter	The data filter to which to send the resulting raster data.
	params	How to perform the rasterization.

AIAPI AIErr(* AIImageOptSuite::AsPNG)(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptPNGParams &params)

Rasterize art to PNG24 format.

Parameters:

	aiArt	The art object or art tree root.
	aiDataFilter	The data filter to which to send the resulting raster data.
	params	How to perform the rasterization.

AIAPI AIErr(* AIImageOptSuite::AsZLIB)(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptZLIBParams &params)

Rasterize art to ZLIB format.

Parameters:

	aiArt	The art object or art tree root.
	aiDataFilter	The data filter to which to send the resulting raster data.
	params	How to perform the rasterization.

AIAPI AIErr(* AIImageOptSuite::CreateInversePalette)(AIColorPaletteHandle palette, AIInverseColorPaletteHandle *inverse)

Creates an inverse color palette.

Parameters:

	palette	The palette object.
	inverse	[out] A buffer in which to return the inverse palette object.

AIAPI AIErr(* AIImageOptSuite::CreatePalette)(AIArtHandle raster, const AIPaletteOptions *options, AIColorPaletteHandle *palette)

Creates a color palette for art.

Parameters:

	raster	The art object.
	options	The type of palette to create, automatic or custom.
	palette	[out] A buffer in which to return the palette object.

AIAPI AIErr(* AIImageOptSuite::CreateReducedPalette)(AIPaletteColor *colorList, int colorListCount, int reduceColorCount, AIColorPaletteHandle *palette)

Creates a color palette by posterizing the colors in a list.

Parameters:

	colorList	The list of colors to be posterized, an array of color objects.
	colorListCount	The number of color objects in the list.
	reduceColorCount	The maximum number of colors the resulting palette should contain.
	palette	[out] A buffer in which to return the palette object.

AIAPI AIErr(* AIImageOptSuite::DisposeInversePalette)(AIInverseColorPaletteHandle inverse)

Frees the memory associated with an inverse palette object when it is no longer needed.

Parameters:

inverse

The inverse palette object. Upon return, this reference is no longer valid.

AIAPI AIErr(* AIImageOptSuite::DisposePalette)(AIColorPaletteHandle palette)

Frees the memory associated with a palette object when it is no longer needed.

Parameters:

palette

The palette object. Upon return, this reference is no longer valid.

AIAPI AIErr(* AIImageOptSuite::GetPaletteColor)(AIColorPaletteHandle palette, ai::int32 index, AIPaletteColor *color)

Retrieves a color from a color palette.

Parameters:

	palette	The palette object.
	index	The position index of the color.
	color	[out] A buffer in which to return the color object.

AIAPI AIErr(* AIImageOptSuite::GetPaletteIndex)(AIInverseColorPaletteHandle inverse, const AIPaletteColor *color, ai::int32 *index)

Retrieves the closest match to a color from an inverse color palette.

Parameters:

	palette	The inverse palette object.
	color	A pointer to the color object to match.
	index	[out] A buffer in which to return the 0-based position index of the closest matching color.

AIAPI AIErr(* AIImageOptSuite::MakePNG24)(AIArtHandle aiArt, AIDataFilter *aiDataFilter, AIImageOptPNGParams2 &params, AIRasterizeProgressProc progressProc)

Rasterize art to PNG24 format.

This differs from AsPNG() in that it takes additional parameters and allows you to show a progress bar for a lengthy operation.

Parameters:

	aiArt	The art object or art tree root.
	aiDataFilter	The data filter to which to send the resulting raster data.
	params	How to perform the rasterization.
	progressProc	The procedure to call periodically during a lengthy operation, to provide the current progress status and allow the user to cancel.

AIAPI AIErr(* AIImageOptSuite::SetPaletteColor)(AIColorPaletteHandle palette, ai::int32 index, AIPaletteColor *color)

Sets a color in a color palette.

Parameters:

	palette	The palette object.
	index	The position index of the color.
	color	The color object.

---

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

• AIImageOptimization.h