AIColorConvertOptions Class Reference

Color-space conversion options. More...

#include <AIColorConversion.h>

List of all members.

Public Types
enum	Purpose { kDefault, kForPreview, kForExport, kDummy = 0xFFFFFFFF }
	The purpose for performing a color-space conversion. More...
Public Member Functions
	AIColorConvertOptions ()
	Default color-space conversion option.
	AIColorConvertOptions (const Purpose &_purpose)
	Creates a color-conversion structure.
	AIColorConvertOptions (const AIColorConvertOptions &src)
	Copy constructor.
AIColorConvertOptions &	operator= (const AIColorConvertOptions &src)
	Assignment operator.
Public Attributes
Purpose	purpose
	The purpose for performing a color-space conversion.

---

Detailed Description

Color-space conversion options.

When converting CMYK to gray or RGB for preview or export, the constructor sets the appropriate black preservation value-- that is, whether a CMYK to RGB/Gray color transformation maps CMYK 0,0,0,1 to the darkest black:

• By default, the operation uses the standard conversion, which never uses black preservation.
• For export, the operation uses the black-preservation setting that is currently configured in the print and export preferences.
• For preview, the operation uses the black-preservation setting that is currently configured in the screen-display preferences.

---

Member Enumeration Documentation

enum AIColorConvertOptions::Purpose

The purpose for performing a color-space conversion.

Enumerator:

kDefault	Do standard conversion, without black preservation.
kForPreview	Use conversion options appropriate to creating an image for screen display.
kForExport	Use conversion options appropriate to creating an image for print or export.
kDummy

---

Constructor & Destructor Documentation

AIColorConvertOptions::AIColorConvertOptions

(

)

[inline]

Default color-space conversion option.

The operation uses the standard conversion, which never uses black preservation.

AIColorConvertOptions::AIColorConvertOptions

(

const Purpose &

_purpose

)

[inline]

Creates a color-conversion structure.

Parameters:

_purpose

The intended purpose of the conversion. When converting CMYK to gray or RGB for preview or export, sets the appropriate black preservation value.

Returns:

A color-conversion structure to pass to conversion functions.

See also:

AIColorConversionSuite::ConvertImageColor()
AIColorConversionSuite::ConvertImageColorEx()
AIColorConversionSuite::ConvertSampleColor()
AIColorConversionSuite::ConvertSampleColorEx()

AIColorConvertOptions::AIColorConvertOptions

(

const AIColorConvertOptions &

src

)

[inline]

Copy constructor.

---

Member Function Documentation

AIColorConvertOptions& AIColorConvertOptions::operator=

(

const AIColorConvertOptions &

src

)

[inline]

Assignment operator.

References purpose.

---

Member Data Documentation

Purpose AIColorConvertOptions::purpose

The purpose for performing a color-space conversion.

kDefault, kForPreview or kForExport

Referenced by operator=().

---

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

• AIColorConversion.h