DL Logo

acrocolor Definitions

AcroColorHFTNAME

Header: AcroColorExpT.h:58

Syntax

#define AcroColorHFTNAME "AcroColorHFT"

FOUR_CHAR_CODE

Header: AcroColorExpT.h:47

Syntax

#define FOUR_CHAR_CODE ( x )

FOUR_CHAR_CODE

Header: AcroColorExpT.h:50

Syntax

#define FOUR_CHAR_CODE ( x )( x )

_FLG

Header: AcroColorExpT.h:1259

Syntax

#define _FLG ( n )( 1 << n )

kACEMaxPathLength

Header: AcroColorExpT.h:1248

Syntax

#define kACEMaxPathLength 260

kACEMaxPathLength

Header: AcroColorExpT.h:1250

Syntax

#define kACEMaxPathLength 256

kACMaxPathLength

Header: AcroColorExpT.h:733

Syntax

#define kACMaxPathLength 260

kACMaxPathLength

Header: AcroColorExpT.h:735

Syntax

#define kACMaxPathLength 256

acrocolor Enumerations

ACWorkingSpace

Header: AcroColorExpT.h:1236

Description

Constants that specify the color space of working profiles. This enumeration is added for the purpose of ACGetWorkingSpaceProfile(). The profile returned by this function must be unreferenced by the caller.

Enum Constants

kACWorkingGray=0
Grayscale profile.
kACWorkingRGB=1
RGB profile.
kACWorkingCMYK=2
CMYK profile.
kACWorkingSpaces=3
Working spaces.

Used By

AC_ColorSpace

Header: AcroColorExpT.h:1117

Description

Constant values for ICC color space signatures.

Enum Constants

AC_Space_XYZ=FOUR_CHAR_CODE('XYZ ')
AC_Space_Lab=FOUR_CHAR_CODE('Lab ')
AC_Space_RGB=FOUR_CHAR_CODE('RGB ')
AC_Space_Gray=FOUR_CHAR_CODE('GRAY')
AC_Space_CMYK=FOUR_CHAR_CODE('CMYK')
AC_Space_Luv=FOUR_CHAR_CODE('Luv ')
AC_Space_YCbCr=FOUR_CHAR_CODE('YCbr')
AC_Space_HSV=FOUR_CHAR_CODE('HSV ')
AC_Space_HLS=FOUR_CHAR_CODE('HLS ')
AC_Space_CMY=FOUR_CHAR_CODE('CMY ')
AC_Space_2Component=FOUR_CHAR_CODE('2CLR')
AC_Space_3Component=FOUR_CHAR_CODE('3CLR')
AC_Space_4Component=FOUR_CHAR_CODE('4CLR')
AC_Space_5Component=FOUR_CHAR_CODE('5CLR')
AC_Space_6Component=FOUR_CHAR_CODE('6CLR')
AC_Space_7Component=FOUR_CHAR_CODE('7CLR')
AC_Space_8Component=FOUR_CHAR_CODE('8CLR')
AC_Space_9Component=FOUR_CHAR_CODE('9CLR')
AC_Space_10Component=FOUR_CHAR_CODE('ACLR')
AC_Space_11Component=FOUR_CHAR_CODE('BCLR')
AC_Space_12Component=FOUR_CHAR_CODE('CCLR')
AC_Space_13Component=FOUR_CHAR_CODE('DCLR')
AC_Space_14Component=FOUR_CHAR_CODE('ECLR')
AC_Space_15Component=FOUR_CHAR_CODE('FCLR')
AC_Space_PhotoYCC=AC_Space_3Component
Kodak's PhotoYCC space is stored as a generic 3-component space.
AC_Space_Null=0
A null color space. Used to represent spot-only color spaces.
AC_Space_MaxEnum=0x7FFFFFFF
This constant forces the enum to be 32 bits wide.

Returned From

Used By

AC_Error

Header: AcroColorExpT.h:268

Description

Error codes returned by AcroColor functions.

Enum Constants

AC_Error_None=0
No error.
AC_Error_General=FOUR_CHAR_CODE('gen ')
Other error.
AC_Error_Param=FOUR_CHAR_CODE('parm')
Bad parameters to an API call.
AC_Error_Version=FOUR_CHAR_CODE('ver ')
Application and ACE library mismatch.
AC_Error_UserAbort=FOUR_CHAR_CODE('abrt')
The user aborted the operation. Returned by ACE when the client progress callback returns false.
AC_Error_Memory=FOUR_CHAR_CODE('memF')
Out of memory.
AC_Error_StackFull=FOUR_CHAR_CODE('stkF')
Out of stack space.
AC_Error_ScratchFull=FOUR_CHAR_CODE('scrF')
Client callback ran out of scratch space.
AC_Error_StringOverflow=FOUR_CHAR_CODE('strO')
String does not fit in supplied buffer.
AC_Error_NoASCII=FOUR_CHAR_CODE('noA ')
String does not contain ASCII data.
AC_Error_NoUnicode=FOUR_CHAR_CODE('noU ')
String does not contain Unicode data.
AC_Error_NoLocalized=FOUR_CHAR_CODE('noL ')
String does not contain localized data.
AC_Error_BadAlignment=FOUR_CHAR_CODE('alig')
Data is not correctly byte aligned.
AC_Error_BadDescription=FOUR_CHAR_CODE('bDes')
Invalid profile description.
AC_Error_BadConcat=FOUR_CHAR_CODE('bCat')
Unable to concatenate transforms.
AC_Error_BadMerge=FOUR_CHAR_CODE('bMrg')
Unable to merge transforms.
AC_Error_BadProfile=FOUR_CHAR_CODE('bPro')
Invalid profile.
AC_Error_UnsupCMS=FOUR_CHAR_CODE('uCMS')
Unsupported CMS.
AC_Error_UnsupOption=FOUR_CHAR_CODE('uOpt')
Unsupported ACE option.
AC_Error_UnsupPacking=FOUR_CHAR_CODE('uPac')
Unsupported packing code.
AC_Error_UnsupProfile=FOUR_CHAR_CODE('uPro')
Unsupported profile version.
AC_Error_UnsupProfileCode=FOUR_CHAR_CODE('uPrC')
Unsupported profile code.
AC_Error_UnsupSpace=FOUR_CHAR_CODE('uSpc')
Unsupported color space.
AC_Error_UnsupQuery=FOUR_CHAR_CODE('uQry')
Unsupported query code.
AC_Error_MissingProfile=FOUR_CHAR_CODE('misP')
A profile was missing from the disk.
AC_Error_ModifiedProfile=FOUR_CHAR_CODE('modP')
The profile on disk has been modified.
AC_Error_FileNotFound=FOUR_CHAR_CODE('fnf ')
File is missing from disk.
AC_Error_EOF=FOUR_CHAR_CODE('eof ')
End of file error.
AC_Error_FileLocked=FOUR_CHAR_CODE('flck')
File locked error.
AC_Error_DiskIO=FOUR_CHAR_CODE('io ')
Disk I/O error.
AC_Error_ColorSync=FOUR_CHAR_CODE('csE ')
A problem using ColorSync.
AC_Error_ICM=FOUR_CHAR_CODE('icmE')
A problem using ICM.
AC_Error_MissingKey=FOUR_CHAR_CODE('mKey')
The color settings does not contain this key.
AC_Error_InvalidSettings=FOUR_CHAR_CODE('iSet')
The color settings file is invalid.
AC_Error_SettingsVersion=FOUR_CHAR_CODE('vSet')
The color settings file is an incompatible version.
AC_Error_NotImplemented=FOUR_CHAR_CODE('nImp')
The function is not implemented (subsetted library).
AC_Error_MaxEnum=0x7FFFFFFF
This constant forces the enum to be 32 bits wide.

Returned From

AC_PackingCode

Header: AcroColorExpT.h:492

Description

Constants that specify the packing used in a color transformation.

Enum Constants

AC_Packing_pRGB8=FOUR_CHAR_CODE('prgb')

8-bit RGB (or grayscale destination), with a leading pad byte. When grayscale is output in this format, the gray value is replicated into to the R, G, and B values.

R, G, B = 0 is black.

R, G, B = 255 is white.

Data must be 32-bit aligned.

AC_Packing_RGB8=FOUR_CHAR_CODE('rgb ')
Same as AC_Packing_pRGB8, without the leading pad byte. Data need only be 8-bit aligned.
AC_Packing_pRGB15=FOUR_CHAR_CODE('PRGB')

15+ bit RGB (or grayscale destination), with a leading pad word. When grayscale is output in this format, the gray value is replicated into to the R, G, and B values.

R, G, B = 0 is black.

R, G, B = 32768 is white.

Values greater than 32768 are invalid.

Data must be 64-bit aligned.

AC_Packing_CMYK8_Black0=FOUR_CHAR_CODE('cmyk')

8-bit CMYK.

C, M, Y, K = 0 is 100% ink.

C, M, Y, K = 255 is 0% ink.

Data must be 32-bit aligned.

AC_Packing_CMYK8_White0=FOUR_CHAR_CODE('cmyw')
Same as AC_Packing_CMYK8_Black0 with inverse encoding.
AC_Packing_CMYK15_Black0=FOUR_CHAR_CODE('CMYK')

15+ bit CMYK.

C, M, Y, K = 0 is 100% ink.

C, M, Y, K = 32768 is 0% ink.

Values greater than 32768 are invalid.

Data must be 64-bit aligned.

AC_Packing_pLab8=FOUR_CHAR_CODE('plab')

8-bit LAB, with a leading pad byte.

L = 0 means L * = 0.0

L = 255 means L * = 100.0

a, b = 0 means a *, b * =-128.0

a, b = 128 means a *, b * = 0.0

a, b = 255 means a *, b * = +127.0

Data must be 32-bit aligned.

AC_Packing_Lab8=FOUR_CHAR_CODE('lab ')

Same as AC_Packing_pLab8, without the leading pad byte.

Data need only be 8-bit aligned.

AC_Packing_pLab15=FOUR_CHAR_CODE('PLAB')

15+ bit LAB, with a leading pad word.

L = 0 means L * = 0.0

L = 32768 means L * = 100.0

a, b = 0 means a *, b * =-128.0

a, b = 16384 means a *, b * = 0.0

a, b = 32768 means a *, b * = +128.0

Values greater than 32768 are invalid.

Data must be 64-bit aligned.

AC_Packing_Gray8_Black0=FOUR_CHAR_CODE('g8k0')

8-bit grayscale or gamut test results, no padding.

G = 0 is 100% ink or black or fully out of gamut.

G = 255 is 0% ink or white or fully in gamut.

When used for gamut test results, any value greater than or equal to 128 should be considered to be in gamut.

AC_Packing_Gray8_White0=FOUR_CHAR_CODE('g8w0')
Same as AC_Packing_Gray8_Black0 with inverse encoding.
AC_Packing_Gray15_Black0=FOUR_CHAR_CODE('G15K')

