AIOptimizationSettingsSuite Struct Reference
[API Suite List]

This suite provides functions that allow you to access format-specific optimization settings and color table information, used for saving and placing images. More...

#include <AISlicing.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	GetOptimizationSettingsCount )(void)
	Gets the number of optimization settings groups in the settings-group list.
AIAPI ai::int32(*	GetIndexedOptimizationSettingsID )(ai::int32 index)
	Retrieves an optimization settings group from the settings-group list, by position index.
AIAPI void(*	DeleteOptimizationSettings )(ai::int32 optimizationID)
	Removes an optimization settings group from the settings-group list.
AIAPI ai::int32(*	GetUniqueOptimizationSettingsID )(void)
	Retrieves a unique identifier suitable for an optimization settings group.
AIAPI AIBoolean(*	OptimizationSettingsExists )(ai::int32 optimizationID)
	Reports whether a unique identifier is currently used to identify an optimization settings group.
AIAPI AIErr(*	SetOptimizationSettings )(ai::int32 optimizationID, ASOptimizationSettings *settings)
	Sets the optimization settings for a settings group.
AIAPI AIErr(*	GetOptimizationSettings )(ai::int32 optimizationID, ASOptimizationSettings *settings)
	Retrieves the optimization settings for a settings group.
AIAPI AIErr(*	SetOptimizationSetting )(ai::int32 optimizationID, const AIDictKey &key, AIEntryRef valueEntry)
	Sets a single optimization settings attribute.
AIAPI AIErr(*	GetOptimizationSetting )(ai::int32 optimizationID, const AIDictKey &key, AIEntryRef *valueEntry)
	Retrieves a single optimization settings attribute.
AIAPI AIErr(*	SetSliceOptimizationID )(ai::int32 sliceID, ai::int32 optimizationID)
	Associates a slice with an optimization group settings identifier.
AIAPI AIErr(*	SetSliceOptimizationSettings )(ai::int32 sliceID, ASOptimizationSettings *settings)
	Sets the optimization settings for a slice.
AIAPI AIErr(*	SetSliceOptimizationSetting )(ai::int32 sliceID, const AIDictKey &key, AIEntryRef valueEntry)
	Sets a single optimization settings attribute for a slice.
AIAPI AIErr(*	GetColorTable )(ai::int32 optimizationID, ai::int32 numColors, AIRGBColor colors, AIBoolean *exact)
	Retrieves a color table associated with an optimization settings group.
AIAPI AIErr(*	SetColorTable )(ai::int32 optimizationID, ai::int32 numColors, AIRGBColor *colors, AIBoolean exact)
	Sets the color table associated with an optimization settings group.
AIAPI AIErr(*	GetLockedColors )(ai::int32 optimizationID, ai::int32 numColors, AIRGBColor colors)
	Retrieves the locked colors in the color table associated with an optimization settings group.
AIAPI AIErr(*	SetLockedColors )(ai::int32 optimizationID, ai::int32 numColors, AIRGBColor *colors)
	Sets locked colors in the color table associated with an optimization settings group.
AIAPI AIErr(*	GetColorShiftEntries )(ai::int32 optimizationID, ai::int32 numEntries, ASColorShiftEntry entries)
	Retrieves the color shift information for the color table associated with an optimization settings group.
AIAPI AIErr(*	SetColorShiftEntries )(ai::int32 optimizationID, ai::int32 numEntries, ASColorShiftEntry *entries)
	Sets color shift information for the color table associated with an optimization settings group.

Detailed Description

This suite provides functions that allow you to access format-specific optimization settings and color table information, used for saving and placing images.

A file format plug-in must use the functions SetSliceOptimizationID(), SetSliceOptimizationSettings(), and SetSliceOptimizationSetting() to attach settings directly to a sliced art object during a file place operation when the main optimization settings database is unavailable. After the Place command, optimization settings attached to the object are inserted into the main database.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIOptimizationSettingsSuite and kAIOptimizationSettingsSuiteVersion.

Member Data Documentation