15+ bit grayscale or gamut test results, no padding.

G = 0 is 100% ink or black or fully out of gamut.

G = 32768 is 0% ink or white or fully in gamut.

Values greater than 32768 are invalid.

Data must be 16-bit aligned.

AC_Packing_pXYZ16=FOUR_CHAR_CODE('PXYZ')

16-bit XYZ, with a leading pad word.

X, Y, Z = 0 means X, Y, Z = 0.0

X, Y, Z = 32768 means X, Y, Z = 1.0

X, Y, Z = 65535 means X, Y, Z = 1.9999694824.

Data must be 64-bit aligned.

AC_Packing_pABC8=FOUR_CHAR_CODE('pabc')
Generic padded 3-component 8-bit packing. Data must be 32-bit aligned.
AC_Packing_ABC8=FOUR_CHAR_CODE('abc ')
Same as AC_Packing_pABC8, without the leading pad byte. Data need only be 8-bit aligned.
AC_Packing_pABC15=FOUR_CHAR_CODE('pABC')
Generic padded 3-component 15+ bit packing. Data must be 64-bit aligned.
AC_Packing_ABCD8=FOUR_CHAR_CODE('abcd')
Generic 4-component 8-bit packing. Data must be 32-bit aligned.
AC_Packing_ABCD15=FOUR_CHAR_CODE('ABCD')
Generic 4-component 15+ bit packing. Data must be 64-bit aligned.
AC_Packing_CS64_Gray=FOUR_CHAR_CODE('CS01')
Packing codes for native 64-bit (gray) ColorSync formats (type "CMColor"). ICM2 also uses these packings formats (type "COLOR"). See the Apple ColorSync documentation for the details of these formats. These are mostly intended for internal use by ACE, and are not intended for use by most ACE clients. Data must be 16-bit aligned.
AC_Packing_CS64_RGB=FOUR_CHAR_CODE('CS02')
Packing codes for native 64-bit (RGB) ColorSync formats (type "CMColor"). ICM2 also uses these packings formats (type "COLOR"). See the Apple ColorSync documentation for the details of these formats. These are mostly intended for internal use by ACE, and are not intended for use by most ACE clients. Data must be 16-bit aligned.
AC_Packing_CS64_CMYK=FOUR_CHAR_CODE('CS03')
Packing codes for native 64-bit (CMYK) ColorSync formats (type "CMColor"). ICM2 also uses these packings formats (type "COLOR"). See the Apple ColorSync documentation for the details of these formats. These are mostly intended for internal use by ACE, and are not intended for use by most ACE clients. Data must be 16-bit aligned.
AC_Packing_CS64_Lab=FOUR_CHAR_CODE('CS04')
Packing codes for native 64-bit (Lab) ColorSync formats (type "CMColor"). ICM2 also uses these packings formats (type "COLOR"). See the Apple ColorSync documentation for the details of these formats. These are mostly intended for internal use by ACE, and are not intended for use by most ACE clients. Data must be 16-bit aligned.
AC_Packing_CS64_XYZ=FOUR_CHAR_CODE('CS05')
Packing codes for native 64-bit (xyz) ColorSync formats (type "CMColor"). ICM2 also uses these packings formats (type "COLOR"). See the Apple ColorSync documentation for the details of these formats. These are mostly intended for internal use by ACE, and are not intended for use by most ACE clients. Data must be 16-bit aligned.
AC_Packing_CS64_ABC=FOUR_CHAR_CODE('CS06')
Packing codes for native 64-bit (abc) ColorSync formats (type "CMColor"). ICM2 also uses these packings formats (type "COLOR"). See the Apple ColorSync documentation for the details of these formats. These are mostly intended for internal use by ACE, and are not intended for use by most ACE clients. Data must be 16-bit aligned.
AC_Packing_CS64_ABCD=FOUR_CHAR_CODE('CS07')
Packing codes for native 64-bit (abcd)ColorSync formats (type "CMColor"). ICM2 also uses these packings formats (type "COLOR"). See the Apple ColorSync documentation for the details of these formats. These are mostly intended for internal use by ACE, and are not intended for use by most ACE clients. Data must be 16-bit aligned.
AC_Packing_Null=FOUR_CHAR_CODE('null')
NULL data, for use with data in AC_Space_Null.
AC_Packing_General=0
None of the above; use the general packing specification.
AC_Packing_MaxEnum=0x7FFFFFFF
This constant forces the enum to be 32 bits wide.

Used By

AC_ProfileCode

Header: AcroColorExpT.h:389

Description

Constants that describe the type of a device color profile.

Enum Constants

AC_Profile_Null=0
A NULL result, indication that a profile is not a built-in profile.
AC_Profile_Lab_D50=FOUR_CHAR_CODE('LD50')
Adobe's standard Lab profile. It has a white point of D50, and exactly matches the ICC's Lab PCS space.
AC_Profile_PCS_XYZ=FOUR_CHAR_CODE('pXYZ')
An XYZ profile that exactly matches the ICC's XYZ PCS space.
AC_Profile_Flat_XYZ=FOUR_CHAR_CODE('fXYZ')
An XYZ profile with a flat white point encoding ( X = Y = Z = 1.0). Photoshop uses this as an intermediate space in its display loop.
AC_Profile_sRGB=FOUR_CHAR_CODE('sRGB')
HP's sRGB profile. The default Windows monitor profile.
AC_Profile_AppleRGB=FOUR_CHAR_CODE('aRGB')
Default RGB space using by Photoshop 4.0 and earlier. The default Mac OS monitor profile.
AC_Profile_AdobeRGB1998=FOUR_CHAR_CODE('AS98')
A wider gamut RGB space recommended by Adobe.
AC_Profile_ColorMatchRGB=FOUR_CHAR_CODE('cmat')
A simplified version of Radius' ColorMatch RGB space, without Radius' non-zero black point.
AC_Profile_Gamma18=FOUR_CHAR_CODE('GG18')
Grayscale display profile with a gamma of 18.
AC_Profile_Gamma22=FOUR_CHAR_CODE('GG22')
Grayscale display profile with a gamma of 22.
AC_Profile_DotGain10=FOUR_CHAR_CODE('DG10')
Grayscale printer profile with a dot gain of 10.
AC_Profile_DotGain15=FOUR_CHAR_CODE('DG15')
Grayscale printer profile with a dot gain of 15.
AC_Profile_DotGain20=FOUR_CHAR_CODE('DG20')
Grayscale printer profile with a dot gain of 20.
AC_Profile_DotGain25=FOUR_CHAR_CODE('DG25')
Grayscale printer profile with a dot gain of 25.
AC_Profile_DotGain30=FOUR_CHAR_CODE('DG30')
Grayscale printer profile with a dot gain of 30.
AC_Profile_MonitorRGB=FOUR_CHAR_CODE('mRGB')
The system "Monitor RGB" profile, which is the same profile as that returned by AC_MainMonitorProfile.
AC_Profile_SystemRGB=FOUR_CHAR_CODE('sysR')
The system default profiles for RGB color space. (Currently a ColorSync 3.0 only feature.)
AC_Profile_SystemCMYK=FOUR_CHAR_CODE('sysC')
The system default profiles for CMYK color space. (Currently a ColorSync 3.0 only feature.)
AC_Profile_SystemGray=FOUR_CHAR_CODE('sysG')
The system default profiles for Gray color space. (Currently a ColorSync 3.0 only feature.)
AC_Profile_SystemInput=FOUR_CHAR_CODE('sysI')
The system default profiles for input device type. (Currently a ColorSync 3.0 only feature.)
AC_Profile_SystemOutput=FOUR_CHAR_CODE('sysO')
The system default profiles for output device type. (Currently a ColorSync 3.0 only feature.)
AC_Profile_SystemProofer=FOUR_CHAR_CODE('sysP')
The system default profiles for proofer device type. (Currently a ColorSync 3.0 only feature.)
AC_Profile_WorkingRGB=FOUR_CHAR_CODE('wRGB')
The application working (RGB) color space profiles. (For use as abstact values only, since ACE does not keep track of these profiles, and thus cannot make profiles from these codes.)
AC_Profile_WorkingCMYK=FOUR_CHAR_CODE('wCMY')
The application working (CMYK) color space profiles. (For use as abstact values only, since ACE does not keep track of these profiles, and thus cannot make profiles from these codes.)
AC_Profile_WorkingGray=FOUR_CHAR_CODE('wGry')
The application working (gray) color space profiles. (For use as abstact values only, since ACE does not keep track of these profiles, and thus cannot make profiles from these codes.)
AC_Profile_Acrobat5_CMYK=FOUR_CHAR_CODE('acr5')
AC_Profile_Acrobat9_CMYK=FOUR_CHAR_CODE('acr9')
AC_Profile_MaxEnum=0x7FFFFFFF
This constant forces the enum to be 32 bits wide.

Used By

AC_RenderIntent

Header: AcroColorExpT.h:673

Description

Constants that specify a standard ICC rendering intent for a device color profile. The rendering intent specifies the color translation method for colors that are outside the gamut of the color profile.

Enum Constants

AC_Perceptual=0
Tries to preserve the visual relationship between colors in a way that is perceived as natural to the human eye, although the color values themselves may change. This is the same as the Image intent in Adobe PageMaker and Illustrator. This option is suitable for photographic, continuous tone images.
AC_RelColorimetric=1
The same as absolute colorimetric, except that it compares the white point of the source color space to that of the destination color space and shifts all other colors accordingly, rather than comparing individual colors.
AC_Saturation=2
Tries to create vivid color at the expense of accurate color. It scales the source gamut to the destination gamut, but preserves relative saturation instead of hue, so that when scaling to a smaller gamut, hues may shift. This is the same as the Graphics intent in Adobe PageMaker and Illustrator. This option is suitable for business graphics and charts, where the exact relationship between colors is not as important as having bright saturated colors.
AC_AbsColorimetric=3
Tries to maintain color accuracy at the expense of preserving relationships between colors. It leaves colors that fall inside the destination gamut unchanged. When translating to a smaller gamut, two colors that are distinct in the source space may be mapped to the same color in the destination space. This type of rendering can be more accurate than AC_RelColorimetric if the color profile of the image contains correct white point (extreme highlight) information.
AC_UseProfileIntent=4
Use the source profile's rendering intent.
AC_UseGStateIntent=5
This intent can be used ONLY in PDPageDrawContentsToMemoryWithParams. When it is used, the destination intent will be set to the same as the source intent
AC_RenderIntentSize=0x7FFFFFFF

Used By

Used In

AC_SelectorCode

Header: AcroColorExpT.h:200

Description

Constants that specify the types of device profiles to include in a profile list.

Enum Constants

AC_Selector_RGB_Standard=FOUR_CHAR_CODE('rStd')
Standard (recommended) RGB profiles. These profiles are always bidirectional.
AC_Selector_RGB_OtherInputCapable=FOUR_CHAR_CODE('rInp')
RGB profiles that can be used as a source. These profiles may or may not be usable as a destination. This constant does not include profiles selected by AC_Selector_RGB_Standard.
AC_Selector_RGB_OtherOutputCapable=FOUR_CHAR_CODE('rOut')
RGB profiles that can be used as a destination. These profiles are also usable as a source. This constant does not include profiles selected by AC_Selector_RGB_Standard.
AC_Selector_CMYK_StandardInput=FOUR_CHAR_CODE('cSIn')
Standard (recommended) CMYK profiles that can be used as a source. These profiles may or may not be usable as a destination.
AC_Selector_CMYK_StandardOutput=FOUR_CHAR_CODE('cStd')
Standard (recommended) CMYK profiles that can be used as a destination. These profiles are also usable as a source.
AC_Selector_CMYK_OtherInputCapable=FOUR_CHAR_CODE('cInp')
CMYK profiles that can be used as a source. These profiles may or may not be usable as a destination. This constant does not include profiles selected by AC_Selector_CMYK_StandardInput or AC_Selector_CMYK_StandardOutput.
AC_Selector_CMYK_OtherOutputCapable=FOUR_CHAR_CODE('cOut')
CMYK profiles that can be used as a destination. These profiles are also usable as a source. This constant does not include profiles selected by AC_Selector_CMYK_StandardOutput.
AC_Selector_Gray_Standard=FOUR_CHAR_CODE('gStd')
Standard (recommended) grayscale profiles. These profiles are always bidirectional.
AC_Selector_Gray_OtherInputCapable=FOUR_CHAR_CODE('gInp')
Grayscale profiles that can be used as a source. These profiles may or may not be usable as a destination. This constant does not include profiles selected by AC_Selector_Gray_Standard.
AC_Selector_Gray_OtherOutputCapable=FOUR_CHAR_CODE('gOut')
Grayscale profiles that can be used as a destination. These profiles are also usable as a source. This constant does not include profiles selected by AC_Selector_Gray_Standard.
AC_Selector_DotGain_Standard=FOUR_CHAR_CODE('dStd')
Standard dot gain profiles. This constant is used by Photoshop to represent a single ink's dot gain curve, and is stored as an ICC gray output profile.
AC_Selector_DotGain_Other=FOUR_CHAR_CODE('dOth')
Other grayscale printer profiles. This constant does not include profiles selected by AC_Selector_DotGain_Standard, and does not include grayscale display profiles.
AC_Selector_PhotoYCC_InputCapable=FOUR_CHAR_CODE('iYCC')
PhotoYCC profiles that can be used as a source.
AC_Selector_MaxEnum=0x7FFFFFFF
This constant forces the enum to be 32 bits wide.

Used By

AC_SettingsKey

Header: AcroColorExpT.h:1014

Description

Constant key values for an AC_Settings object.

Enum Constants

AC_Key_Name=FOUR_CHAR_CODE('name')
Settings file name string (if different than the file name).
AC_Key_Description=FOUR_CHAR_CODE('desc')
Settings file description string.
AC_Key_WriterName=FOUR_CHAR_CODE('wNam')
Name of application to write this settings file.
AC_Key_WorkingRGB=FOUR_CHAR_CODE('wRGB')
Working RGB profile.
AC_Key_WorkingCMYK=FOUR_CHAR_CODE('wCMY')
Working CMYK profile.
AC_Key_WorkingGray=FOUR_CHAR_CODE('wGry')
Working gray profile.
AC_Key_WorkingSpot=FOUR_CHAR_CODE('wSpt')
Working spot profile.
AC_Key_PolicyRGB=FOUR_CHAR_CODE('pRGB')
RGB color management policy (AC_Policy enum).
AC_Key_PolicyCMYK=FOUR_CHAR_CODE('pCMY')
CMYK color management policy (AC_Policy enum).
AC_Key_PolicyGray=FOUR_CHAR_CODE('pGry')
Gray color management policy (AC_Policy enum).
AC_Key_MismatchAskOpening=FOUR_CHAR_CODE('mAsk')
Ask about profile mismatches when opening ( 0 = no, 1 = yes).
AC_Key_MismatchAskPasting=FOUR_CHAR_CODE('pAsk')
Ask about profile mismatches when pasting ( 0 = no, 1 = yes).
AC_Key_MissingAskOpening=FOUR_CHAR_CODE('misA')
Ask about missing profile when opening ( 0 = no, 1 = yes).
AC_Key_EngineCMS=FOUR_CHAR_CODE('eCMS')
Conversion engine CMS code (4-char code, stored as unsigned32).
AC_Key_EngineCMM=FOUR_CHAR_CODE('eCMM')
Conversion engine CMM code (4-char code, stored as unsigned32).
AC_Key_Intent=FOUR_CHAR_CODE('cInt')
Conversion intent (standard ICC integer encoding).
AC_Key_KPC=FOUR_CHAR_CODE('kpc ')
Conversion black point compensation ( 0 = no, 1 = yes).
AC_Key_Dither=FOUR_CHAR_CODE('dith')
Dither conversions between 8-bit color spaces ( 0 = no, 1 = yes).
AC_Key_CompressionEnabled=FOUR_CHAR_CODE('mce ')
Enable or disable monitor compression ( 0 = off, 1 = on).
AC_Key_CompressionPercent=FOUR_CHAR_CODE('mcp ')
Monitor compression percent (in percent).
AC_Key_BlendGammaEnabled=FOUR_CHAR_CODE('bge ')
Enable or disable RGB blending gamma ( 0 = off, 1 = on).
AC_Key_BlendGammaValue=FOUR_CHAR_CODE('bgv ')
RGB blending gamma value ( 100 = gamma 1.00).
AC_Key_ProofType=FOUR_CHAR_CODE('pTyp')
Proof type (AC_ProofType enum).
AC_Key_ProofProfile=FOUR_CHAR_CODE('pPrf')
Proof profile.
AC_Key_Simulate=FOUR_CHAR_CODE('dSim')
Display simulation (AC_Simulate enum).
AC_Key_MaxEnum=0x7FFFFFFF
This constant forces the enum to be 32 bits wide.

Used By

AC_SettingsType

Header: AcroColorExpT.h:1100

Description

Constant values that determine the type of an AC_Settings object.

Enum Constants

AC_SettingsType_Color=FOUR_CHAR_CODE('AsCs')
Used to hold global color settings, such as working spaces.
AC_SettingsType_Proof=FOUR_CHAR_CODE('AsPs')
Used to specify the parameters for proofing a document. The Proof Setup Files generally control a per-window setting.
AC_SettingsType_MaxEnum=0x7FFFFFFF
This constant forces the enum to be 32 bits wide.

Used By

PDColorConvertActionType

Header: AcroColorExpT.h:1363

Description

Action types: these specify what to do when an object is matched.

Enum Constants

kColorConvPreserve
Do nothing but handle ink aliases.
kColorConvConvert
Convert to target space.
kColorConvDecalibrate
Convert calibrated space to device space.
kColorConvDownConvert
Convert NChannel space to DeviceN space.
kColorConvToAltSpace
Convert spot to Alternate Space
kColorConvMaxEnum=0x7FFFFFFF
Maximum enum value.

Used By

Used In

PDColorConvertObjectAttributeFlags

Header: AcroColorExpT.h:1262

Description

Object attributes: these are arranged as a bitmap.

Value options for PDColorConvertObjectAttributes.

Enum Constants

kColorConvObj_Image=_FLG(0)
Object is an image.
kColorConvObj_JPEG=_FLG(1)
Object is a JPEG image.
kColorConvObj_JPEG2000=_FLG(2)
Object is a JPEG2000 image.
kColorConvObj_Lossy=_FLG(3)
Image is in a lossy space.
kColorConvObj_Lossless=_FLG(4)
Image is in a non-lossy space.
kColorConvObj_Text=_FLG(5)
Object is text.
kColorConvObj_LineArt=_FLG(6)
Object is line-art (fill, stroke).
kColorConvObj_Shade=_FLG(7)
Object is a smooth shade.
kColorConvObj_Transparent=_FLG(8)
Object is not opaque.
kColorConvObj_Overprinting=_FLG(9)
Object overprints.
kColorConvObj_OverprintMode=_FLG(10)
Overprint mode (OPM) is set to 1.
kColorConvObj_AnyObject=(_FLG(0)|_FLG(5)|_FLG(6)|_FLG(7))
Any object.
kColorConvObj_MaxEnum=ASMAXInt32
Maximum enum value.

PDColorConvertSpaceTypeFlags

Header: AcroColorExpT.h:1309

Description

Color Space attributes: these are arranged as a bitmap.

Value options for PDColorConvertSpaceType.

Enum Constants

kColorConvDeviceSpace=_FLG(0)
Device color space.
kColorConvCalibratedSpace=_FLG(1)
Calibrated color space.
kColorConvAlternateSpace=_FLG(3)
Alternate color space.
kColorConvBaseSpace=_FLG(4)
Base of an indexed space.
kColorConvIndexedSpace=_FLG(5)
Indexed color space.
kColorConvSeparationSpace=_FLG(6)
Separation color space.
kColorConvDeviceNSpace=_FLG(7)
DeviceN color space.
kColorConvNChannelSpace=_FLG(8)
NChannel color space.
kColorConvRGBSpace=_FLG(9)
RGB color space. This should only be set if either Device space (unless Lab) or Calibrated space is set.
kColorConvCMYKSpace=_FLG(10)
CMYK color space. This should only be set if either Device space (unless Lab) or Calibrated space is set.
kColorConvGraySpace=_FLG(11)
Gray color space. This should only be set if either Device space (unless Lab) or Calibrated space is set.
kColorConvLabSpace=_FLG(12)
Lab color space.
kColorConvertMatchProfile=_FLG(13)
Match Specified Profile. This action should only be take if it is a decalibration, and the specified profile matches the color profile of the current color
kColorConvAnySpace=(_FLG(0)|_FLG(1)|_FLG(2)|_FLG(3)|_FLG(4)|_FLG(5)|_FLG(6)|_FLG(7)|_FLG(8)|_FLG(9)|_FLG(10)|_FLG(11)|_FLG(12))
Any color space.
kColorConvSpace_MaxEnum=ASMAXInt32
Maximum enum value.

PDCompletionCode

Header: AcroColorExpT.h:1615

Description

Callback completion code.

Enum Constants

PDCompletionSuccess
Success.
PDCompletionContinue
Continue.
PDCompletionAbort
Abort.

Used By

PDReasonCode

Header: AcroColorExpT.h:1627

Description

Callback reason code.

Enum Constants

PDReasonNone
None.
PDReasonNotImplemented
None implemented.