AIAPI void(* AIOptimizationSettingsSuite::DeleteOptimizationSettings)(ai::int32 optimizationID)

Removes an optimization settings group from the settings-group list.

(Note that this function does not return an error code.)

Parameters:

optimizationID

The unique identifier of the optimization settings group.

AIAPI AIErr(* AIOptimizationSettingsSuite::GetColorShiftEntries)(ai::int32 optimizationID, ai::int32 *numEntries, ASColorShiftEntry *entries)

Retrieves the color shift information for the color table associated with an optimization settings group.

You must always initialize the color table to 256 AIRGBColor entries. Color shifting allows you to map a range of colors to a single color, in order to reduce the overall number of colors

Parameters:

	optimizationID	The optimization settings group identifier.
	numEntries	[in, out] When `entries` is `NULL`, a buffer in which to return the number of entries needed for the `colors` array. For subsequent calls, pass in the number of entries in the `colors` array.
	entries	[in, out] A buffer in which to return the array of color-shift entries. For the first call, pass `NULL`, to get the number of entries, then allocate an array and pass it to a second call to fill the array.

AIAPI AIErr(* AIOptimizationSettingsSuite::GetColorTable)(ai::int32 optimizationID, ai::int32 *numColors, AIRGBColor *colors, AIBoolean *exact)

Retrieves a color table associated with an optimization settings group.

You must always initialize the color table to 256 AIRGBColor entries.

Parameters:

	optimizationID	The optimization settings group identifier.
	numColors	[in, out] When `colors` is `NULL`, a buffer in which to return the number of entries needed for the `colors` array. For subsequent calls, pass in the number of entries in the `colors` array.
	colors	[in, out] A buffer in which to return the color array. For the first call, pass `NULL`, to get the number of entries, then allocate an array and pass it to a second call to fill the array.
	exact	[out] A buffer in which to return true if the color exactly matches the request. <<what?>>

AIAPI ai::int32(* AIOptimizationSettingsSuite::GetIndexedOptimizationSettingsID)(ai::int32 index)

Retrieves an optimization settings group from the settings-group list, by position index.

Use with GetOptimizationSettingsCount() to iterate through settings groups. (Note that this function returns a numeric value, not an error code.)

Parameters:

index

The 0-based position index.

Returns:: The unique identifier of an optimization settings group.

AIAPI AIErr(* AIOptimizationSettingsSuite::GetLockedColors)(ai::int32 optimizationID, ai::int32 *numColors, AIRGBColor *colors)

Retrieves the locked colors in the color table associated with an optimization settings group.

You must always initialize the color table to 256 AIRGBColor entries.

Parameters:

	optimizationID	The optimization settings group identifier.
	numColors	[in, out] When `colors` is `NULL`, a buffer in which to return the number of entries needed for the `colors` array. For subsequent calls, pass in the number of entries in the `colors` array.
	colors	[in, out] A buffer in which to return the locked color array. For the first call, pass `NULL`, to get the number of entries, then allocate an array and pass it to a second call to fill the array.

AIAPI AIErr(* AIOptimizationSettingsSuite::GetOptimizationSetting)(ai::int32 optimizationID, const AIDictKey &key, AIEntryRef *valueEntry)

Retrieves a single optimization settings attribute.

Parameters:

	optimizationID	The optimization settings group identifier.
	key	The settings information attribute key.
	valueEntry	[out] A buffer in which to return the attribute value.

AIAPI AIErr(* AIOptimizationSettingsSuite::GetOptimizationSettings)(ai::int32 optimizationID, ASOptimizationSettings *settings)

Retrieves the optimization settings for a settings group.

Parameters:

	optimizationID	The optimization settings group identifier.
	settings	[out] A buffer in which to return the settings structure.

AIAPI ai::int32(* AIOptimizationSettingsSuite::GetOptimizationSettingsCount)(void)

Gets the number of optimization settings groups in the settings-group list.

Use with GetIndexedOptimizationSettingsID() to iterate through settings groups. (Note that this function returns a numeric value, not an error code.)