Used By

acrocolor Typedefs

ACSwatchBook

Header: AcroColorExpT.h:1647

Description

Swatchbook object.

For value options see PDFlattenerColorCompSet.

Syntax

typedef void *ACSwatchBook;

Returned From

Used By

ACSwatchBookDB

Header: AcroColorExpT.h:1644

Description

Swatchbook database object.

Syntax

typedef void *ACSwatchBookDB;

Returned From

Used By

AC_PresetList

Header: AcroColorExpT.h:189

Syntax

typedef ACPresetList *AC_PresetList;

AC_PresetList

Header: AcroColorExpT.h:193

Syntax

typedef struct ACPresetList *AC_PresetList;

Used By

AC_Profile

Header: AcroColorExpT.h:169

Syntax

typedef ACProfile *AC_Profile;

AC_Profile

Header: AcroColorExpT.h:173

Syntax

typedef struct ACProfile *AC_Profile;

Used By

Used In

AC_ProfileList

Header: AcroColorExpT.h:100

Syntax

typedef ACProfileList *AC_ProfileList;

AC_ProfileList

Header: AcroColorExpT.h:104

Syntax

typedef struct ACProfileList *AC_ProfileList;

Used By

AC_Settings

Header: AcroColorExpT.h:138

Syntax

typedef ACSettings *AC_Settings;

AC_Settings

Header: AcroColorExpT.h:142

Syntax

typedef struct ACSettings *AC_Settings;

Used By

AC_String

Header: AcroColorExpT.h:81

Syntax

typedef ACString *AC_String;

AC_String

Header: AcroColorExpT.h:85

Syntax

typedef struct ACString *AC_String;

Used By

AC_Transform

Header: AcroColorExpT.h:117

Syntax

typedef ACTransform *AC_Transform;

AC_Transform

Header: AcroColorExpT.h:121

Syntax

typedef struct ACTransform *AC_Transform;

Used By

PDColorConvertObjectAttributes

Header: AcroColorExpT.h:1306

Description

Object attributes: these are arranged as a bitmap.

For value options see PDColorConvertObjectAttributeFlags.

Syntax

typedef ASUns32 PDColorConvertObjectAttributes;

Used By

Used In

PDColorConvertSpaceType

Header: AcroColorExpT.h:1360

Description

Color Space attributes: these are arranged as a bitmap.

For value options see PDColorConvertSpaceTypeFlags.

Syntax

typedef ASUns32 PDColorConvertSpaceType;

Used By

Used In

acrocolor Callback Signatures

PDColorConvertReportProc

Header: AcroColorExpT.h:1636

Syntax

void PDColorConvertReportProc(PDColorConvertObjectAttributes objectType, PDColorConvertSpaceType colorSpaceType, PDColorConvertActionType action, PDCompletionCode completionCode, PDReasonCode reasonCode, void *userData);

Used By

acrocolor Structures

PDColorConvertAction

Header: AcroColorExpT.h:1390

Description

Defines a color conversion action for a combination of attributes, color space/family, and rendering intent. If all three match, the actions in the action list will be executed for any given object.

Syntax

struct PDColorConvertAction {
PDColorConvertObjectAttributes mMatchAttributesAll;
Object attribute. The flags must all match for a match.
PDColorConvertObjectAttributes mMatchAttributesAny;
Object attribute. The flags will allow any match.
PDColorConvertSpaceType mMatchSpaceTypeAll;
Type of color space. The flags must all match for a match.
PDColorConvertSpaceType mMatchSpaceTypeAny;
Type of color space. The flags will allow any match.
AC_RenderIntent mMatchIntent;
The rendering intent of the object. If this is AC_UseProfileIntent, this action applies to any intent.
Defines the action, indicating what to do when an object matches this record.
AC_RenderIntent mConvertIntent;
If converting, use this intent to override the object's intent for performing color conversion. AC_UseProfileIntent means that the intent of the object must not be overridden.
AC_Profile mConvertProfile;
The target profile for the conversion. If the output intent is embedded, this should be the output intent profile.
ASBool mEmbed;
If true, embed the target profile. If false the resulting color is Device, if possible.
ASBool mPreserveBlack;
If true, perform a black-preserving transform when converting.
ASBool mUseBlackPointCompensation;
If true, turn on black point compensation for color conversions.
ASAtom mColorantName;
For ink actions (which describe a single colorant, whether used in Separation or DeviceN, and which are not matched using the above matching fields) this describes the colorant of the ink.
ASAtom mAlias;
Ink alias; this only applies to ink actions.
ASBool mIsProcessColor;
true if this ink is a process ink.
void *mInternal;
For internal use.
} PDColorConvertActionRec, *PDColorConvertAction;

Used In

PDColorConvertActionEx

Header: AcroColorExpT.h:1480

Description

Defines a color conversion action for a combination of attributes, color space/family, and rendering intent. If all three match, actions in the action list will be executed for any given object.

Syntax

struct PDColorConvertActionEx {
ASSize_t mSize;
The size (in bytes) of this structure.
PDColorConvertObjectAttributes mMatchAttributesAll;
The object attributes. The flags must all match for a match.
PDColorConvertObjectAttributes mMatchAttributesAny;
The object attributes. The flags will allow any match.
PDColorConvertSpaceType mMatchSpaceTypeAll;
The type of color space. The flags must all match for a match.
PDColorConvertSpaceType mMatchSpaceTypeAny;
The type of color space. The flags will allow any match.
AC_RenderIntent mMatchIntent;
The rendering intent of the object. If this is AC_UseProfileIntent, this action applies to any intent.
double mMatchMinFontSize, mMatchMaxFontSize;
The font size to match for text objects.
Defines the action, specifying what to do when an object matches this record.
AC_RenderIntent mConvertIntent;
If converting, use this intent to override the object's intent for performing color conversion. AC_UseProfileIntent means that the intent of the object must not be overridden.
AC_Profile mConvertProfile;
The target profile for the conversion. If the output intent is embedded, this should be the output intent profile.
ASBool mEmbed;
If true, embed the target profile. If false, the resulting color is Device, if possible.
ASBool mPreserveBlack;
If true, perform a black-preserving transform when converting.
ASBool mPromoteGrayToCMYK;
If true, promote DeviceGray objects to DeviceCMYK with K = 1.0- gray value.
ASBool mUseBlackPointCompensation;
If true, turn on black point compensation for color conversions.
ASAtom mColorantName;
For ink actions (which describe a single colorant, whether used in Separation or DeviceN, and which are not matched using the above matching fields) this describes the colorant of the ink.
ASAtom mAlias;
Ink alias; this only applies to ink actions.
ASBool mIsProcessColor;
true if this ink is a process ink.
ASBool mPreserveCMYKPrimaries;
If true, use a primary-preserving CMYK to CMYK transform.
void *mInternal;
For internal use.
} PDColorConvertActionRecEx, *PDColorConvertActionEx;

Used In

PDColorConvertParams

Header: AcroColorExpT.h:1453

Description

The list of actions in PDColorConvertParams is analogous to the list of filters in most email clients: each object is compared against the selection criteria for each of the actions, in order, until a matching action is found. The action is then executed on the object. Note that actions do not chain, except in the case of aliased ink definitions.

Syntax

struct PDColorConvertParams {
ASInt32 mNumActions;
The number of color conversion actions.
The actions, arranged sequentially in memory.
ASInt32 mNumInks;
The number of specific inks supplied.
The list of ink actions, arranged sequentially in memory.
AC_Profile defaultCMYK, defaultRGB, defaultGray;
AC_RenderIntent intentCMYK, intentRGB, intentGray;
} PDColorConvertParamsRec, *PDColorConvertParams;

Used By

PDColorConvertParamsEx

Header: AcroColorExpT.h:1557

Description

The list of actions in PDColorConvertParams is analogous to the list of filters in most email clients: each object is compared against the selection criteria for each of the actions, in order, until a matching action is found. The action is then executed on the object. Note that actions do not chain, except in the case of aliased ink definitions. This is the Extended structure, which supports additional elements in the PDColorConvertActionRecEx action.

Syntax

struct PDColorConvertParamsEx {
ASSize_t mSize;
The size of this data structure.
ASInt32 mNumActions;
The number of color conversion actions.
The actions, arranged sequentially in memory.
ASInt32 mNumInks;
The number of specific inks supplied.
The list of ink actions, arranged sequentially in memory.
AC_Profile defaultCMYK, defaultRGB, defaultGray;
AC_RenderIntent intentCMYK, intentRGB, intentGray;
ASBool allowLossyCompression;
Whether to use DCT or JPX encoding for Images, or replace them with FlateDecode. * if false, use Lossless compression (Flate), which may result in a larger size; * if true, use Lossy compression (JPG or JPX) resulting in a smaller size. *
ASBool minimalImageCompression;
* * Reserved for Internal Use.
ASBool ignoreDeviceToDeviceImages;
* * Reserved for Internal Use.
ASBool disableInitialDocumentIndexing;
Whether the whole document is indexed during the initial conversion. This normally can help * performance when converting all the pages of a document. However for documents with many * pages, indexing can take a while to complete. * For one-off conversions of a single page of such large documents, setting this member to true will boost performance. * if false, the whole document is indexed first * if true, document indexing is skipped. *
} PDColorConvertParamsRecEx, *PDColorConvertParamsEx;

Used By

_t_ACCalCMYK

Header: AcroColorExpT.h:809

Description

A simple 16-patch calibrated CMYK color space specification.

The 16 AC_XYZColor values are the absolute XYZ values of all 16 CMYK ink combinations, including paper white. The illuminant is assumed to be D50.

The AC_ToneCurve values represent the dot gain curves for each ink. Each one maps from ink percentage to the dot area percentage.

Syntax

struct _t_ACCalCMYK {
Absolute XYZ value of a CMYK ink combination: paper white.
Absolute XYZ value of a CMYK ink combination: K.
Absolute XYZ value of a CMYK ink combination: C.
Absolute XYZ value of a CMYK ink combination: M.
Absolute XYZ value of a CMYK ink combination: Y.
Absolute XYZ value of a CMYK ink combination: CM.
Absolute XYZ value of a CMYK ink combination: CY.
Absolute XYZ value of a CMYK ink combination: CK.
Absolute XYZ value of a CMYK ink combination: MY.
Absolute XYZ value of a CMYK ink combination: MK.
Absolute XYZ value of a CMYK ink combination: YK.
Absolute XYZ value of a CMYK ink combination: CMY.
Absolute XYZ value of a CMYK ink combination: CMK.
Absolute XYZ value of a CMYK ink combination: CYK.
Absolute XYZ value of a CMYK ink combination: MYK.
Absolute XYZ value of a CMYK ink combination: CMYK.
Dot gain curve for the cyan ink.
Dot gain curve for the magenta ink.
Dot gain curve for the yellow ink.
Dot gain curve for the black ink.
double opticalGamma;
Adds a gamma curve to the output XYZ values, after the CLUT. This was used by old versions of Photoshop, and is now obsolete. It should always be set to 1.0.
AC_XYZColor white;
The absolute XYZ value of paper white. It should be a duplicate of the w entry.
AC_XYZColor black;
The absolute XYZ value of a legal (within total ink limits) four-color CMYK black. It is currently ignored.
} ACCalCMYK;

_t_ACCalGray

Header: AcroColorExpT.h:902

Description

A calibrated grayscale space specification.

Syntax

struct _t_ACCalGray {
double gamma;
Gamma value. Normal values are greater than or equal to 1.0.
AC_XYZColor white;
Absolute XYZ value of a monitor white point (illuminant). The Y-value should be equal to 1.0.
AC_XYZColor black;
Absolute XYZ value of a monitor black point.
} ACCalGray;

Used By

_t_ACCalLab

Header: AcroColorExpT.h:977

Description

A calibrated Lab color space specification. The usual min and max values for rangeA and rangeB are-128 and +127.

Syntax

struct _t_ACCalLab {
AC_XYZColor white;
Color space white point. The Y value should be equal to 1.0.
AC_XYZColor black;
Color space black point. It is currently ignored by ACE when creating profiles, and is always set to zero when extracting from profiles.
struct {
ASInt32 min;
The usual value is-128.
ASInt32 max;
The usual value +127.
} rangeA;
Range limits for the a * component. Values outside this range are clipped to this range.
struct {
ASInt32 min;
The usual value is-128.
ASInt32 max;
The usual value +127.
} rangeB;
Range limits for the b * component. Values outside this range are clipped to this range.
} ACCalLab;

Used By

_t_ACCalRGB

Header: AcroColorExpT.h:936

Description

A calibrated RGB space specification. The red, green, and blue members represent columns of the matrix used to convert between RGB values and XYZ values. Normally, red + green + blue should exactly equal white (even if the monitor black point is non-zero). This means that, unless the monitor black point is zero, these entries are not equal to the absolute XYZ values of the pure RGB components (due to non-zero offsets in the other two components). This interpretation of these entries is used to maximize compatibility with the PDF CalRGB color space, which is defined using a matrix (rather than component XYZ values). For more about CalRGB color spaces look at the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, page 146. You can find this document on the web store of the International Standards Organization (ISO).

Syntax

struct _t_ACCalRGB {
double redGamma;
Red gamma value for each component. Normal values are greater than or equal to 1.0.
double greenGamma;
Green gamma value for each component. Normal values are greater than or equal to 1.0.
double blueGamma;
Blue gamma value for each component. Normal values are greater than or equal to 1.0.
Red column of the matrix used to convert between RGB values and XYZ values.
AC_XYZColor green;
Green column of the matrix used to convert between RGB values and XYZ values.
Blue column of the matrix used to convert between RGB values and XYZ values.
AC_XYZColor white;
The absolute XYZ value of the monitor white point (illuminant). The Y-value shall be equal to 1.0. See the description of CalRGB Color Spaces in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.6.5.3, page 146.
AC_XYZColor black;
The absolute XYZ value of the monitor black point.
} ACCalRGB;

Used By

_t_ACToneCurve

Header: AcroColorExpT.h:792

Description

A tone curve value for use in a calibrated CMYK color space specification.

Syntax

struct _t_ACToneCurve {
ASUns32 bytesPerValue;
The number of bytes per value (1 or 2).
ASUns32 count;
Number of samples (often 256).
void *data;
A pointer to the samples.
} AC_ToneCurve;

Used In

_t_ACXYColor

Header: AcroColorExpT.h:784

Description

Floating-point xy chromaticity coordinate. These can be computed from XYZ colors using x = X / (X + Y + Z) and y = Y / (X + Y + Z).

Syntax

struct _t_ACXYColor {
double x;
double y;
} AC_XYColor;

_t_ACXYZColor

Header: AcroColorExpT.h:769

Description

Floating-point XYZ color. A pure black would be encoded as 0.0, 0.0, 0.0, while a D50-based pure white would be encoded as 0.9642, 1.0, 0.8249.

Syntax

struct _t_ACXYZColor {
double X;
X-component of a floating-point XYZ color.
double Y;
Y-component of a floating-point XYZ color.
double Z;
Z-component of a floating-point XYZ color.
} AC_XYZColor;

Used In

_t_AC_FileSpec

Header: AcroColorExpT.h:745

Description

Contains a platform-specific version of a file specification. This is an FSSpec on Mac OS, or a full path name on other platforms.

Syntax

struct _t_AC_FileSpec {
FSSpec spec;
On Mac OS, use an FSSpec.
char path [kACMaxPathLength];
Use a full path name when not using Mac OS.
} AC_FileSpec;

Used By

_t_AC_LabColor

Header: AcroColorExpT.h:891

Description

Floating-point Lab color. Pure white is encoded as 100.0, 0.0, 0.0. The usual a and b range is-128.0 to +127.0, but this structure supports any a and b range.

Related Methods

Syntax

struct _t_AC_LabColor {
double L;
double a;
double b;
} AC_LabColor;

acrocolor Functions

ACApplyTransform

Header: AcroColorProcs.h:743

Description

Applies a color conversion or gamut test transformation. It processes the number of colors specified by count, using the memory formats for the source and destination data specified in srcPacking and dstPacking. The source data and destination data can point to the same block of memory if the source and destination packing formats use the same number of bits per color.

Related Methods

Syntax

AC_Error ACApplyTransform(AC_Transform transform, const void *srcData, void *dstData, ASUns32 count, AC_PackingCode srcPacking, AC_PackingCode dstPacking /* options */);

Parameters

transform
The color conversion or tranformation to apply.
srcData
The source data to tranform.
dstData
The destination for the transformed data.
count
The number of colors to transform.
srcPacking
The packing type used in the source data.
dstPacking
The packing type to use in the destination data.

Returns

0 if successful, a non-zero error code otherwise.

ACEngineCount

Header: AcroColorProcs.h:41

Description

Gets the number of Color Management System/Color Management Module (CMS/CMM) choices available for the AcroColor engine (ACE).

Related Methods

ACEngineInfo ACSetEngine

Syntax

AC_Error ACEngineCount(ASUns32 *count);

Parameters

count
(Filled by the method) A pointer to the count value.

Returns

0 if successful, a non-zero error code otherwise.

ACEngineInfo

Header: AcroColorProcs.h:62

Description

Gets information for a CMS/CMM in the AcroColor engine (ACE) by index. The CMS and CMM identifiers specify an engine to the ACE. Engine names should only be used as the text for popup menus. It is better to store the identifiers in settings files (rather than names), because they are independent of localization.

Related Methods

ACEngineCount ACSetEngine

Syntax

AC_Error ACEngineInfo(ASUns32 index, AC_String *name, ASUns32 *cmsID, ASUns32 *cmmID);

Parameters

index
The zero-based index of the CMS/CMM. The highest legal value is AC_EngineCount- 1.
name
(Filled by the method) Optional. If it is not NULL, the parameter returns the name of the CMS/CMM.
cmsID
(Filled by the method) Returns the CMS identifier.
cmmID
(Filled by the method) Returns the CMM identifier.

Returns

0 if successful, a non-zero error code otherwise.

ACGetBlackPointCompensation

Header: AcroColorProcs.h:1144

Description

Get the black-point compensation flag.

Syntax

AC_Error ACGetBlackPointCompensation(ASUns32 *bpc);

Parameters

bpc
It will receive the flag value, flag value equal to 1 implies black-point compensation is on, value 0 otherwise.

Returns

0 if successful, a non-zero error code otherwise.

ACGetSettingsProfile

Header: AcroColorProcs.h:313

Description

    Gets the current color profile for a given key from the AcroColor engine (ACE) settings object.
  • If the settings file contains a profile entry with the specified key, that profile is returned.
  • If the settings file contains a special NULL entry with the key, a NULL profile is returned.
  • If the settings file contains a string with this key rather than an embedded profile, this method returns an installed profile whose description matches the string, if found.
  • In all other cases, AC_Error_MissingKey is returned.

The method does not check for known keys or legal key values. It is up to the client to write only legal key values, and to verify key values when reading.

Syntax

AC_Error ACGetSettingsProfile(AC_Settings settings, AC_SettingsKey key, AC_Profile *profile);

Parameters

settings
The settings object from which the profile is obtained.
key
The value key constant.
profile
(Filled by the method) A pointer to the current color profile value of the given key.

Returns

0 if successful, a non-zero error code otherwise.

ACGetSettingsString

Header: AcroColorProcs.h:394

Description

    Gets the current string value for a given key from the AcroColor engine (ACE) settings object.
  • If the settings file contains a string entry with the specified key, the method returns the entry.
  • If the settings file contains a special NULL entry with the key, the method returns a NULL string.
  • In all other cases, the method returns AC_Error_MissingKey.

Syntax

AC_Error ACGetSettingsString(AC_Settings settings, AC_SettingsKey key, AC_String *string);

Parameters

settings
The settings object from which the string is obtained.
key
The value key constant.
string
(Filled by the method) A pointer to the current string value of the given key.

Returns

0 if successful, a non-zero error code otherwise.

ACGetSettingsUnsigned32

Header: AcroColorProcs.h:416

Description

    Gets the current numeric value for a given key from the AcroColor engine (ACE) settings object.
  • If the settings file contains an unsigned 32-bit numeric entry with the specified key, the method returns the entry.
  • In all other cases, the method returns AC_Error_MissingKey.

Syntax

AC_Error ACGetSettingsUnsigned32(AC_Settings settings, AC_SettingsKey key, ASUns32 *value);

Parameters

settings
The settings object from which the value is obtained.
key
The value key constant.
value
(Filled by the method) A pointer to the current numeric value of the given key.

Returns

0 if successful, a non-zero error code otherwise.

ACGetWorkingSpaceProfile

Header: AcroColorProcs.h:904

Description

Gets a working color profile in a specified color space.

Syntax

AC_Error ACGetWorkingSpaceProfile(ACWorkingSpace space, AC_Profile *workingProfile);

Parameters

space
The type of color space of the profile to obtain.
workingProfile
(Filled by the method) A pointer to the working profile. When done with this object, dereference it using ACUnReferenceProfile().

Returns

0 if successful, a non-zero error code otherwise.

ACLoadSettings

Header: AcroColorProcs.h:360

Description

[DEPRECATED] Loads the AcroColor engine (ACE) settings from a file.

This method reads the settings entries from the specified file and stores them in the settings object, including entries with unknown keys or data formats. As a general rule, the client should keep the settings object around so these unknown keys are preserved when the settings are saved out. The only time the client should start with a fresh settings object is when performing another settings load.

Syntax