Returns:: The number of settings groups.

AIAPI ai::int32(* AIOptimizationSettingsSuite::GetUniqueOptimizationSettingsID)(void)

Retrieves a unique identifier suitable for an optimization settings group.

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

Returns:: A unique identifier for an optimization settings group.

AIAPI AIBoolean(* AIOptimizationSettingsSuite::OptimizationSettingsExists)(ai::int32 optimizationID)

Reports whether a unique identifier is currently used to identify an optimization settings group.

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

Parameters:

optimizationID

The optimization settings group identifier.

Returns:: True if the identifier is in use.

AIAPI AIErr(* AIOptimizationSettingsSuite::SetColorShiftEntries)(ai::int32 optimizationID, ai::int32 numEntries, ASColorShiftEntry *entries)

Sets color shift information for the color table associated with an optimization settings group.

Color shifting allows you to map a range of colors to a single color, in order to reduce the overall number of colors

Parameters:

	optimizationID	The optimization settings group identifier.
	numEntries	The number of entries in the `entries` array.
	entries	The array of color-shift entries. You must always initialize the color table to 256 `AIRGBColor` entries.

AIAPI AIErr(* AIOptimizationSettingsSuite::SetColorTable)(ai::int32 optimizationID, ai::int32 numColors, AIRGBColor *colors, AIBoolean exact)

Sets the color table associated with an optimization settings group.

Parameters:

	optimizationID	The optimization settings group identifier.
	numColors	The number of entries in the `colors` array.
	colors	The color array. You must always initialize the color table to 256 `AIRGBColor` entries.
	exact	True to use exact color matching.<<what?>>

AIAPI AIErr(* AIOptimizationSettingsSuite::SetLockedColors)(ai::int32 optimizationID, ai::int32 numColors, AIRGBColor *colors)

Sets locked colors in the color table associated with an optimization settings group.

Parameters:

	optimizationID	The optimization settings group identifier.
	numColors	The number of entries in the `colors` array.
	colors	The locked color array. You must always initialize the color table to 256 `AIRGBColor` entries.

AIAPI AIErr(* AIOptimizationSettingsSuite::SetOptimizationSetting)(ai::int32 optimizationID, const AIDictKey &key, AIEntryRef valueEntry)

Sets a single optimization settings attribute.

Parameters:

	optimizationID	The optimization settings group identifier.
	key	The settings information attribute key.
	valueEntry	The new attribute value.

AIAPI AIErr(* AIOptimizationSettingsSuite::SetOptimizationSettings)(ai::int32 optimizationID, ASOptimizationSettings *settings)

Sets the optimization settings for a settings group.

Parameters:

	optimizationID	The optimization settings group identifier.
	settings	The new settings structure.

AIAPI AIErr(* AIOptimizationSettingsSuite::SetSliceOptimizationID)(ai::int32 sliceID, ai::int32 optimizationID)

Associates a slice with an optimization group settings identifier.

A file format plug-in should use this before placing a sliced image, followed by SetSliceOptimizationSettings().

Parameters:

	slice	The slice identifier.
	optimizationID	The optimization settings group identifier.

AIAPI AIErr(* AIOptimizationSettingsSuite::SetSliceOptimizationSetting)(ai::int32 sliceID, const AIDictKey &key, AIEntryRef valueEntry)

Sets a single optimization settings attribute for a slice.

Use to supplement optimization information after it has been created with SetSliceOptimizationSettings().

Parameters:

	sliceID	The slice identifier.
	key	The settings information attribute key.
	valueEntry	The new attribute value.

AIAPI AIErr(* AIOptimizationSettingsSuite::SetSliceOptimizationSettings)(ai::int32 sliceID, ASOptimizationSettings *settings)

Sets the optimization settings for a slice.

A file format plug-in should use this before placing a sliced image.

Parameters:

	sliceID	The slice identifier.
	settings	The new settings structure.

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

AISlicing.h

AIOptimizationSettingsSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIOptimizationSettingsSuite Struct Reference
[API Suite List]