AC_Error ACLoadSettings(AC_Settings settings, AC_FileSpec *file);

Parameters

settings
(Filled by the method) The settings object.
file
A pointer to the file specification for the file containing the settings.

Returns

0 if successful, a non-zero error code otherwise.

ACLoadSettingsU

Header: AcroColorProcs.h:1121

Description

Reads the settings entries from the specified file. All entries are stored in the settings object, even entries with unknown keys or data formats. As a general rule, the client should keep the settings object around so these unknown keys are preserved when the settings are saved out. The only time the client should start with a fresh settings object is when performing another settings load.

Related Methods

Syntax

AC_Error ACLoadSettingsU(AC_Settings settings, AC_String file);

ACMakeBufferProfile

Header: AcroColorProcs.h:557

Description

Creates a device color profile object from a data buffer containing the raw ICC profile data. The method copies the data, so the client can dispose of the source data. The client should call ACUnReferenceProfile() when done with the profile.

Syntax

AC_Error ACMakeBufferProfile(AC_Profile *profile, void *data, ASUns32 dataSize);

Parameters

profile
(Filled by the method) The device profile.
data
The buffer containing the device profile data.
dataSize
The size in bytes of the data buffer.

Returns

0 if successful, a non-zero error code otherwise.

ACMakeCalGray

Header: AcroColorProcs.h:610

Description

Creates a device color profile object from a calibrated grayscale color space with the specified rendering intent and description string. The client should call ACUnReferenceProfile() when done with the profile.

Syntax

AC_Error ACMakeCalGray(AC_Profile *profile, ACCalGray *spec, AC_RenderIntent intent, AC_String description);

Parameters

profile
(Filled by the method) A pointer to the new device color profile.
spec
A pointer to the calibrated grayscale color space specification.
intent
The rendering intent.
description
The description of the new profile. If it is non- NULL, it must contain ASCII data, and may contain Unicode data also. If NULL, a hard-coded default description is used.

Returns

0 if successful, a non-zero error code otherwise.

ACMakeCalLab

Header: AcroColorProcs.h:639

Description

Creates a device color profile object from a calibrated Lab color space with the specified rendering intent and description string. The client should call ACUnReferenceProfile() when done with the profile.

Syntax

AC_Error ACMakeCalLab(AC_Profile *profile, ACCalLab *spec, AC_RenderIntent intent, AC_String description);

Parameters

profile
(Filled by the method) A pointer to the new device color profile.
spec
The calibrated Lab color space specification.
intent
The rendering intent.
description
The description of the new profile. If it is non- NULL, it must contain ASCII data, and may contain Unicode data also. If it is NULL, a hard-coded default description is used.

Returns

0 if successful, a non-zero error code otherwise.

ACMakeCalRGB

Header: AcroColorProcs.h:583

Description

Creates a device color profile object from a calibrated RGB color space, with the specified rendering intent and descriptive string. The client should call ACUnReferenceProfile() when done with the profile.

Syntax

AC_Error ACMakeCalRGB(AC_Profile *profile, ACCalRGB *spec, AC_RenderIntent intent, AC_String description);

Parameters

profile
(Filled by the method) A pointer to the new device color profile.
spec
The calibrated RGB color space specification.
intent
The rendering intent.
description
The description of the new profile. If it is non- NULL, the description must contain ASCII data, and may contain Unicode data also. If it is NULL, a hard-coded default description is used.

Returns

0 if successful, a non-zero error code otherwise.

ACMakeColorTransform

Header: AcroColorProcs.h:718

Description

Creates a color transformation object.

The client can dispose of the source and destination profiles as soon as the transform is created. If the source profile is a device link or abstract profile, then the destination profile must be NULL; otherwise it must be non- NULL.

Syntax

AC_Error ACMakeColorTransform(AC_Transform *transform, AC_Profile srcProfile, AC_Profile dstProfile, AC_RenderIntent intent /* options */);

Parameters

transform
(Filled by the method) A pointer to the new color transformation object.
srcProfile
The source profile from which to transform color data.
dstProfile
The destination profile to which to transform color data.
intent
The rendering intent for colors outside the gamut of the destination profile.

Returns

0 if successful, a non-zero error code otherwise.

ACMakePresetList

Header: AcroColorProcs.h:193

Description

Creates a list of preset AcroColor engine (ACE) settings of the specified type. Clients should call ACUnReferencePresetList() when done with the preset list.

A preset list is a list of predefined color settings that specifies the source and destination working color profiles to be used for color conversion.

Syntax

AC_Error ACMakePresetList(AC_PresetList *list, AC_SettingsType type);

Parameters

list
(Filled by the method) A pointer to the new preset list object.
type
The settings type (AC_SettingsType_Color or AC_SettingsType_Proof).

Returns

0 if successful, a non-zero error code otherwise.

ACMakeProfileList

Header: AcroColorProcs.h:109

Description

Creates a list of device color profiles of a given type.

Builds a list of those profiles from the database that meet the criterion of the specified selector. If the profile database has never been built, it will be automatically built without a progress callback. Clients should call ACUnReferenceProfileList() when done with the profile list.

Syntax

AC_Error ACMakeProfileList(AC_ProfileList *list, AC_SelectorCode selector);

Parameters

list
(Filled by the method) A pointer to the new profile list object.
selector
The code for the type of device profile to include in the list.

Returns

0 if successful, a non-zero error code otherwise.

ACMakeSettings

Header: AcroColorProcs.h:329

Description

Creates an AcroColor engine (ACE) settings object of a given type, with no entries. When done with all operations, call ACUnReferenceSettings() to free the settings object.

Syntax

AC_Error ACMakeSettings(AC_Settings *settings, AC_SettingsType type);

Parameters

settings
(Filled by the method) A pointer to the new settings object.
type
The settings type (AC_SettingsType_Color or AC_SettingsType_Proof).

Returns

0 if successful, a non-zero error code otherwise.

ACMakeString

Header: AcroColorProcs.h:789

Description

Creates an AcroColor string from a NULL-terminated ASCII string or a NULL-terminated Unicode string, or both. If both ASCII and Unicode data are specified, the AC_String object keeps track of both in parallel, returning the ASCII data when asked for ASCII, and the Unicode data when asked for Unicode.

These dual-encoded strings are useful as description strings for ICC profiles, which can store both ASCII and Unicode data in their description tags. The ICC profile standard requires that the ASCII version of the description string be limited to 7-bit ASCII characters. The AcroColor engine requires only the Unicode descriptions to be unique among profile descriptions.

Syntax

AC_Error ACMakeString(AC_String *string, const char *ascii, const ASUTF16Val *unicode);

Parameters

string
(Filled by the method) A pointer to the new string object.
ascii
The ASCII data. It should be limited to 7-bit ASCII characters for use in profile descriptions.
unicode
The Unicode data. All Unicode characters are two byte characters, in native byte order, including the trailing NULL.

Returns

0 if successful, a non-zero error code otherwise.

ACMonitorProfile

Header: AcroColorProcs.h:525

Description

Gets a device color profile for a specific monitor device. The returned profile may be either RGB or grayscale. If no profile is specified by the system, the method returns a default platform profile (sRGB on Windows). The client should call ACUnReferenceProfile() when done with the returned profile.

Syntax

AC_Error ACMonitorProfile(AC_Profile *profile, void *monitorID);

Parameters

profile
(Filled by the method) A pointer to the profile object.
monitorID
A pointer to the platform-specific monitor device identifier. On Windows, this is a NULL-terminated ASCII string containing the monitor's device name (for example, "Display")

Returns

0 if successful, a non-zero error code otherwise.

ACMonitorProfileN

Header: AcroColorProcs.h:1122

Syntax

AC_Error ACMonitorProfileN(AC_Profile *profile, void *monitorID);

ACPresetFileToName

Header: AcroColorProcs.h:264

Description

    [DEPRECATED] Translates a preset settings file specification to a name ready to be displayed in menus (with directory paths and file extensions removed). The client should call ACUnReferenceString() when done with the name.
  • If the file contains an internal name tag, the returned string is created from the internal name.
  • If the file does not contain an internal name tag, the returned string is built from the file name. In this case, the method assumes that the file name and the ASCII data of the returned string are in the local script code.

Syntax

AC_Error ACPresetFileToName(const AC_FileSpec *file, AC_String *name);

Parameters

file
A pointer to the preset file specification.
name
(Filled by the method) A pointer to the display name string.

Returns

0 if successful, a non-zero error code otherwise.

ACPresetListCount

Header: AcroColorProcs.h:207

Description

Gets the number of predefined color settings, as listed in the color management settings in the Acrobat user interface.

Syntax

AC_Error ACPresetListCount(AC_PresetList list, ASUns32 *count);

Parameters

list
The preset list object.
count
(Filled by the method) A pointer to the number of settings in the list.

Returns

0 if successful, a non-zero error code otherwise.

ACPresetListItemFile

Header: AcroColorProcs.h:230

Description

[DEPRECATED] Gets the file specification for a preset settings item in a preset list.

Syntax

AC_Error ACPresetListItemFile(AC_PresetList list, ASUns32 index, AC_FileSpec *file);

Parameters

list
The preset list object.
index
The item index in the list.
file
(Filled by the method) A pointer to the file specification for the item.

Returns

0 if successful, a non-zero error code otherwise.

ACPresetListItemFileAndNameU

Header: AcroColorProcs.h:1108

Description

Returns the file specification and a display name of a specified preset in a list. The client should call ACE_UnReferenceString when done with the file and name. Either the file or name parameter can be NULL if the client does not need that value returned. It is an error if both parameters are NULL. Note: If the preset file contains an internal name tag, the returned string is created from the internal name. If the preset file does not contain an internal name tag, the returned string is built from the file name. Any leading path or trailing extension will be removed from the string.

Syntax

AC_Error ACPresetListItemFileAndNameU(AC_PresetList list, ASUns32 index, AC_String *file, AC_String *name);

ACProfileColorSpace

Header: AcroColorProcs.h:650

Description

Gets the color space for a device profile.

Syntax

AC_Error ACProfileColorSpace(AC_Profile profile, AC_ColorSpace *space);

Parameters

profile
The device color profile.
space
(Filled by the method) A pointer to the color space.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileData

Header: AcroColorProcs.h:675

Description

Gets the data for a device profile. Copies the raw ICC profile data into a supplied buffer.

Syntax

AC_Error ACProfileData(AC_Profile profile, void *data);

Parameters

profile
The device color profile.
data
(Filled by the method) A pointer to the color profile data.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileDescription

Header: AcroColorProcs.h:443

Description

Gets the description of a device profile. The returned description string contains both ASCII and Unicode data, even if the profile itself only contains ASCII data.

Syntax

AC_Error ACProfileDescription(AC_Profile profile, AC_String *description);

Parameters

profile
The device color profile.
description
(Filled by the method) A pointer to the description string.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileFromCode

Header: AcroColorProcs.h:496

Description

Creates a device profile from a device profile type code. The client should call ACUnReferenceProfile() when done with the profile.

Syntax

AC_Error ACProfileFromCode(AC_Profile *profile, AC_ProfileCode code);

Parameters

profile
(Filled by the method) A pointer to the device color profile object.
code
The profile type code.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileFromDescription

Header: AcroColorProcs.h:475

Description

    Finds a profile matching the description string in the database. The client should call ACUnReferenceProfile() when done with the profile.
  • If the description string contains Unicode text, the Unicode text is used to find the profile.
  • If the description string contains only ASCII text, the method tries to find a match. However, the AcroColor engine requires only Unicode descriptions to be unique, so this might return the wrong profile is in some rare cases. Use ASCII-only description strings only when Unicode description string are unavailable.

Syntax

AC_Error ACProfileFromDescription(AC_Profile *profile, AC_String description);

Parameters

profile
(Filled by the method) A pointer to the device color profile object.
description
The description string.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileListCount

Header: AcroColorProcs.h:123

Description

Gets the number of profiles in a device color profile list.

Syntax

AC_Error ACProfileListCount(AC_ProfileList list, ASUns32 *count);

Parameters

list
The profile list.
count
(Filled by the method) A pointer to the number of profiles in the list.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileListItemCode

Header: AcroColorProcs.h:164

Description

Gets the profile code of a specified profile in a profile list.

While this routine is not absolutely required, since the description string is always a unique reference, profile codes have the advantage that they are localization-independent.

Syntax

AC_Error ACProfileListItemCode(AC_ProfileList list, ASUns32 index, AC_ProfileCode *code);

Parameters

list
The profile list.
index
The index for the profile in the list.
code
(Filled by the method) A pointer to the profile code. If the specified profile does not have a code, this method returns AC_Profile_Null.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileListItemDescription

Header: AcroColorProcs.h:145

Description

Returns the description string of a specified profile in a list. The returned description string always contains both ASCII and Unicode data, even if the profile itself only contains an ASCII version. You can store only the Unicode data in settings files if you wish; the ACProfileFromDescription() method finds the correct profile when passed the Unicode-only string.

Syntax

AC_Error ACProfileListItemDescription(AC_ProfileList list, ASUns32 index, AC_String *description);

Parameters

list
The profile list.
index
The index for the profile in the list.
description
(Filled by the method) A pointer to the profile description string.

Returns

0 if successful, a non-zero error code otherwise.

ACProfileSize

Header: AcroColorProcs.h:661

Description

Gets the size in bytes of the raw ICC profile data in a device profile.

Related Methods

Syntax

AC_Error ACProfileSize(AC_Profile profile, ASUns32 *size);

Parameters

profile
The device color profile object.
size
(Filled by the method) A pointer to the profile data size.

Returns

0 if successful, a non-zero error code otherwise.

ACProfilesMatch

Header: AcroColorProcs.h:925

Description

Compares the working device profile with the document device profile to determine if they are the same. This comparison ignores rendering intents, and is fuzzy, allowing very close, but not exactly the same, profiles to match. Equivalent profiles always match, but some non-equivalent profiles may also match.

Syntax

AC_Error ACProfilesMatch(AC_Profile workingProfile, AC_Profile documentProfile, ASBool *match);

Parameters

workingProfile
The working device color profile.
documentProfile
The document's device color profile.
match
(Filled by the method) A pointer to the result: true if the profiles match, false otherwise.

Returns

0 if successful, a non-zero error code otherwise.

ACSetBlackPointCompensation

Header: AcroColorProcs.h:1156

Description

Sets the black-point compensation flag, which controls whether to adjust for differences in black points when converting colors between color spaces. When enabled, the full dynamic range of the source space is mapped into the full dynamic range of the destination space. When disabled, the dynamic range of the source space is simulated in the destination space (which can result in blocked or gray shadows).

Syntax

AC_Error ACSetBlackPointCompensation(ASUns32 bpc);

Parameters

bpc
1 to enable black-point compensation, 0 otherwise.

Returns

0 if successful, a non-zero error code otherwise.

ACSetEngine

Header: AcroColorProcs.h:87

Description

Sets the AcroColor engine (ACE) for the system, changing the global default CMS/CMM choice.

This method rebuilds all existing transforms using the new engine.

If the user aborts the process, or if the ACE runs out of resources during the rebuilding process, an error code is returned and some existing transforms may still use the previous engine choice. Everything will still work, since multiple engines can be used at once. Call the method again to restart the transform rebuilding process.

Related Methods

ACEngineCount ACEngineInfo

Syntax

AC_Error ACSetEngine(ASUns32 cmsID, ASUns32 cmmID);

Parameters

cmsID
The Color Management System identifier for the new engine default, as returned by ACEngineInfo().
cmmID
The Color Management Module identifier for the new engine default, as returned by ACEngineInfo().

Returns

0 if successful, a non-zero error code otherwise.

ACStringASCII

Header: AcroColorProcs.h:823

Description

Copies the ASCII version of a string into a supplied buffer. Either the buffer or the count can be NULL.

The ICC profile standard requires that ASCII version of the profile description string be limited to 7-bit ASCII characters.

Depending on the API, operating system, file contents, and so on, the method can return strings in the local script code (8 bit single byte or 8 bit encoded multi-byte). Clients should always assume that the ASCII data is in the local script code (of which the 7-bit ASCII characters are a subset).

Syntax

AC_Error ACStringASCII(AC_String string, char *buffer, ASUns32 *count, ASUns32 maxCount);

Parameters

string
The AcroColor string containing ASCII data. If the string does not contain an ASCII version, the method returns AC_Error_NoASCII.
buffer
(Filled by the method) A buffer to contain a copy of the ASCII data.
count
(Filled by the method) A pointer to the size of buffer in bytes, including the trailing NULL character.
maxCount
The maximum size of buffer in bytes. If the length of the string is longer than this value, the method copies a truncated string to the buffer and returns AC_Error_StringOverflow.

Returns

0 if successful, a non-zero error code otherwise.

ACStringLocalized

Header: AcroColorProcs.h:857

Description

Copies the localized Unicode version of a string into a supplied buffer. Either the buffer or the count can be NULL.

The settings file format and ICC profiles later than version 2 can contain text in multiple languages or countries. When the AcroColor engine (ACE) create strings from these files or profiles, it uses the current language and country codes to create strings with a third fork: a localized Unicode version. These localized versions are intended for user display only and should not be stored in preferences files or action scripts, since they vary from country to country and are not portable.

Syntax

AC_Error ACStringLocalized(AC_String string, ASUTF16Val *buffer, ASUns32 *count, ASUns32 maxCount);

Parameters

string
The AcroColor string containing localized Unicode data. If the string does not contain a localized Unicode version, the method returns AC_Error_NoLocalized.
buffer
(Filled by the method) A buffer to contain a copy of the localized Unicode data.
count
(Filled by the method) A pointer to the size (in bytes) of the buffer, including the trailing NULL character.
maxCount
The maximum size of the buffer in bytes. If the length of the string is longer than this value, the method copies a truncated string to the buffer and returns AC_Error_StringOverflow.

Returns

0 if successful, a non-zero error code otherwise.

ACStringUnicode

Header: AcroColorProcs.h:880

Description

Copies the Unicode version of a string into a supplied buffer. Either the buffer or the count can be NULL.

Syntax

AC_Error ACStringUnicode(AC_String string, ASUTF16Val *buffer, ASUns32 *count, ASUns32 maxCount);

Parameters

string
The AcroColor string containing localized Unicode data. If the string does not contain a Unicode version, the method returns AC_Error_NoUnicode.
buffer
(Filled by the method) A buffer to contain a copy of the Unicode data.
count
(Filled by the method) A pointer to the size of buffer in bytes, including the trailing NULL character.
maxCount
The maximum size of buffer in bytes. If the length of the string is longer than this value, the method copies a truncated string to the buffer and returns AC_Error_StringOverflow.

Returns

0 if successful, a non-zero error code otherwise.

ACSwatchBookColorSpace

Header: AcroColorProcs.h:1070

Description

Retrieves the color space of the swatches in the swatchbook.

Syntax

AC_ColorSpace ACSwatchBookColorSpace(ACSwatchBook bp);

Parameters

dbp
A pointer to the swatchbook object.

Returns

The color space of the swatchbook object (for example, all swatches are in this space).

ACSwatchBookCount

Header: AcroColorProcs.h:1011

Description

Retrieves the number of swatchbooks available in the swatchbook database that was returned by ACSwatchBookFind().

Syntax

ASUns32 ACSwatchBookCount(ACSwatchBookDB dbp);

Parameters

dbp
A pointer to the swatchbook database object.

Returns

The number of swatchbooks in the database.

ACSwatchBookDBDestroy

Header: AcroColorProcs.h:1033

Description

Destroys the swatchbook database and frees any memory associated with it.

Syntax

void ACSwatchBookDBDestroy(ACSwatchBookDB dbp);

Parameters

dbp
A pointer to the swatchbook database object to be destroyed.

ACSwatchBookDescription

Header: AcroColorProcs.h:1027

Description

Retrieves the description string for a swatchbook.

Syntax

ASText ACSwatchBookDescription(ACSwatchBookDB dbp, ASUns32 ix);

Parameters

dbp
A pointer to the swatchbook database object.
ix
The index of the swatchbook item. Its value is in the range [0, swatchBookCount-1].

Returns

The description string for the swatchbook.

ACSwatchBookDestroy

Header: AcroColorProcs.h:1056

Description

Destroys the swatchbook and frees any memory associated with it.

Syntax

void ACSwatchBookDestroy(ACSwatchBook bp);

Parameters

dbp
A pointer to the swatchbook object to be destroyed.

ACSwatchBookGetSwatchName

Header: AcroColorProcs.h:1085

Description

Retrieves the name of a color swatch.

Syntax

ASText ACSwatchBookGetSwatchName(ACSwatchBook bp, ASUns32 ix);

Parameters

dbp
A pointer to the swatchbook object.
ix
The index of the swatch. Its value is in the range [0, swatchCount-1].

Returns

The name of the color swatch.

ACSwatchBookGetSwatchValues

Header: AcroColorProcs.h:1093

Description

Retrieves the color values associated with a color swatch.

Syntax

void ACSwatchBookGetSwatchValues(ACSwatchBook bp, ASUns32 ix, float *values);

Parameters

dbp
A pointer to the swatchbook object.
ix
The index of the swatch. Its value is in the range [0, swatchCount-1].
values
Values that are filled in by this call.

ACSwatchBookIsProcess

Header: AcroColorProcs.h:1077

Description

Determines whether the swatchbook is for a process color mode.

Syntax

ASBool ACSwatchBookIsProcess(ACSwatchBook bp);

Parameters

dbp
A pointer to the swatchbook object.

Returns

true if the swatchbook is for a process color mode, false if it is for spot.

ACSwatchBookLoad

Header: AcroColorProcs.h:1042

Description

Retrieves an opaque ACSwatchBook object for the nth swatchbook. This loads the swatchbook into memory. Zero will be returned if there was an error.

Syntax

ACSwatchBook ACSwatchBookLoad(ACSwatchBookDB dbp, ASUns32 ix);

Parameters

dbp
The swatchbook database.
n
The index of swatchbook to load. Its value is in the range [0, swatchBookCount-1].

Returns

The swatchbook object. Call ACSwatchBookDestroy() when it is no longer needed.

ACSwatchBookLoadFromPath

Header: AcroColorProcs.h:1050

Description

Retrieves an opaque ACSwatchBook object using the specified path. This loads the swatchbook into memory. Zero will be returned if there was an error.

Syntax

ACSwatchBook ACSwatchBookLoadFromPath(ACSwatchBookDB dbp, ASPathName path);

Parameters

dbp
The swatchbook database.
path
The path to the swatchbook file.

Returns

The swatchbook object. Call ACSwatchBookDestroy() when it is no longer needed.

ACSwatchBookNumberOfColors

Header: AcroColorProcs.h:1063

Description

Retrieves the number of color swatches in the swatchbook.

Syntax

ASUns32 ACSwatchBookNumberOfColors(ACSwatchBook bp);

Parameters

dbp
A pointer to the swatchbook object.

Returns

The number of swatches in the swatchbook.

ACSwatchBookTitle

Header: AcroColorProcs.h:1019

Description

Retrieves the title of a swatchbook.

Syntax

ASText ACSwatchBookTitle(ACSwatchBookDB dbp, ASUns32 ix);

Parameters

dbp
A pointer to the swatchbook database object.
ix
The index of the swatchbook item. Its value is in the range [0, swatchBookCount-1].

Returns

The title of the swatchbook.

ACSwatchBooksFind

Header: AcroColorProcs.h:1004

Description

Retrieves an ACSwatchBookDB database object, containing the swatchbooks found by searching the folders given. The folders are usually determined by using the AVAcquireSpecialFolderPathName. This always scans the swatchbook directories, so this should be called every time one is going to make a list of the swatchbooks, in case a user installed a swatchbook in the user directory while the application was open. PDF library clients must pass in whatever folder location is appropriate.

Syntax

ACSwatchBookDB ACSwatchBooksFind(ASUns32 count, ASFileSys fs, ASPathName *folders);

Parameters

count
The number of folders in the folders array.
folders
A pointer to an array of path names for the folders to search.

Returns

A swatchbook database object. Call ACSwatchBookDBDestroy() when this is no longer needed.

ACUnReferencePresetList

Header: AcroColorProcs.h:282

Description

Decrements the reference count of a preset list object. If this causes the object's reference count to reach zero, the method deletes it.

Related Methods

Syntax

AC_Error ACUnReferencePresetList(AC_PresetList list);

Parameters

list
The preset list object.

Returns

0 if successful, a non-zero error code otherwise.

ACUnReferenceProfile

Header: AcroColorProcs.h:695

Description

Decrements the reference count of a device color profile object. If this causes the object's reference count to reach zero, the method deletes it.

Syntax

AC_Error ACUnReferenceProfile(AC_Profile profile);

Parameters

profile
The profile object.

Returns

0 if successful, a non-zero error code otherwise.

ACUnReferenceProfileList

Header: AcroColorProcs.h:174

Description

Decrements the reference count of a device color profile list object. If this causes the object's reference count to reach zero, the method deletes it.

Related Methods

Syntax

AC_Error ACUnReferenceProfileList(AC_ProfileList list);

Parameters

list
The profile list object.

Returns

0 if successful, a non-zero error code otherwise.

ACUnReferenceSettings

Header: AcroColorProcs.h:427

Description

Decrements the reference count of an AcroColor engine settings object. If this causes the object's reference count to reach zero, the method deletes it.

Related Methods

Syntax

AC_Error ACUnReferenceSettings(AC_Settings settings);

Parameters

settings
The settings object.

Returns

0 if successful, a non-zero error code otherwise.

ACUnReferenceString

Header: AcroColorProcs.h:890

Description

Decrements the reference count of a string object. If this causes the object's reference count to reach zero, the method deletes it.

Related Methods

Syntax

AC_Error ACUnReferenceString(AC_String string);

Parameters

string
The string object.

Returns

0 if successful, a non-zero error code otherwise.

ACUnReferenceTransform

Header: AcroColorProcs.h:755

Description

Decrements the reference count of a color transformation object. If this causes the object's reference count to reach zero, the method deletes it.

Related Methods

Syntax

AC_Error ACUnReferenceTransform(AC_Transform transform);

Parameters

transform
The tranform object.

Returns

0 if successful, a non-zero error code otherwise.

PDColorConvertPDEElement

Header: AcroColorProcs.h:989

Description

Converts a PDEElement to the supplied color space.

Syntax

PDEElement PDColorConvertPDEElement(PDDoc doc, PDEElement elem, AC_Profile targetProfile, AC_RenderIntent intent, ASBool embed);

Parameters

doc
The document in which the element is located.
elem
The element to convert.
targetProfile
The ICC profile to which the color should be converted.
intent
The rendering intent to use for the conversion. AC_UseProfileIntent can be passed in order to use the default intent. (Note that it is not actually using the profile intent, but is using the current intent in the PDF graphics state).
embed
If true, embed the color space and make the object calibrated. If it is false and the target profile is CMYK, RGB, or Gray, the colors space of the resulting object, after conversion, will be DeviceCMYK, DeviceRGB, or DeviceGray, respectively.

Returns

A PDEElement containing the converted data. Note that the source element is copied and its reference count is not decremented, so the caller should decrement the source element's reference count if it is no longer needed.

PDColorConvertPDEElementEx

Header: AcroColorProcs.h:1136

Description

Converts a PDEElement to the supplied color space.

Related Methods

Syntax

PDEElement PDColorConvertPDEElementEx(PDDoc doc, PDEElement elem, PDColorConvertParamsEx params);

Parameters

doc
The document in which the element is located.
elem
The element to convert.
params
The parameters block that describes how color conversions are to be performed.

Returns

A PDEElement containing the converted data. Note that the source element is copied and its reference count is not decremented, so the caller should decrement the source element's reference count if it is no longer needed.

PDColorConvertPDEElementEx2

Header: AcroColorProcs.h:1194

Description

Converts a PDEElement to the supplied color space.

Related Methods

Syntax

PDEElement PDColorConvertPDEElementEx2(PDDoc doc, PDEElement elem, PDColorConvertParamsEx params, ASInt32 pageNum);

Parameters

doc
The document in which the element is located.
elem
The element to convert.
params
The parameters block that describes how color conversions are to be performed.
pageNum
The page on which the element is present.

Returns

A PDEElement containing the converted data. Note that the source element is copied and its reference count is not decremented, so the caller should decrement the source element's reference count if it is no longer needed.

PDDocColorConvertEmbedOutputIntent

Header: AcroColorProcs.h:969

Description

Embeds an output intent into a document.

Syntax

void PDDocColorConvertEmbedOutputIntent(PDDoc doc, AC_Profile OIProfile);

Parameters

doc
The document in which to embed the output intent.
params
The parameters block from which to get the output intent, described as the target space.

PDDocColorConvertEmbedOutputIntentEx

Header: AcroColorProcs.h:1167

Description

Embeds an output intent into a document.

Syntax

void PDDocColorConvertEmbedOutputIntentEx(PDDoc doc, AC_Profile OIProfile, ASAtom subtype);

Parameters

doc
The document in which to embed the output intent.
OIProfile
The parameter from which to get the output intent, described as the target space.
subtype
The ASAtom for the name of output intent subtype created. The subtype must be one of the following: GTS_PDFX, GTS_PDFA1, or ISO_PDFE1.

PDDocColorConvertPage

Header: AcroColorProcs.h:940

Description

Converts the colors (in place) on a page, as specified by the params block.

Syntax

ASBool PDDocColorConvertPage(PDDoc doc, PDColorConvertParams params, ASInt32 pageNum, ASProgressMonitor progMon, void *progMonData, PDColorConvertReportProc reportProc, void *reportProcData, ASBool *changed);

Parameters

doc
The document in which to convert a page.
params
The parameter block that describes how color conversions are to be performed.
pageNum
The page number of the page to convert.
progMon
The progress monitor callback. This call will set the duration of the monitor to the number of elements in the top-level content stream, and will update the value as the elements are converted. If this parameter is zero, no progress monitor callback is called.
progMonData
The data element to be passed into progress monitor calls.
reportProc
The reporting callback; it reports the attributes and action of each object converted to the callback. Passing in a zero reporting callback means that no reporting will be done.
reportProcData
The data element to be passed into reportProc.

Returns

true if the conversion was aborted or failed.

Exceptions

asGenErrBadParm
The params block is malformed (for example, a reference or alias to a non-existent ink, or a circular alias).

PDDocColorConvertPageEx

Header: AcroColorProcs.h:958

Description

Convert the colors (in place) in a page as specified by the params block. Takes an extended parameters block.

Syntax

ASBool PDDocColorConvertPageEx(PDDoc doc, PDColorConvertParamsEx paramsEx, ASInt32 pageNum, ASProgressMonitor progMon, void *progMonData, PDColorConvertReportProc reportProc, void *reportProcData, ASBool *changed);

Parameters

doc
The document in which to convert a page.
params
The parameters block that describes how color conversions are to be performed.
pageNum
The page number of the page to convert.
progMon
The progress monitor callback. This call will set the duration of the monitor to the number of elements in the top-level content stream, and will update the value as the elements are converted. If this parameter is zero, no progress monitor callback is called.
progMonData
The data element to be passed into progress monitor calls.
reportProc
The reporting callback; it reports the attributes and action of each object converted to the callback. Passing in a zero reporting callback means that no reporting will be done.
reportProcData
The data element to be passed into reportProc.

Returns

true if the conversion was aborted or failed.

Exceptions

asGenErrBadParm
The params block is ill-formed (for example, a reference or alias to a non-existent ink, or a circular alias).

PDPageColorConvertEmbedOutputIntent

Header: AcroColorProcs.h:1179

Description

Embeds an output intent into specified page.

Syntax

void PDPageColorConvertEmbedOutputIntent(PDPage page, AC_Profile OIProfile, ASAtom subtype);

Parameters

page
The page in which to embed the output intent.
OIProfile
The parameter from which to get the output intent, described as the target space.
subtype
The ASAtom for the name of output intent subtype created. The subtype must be one of the following: GTS_PDFX, GTS_PDFA1, or ISO_PDFE1.