| Layer | Acrobat_Color_Layer |
| Object | Acrobat_Color |
AcroColor is an HFT that allows you to access the AcroColor engine (ACE), which controls color profile management for Adobe Acrobat. Plug-ins can import the AcroColor HFT to use the color management methods.
While not, strictly speaking, an extended API (since the API is not exposed from a plug-in) the AcroColor API is included here with the extended APIs since it does not fit into the layered structure of the Acrobat core API. The AcroColor APIs, unlike the other extended APIs, can be used by the PDF Library.
The AcroColor HFT encapsulates color management into a set of convenient objects and functions. The objects represent basic color-management entities:
You can create an ICC color profile from available data (ACMakeBufferProfile()), or use profiles that are installed on the system (ACGetWorkingSpaceProfile), or stored in color settings files (ACGetSettingsProfile()).
You can extract information directly from profiles, such as a string to use in the user interface (ACProfileDescription()). However, the most important thing you do with color profiles is to use them to make transformations (ACMakeColorTransform()). You can then apply it (ACApplyTransform()) to transform a set of image data from one profile to another, so that it appears with the same colors on a different display device.
AcroColor objects are reference-counted. Each object type has an unreference method (such as ACUnReferenceProfile()). Whenever you create one of these objects, you are responsible for using the corresponding unreference method to release it when you are finished with it.
| Define | ||
|---|---|---|
| AcroColorHFTNAME | ||
| AcroColorNUMSELECTORS | ||
| FOUR_CHAR_CODE | ||
| kACEMaxPathLength (Macintosh, UNIX) | ||
| kACEMaxPathLength (Windows) | ||
| kACMaxPathLength (Macintosh, UNIX) | ||
| kACMaxPathLength (Windows) | ||
| Typedef | ||
|---|---|---|
| ACCalCMYK | ||
| ACCalGray | ||
| ACCalLab | ||
| ACCalRGB | ||
| AC_FileSpec | ||
| AC_LabColor | ||
| AC_PresetList | ||
| AC_Profile | ||
| AC_ProfileList | ||
| AC_Settings | ||
| AC_String | ||
| AC_ToneCurve | ||
| AC_Transform | ||
| AC_XYColor | ||
| AC_XYZColor | ||
| Enumeration | ||
|---|---|---|
AC_ColorSpace
Constant values for ICC color space signatures.
|
||
AC_Error
Error codes returned by AcroColor functions.
|
||
AC_PackingCode
Constants that specify the packing used in a color transformation.
|
||
AC_ProfileCode
Constants that describe the type of a device color profile.
|
||
AC_RenderIntent
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.
|
||
AC_SelectorCode
Constants that specify the types of device profiles to include in a profile list.
|
||
AC_SettingsKey
Constant key values for an AC_Settings object.
|
||
AC_SettingsType
Constant values that determine the type of an AC_Settings object.
|
||
ACWorkingSpace
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.
|
||
PDCompletionCode
Callback completion code.
|
||
PDReasonCode
Callback reason code.
|
||
| Structure | ||
|---|---|---|
| _t_AC_FileSpec
Contains a platform-specific version of a file specification. This is an FSSpec on Mac OS, or a full path name on other platforms.
|
||
| _t_AC_LabColor
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.
|
||
| _t_ACCalCMYK
A simple 16-patch calibrated CMYK color space specification.
|
||
| _t_ACCalGray
A calibrated grayscale space specification.
|
||
| _t_ACCalLab
A calibrated Lab color space specification. The usual min and max values for rangeA and rangeB are -128 and +127.
|
||
| _t_ACCalRGB
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).
|
||
| _t_ACToneCurve
A tone curve value for use in a calibrated CMYK color space specification.
|
||
| _t_ACXYColor
Floating-point xy chromaticity coordinate. These can be computed from XYZ colors using x = X / (X + Y + Z) and y = Y / (X + Y + Z).
|
||
| _t_ACXYZColor
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.
|
||
| Method | ||
|---|---|---|
|
AC_Error ACApplyTransform(AC_Transform transform, const void* srcData, void* dstData, ASUns32 count, AC_PackingCode srcPacking, AC_PackingCode dstPacking)
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.
|
||
|
AC_Error ACEngineCount(ASUns32* count)
Gets the number of Color Management System/Color Management Module (CMS/CMM) choices available for the AcroColor engine (ACE).
|
||
|
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.
|
||
|
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.
|
||
|
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.
|
||
|
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.
|
||
|
Gets a working color profile in a specified color space.
|
||
|
[DEPRECATED] Loads the AcroColor engine (ACE) settings from a file.
|
||
|
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.
|
||
|
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.
|
||
|
AC_Error ACMakeCalGray(AC_Profile* profile, ACCalGray* spec, AC_RenderIntent intent, AC_String 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.
|
||
|
AC_Error ACMakeCalLab(AC_Profile* profile, ACCalLab* spec, AC_RenderIntent intent, AC_String 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.
|
||
|
AC_Error ACMakeCalRGB(AC_Profile* profile, ACCalRGB* spec, AC_RenderIntent intent, AC_String 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.
|
||
|
AC_Error ACMakeColorTransform(AC_Transform* transform, AC_Profile srcProfile, AC_Profile dstProfile, AC_RenderIntent intent)
Creates a color transformation object.
|
||
|
Creates a list of preset AcroColor engine (ACE) settings of the specified type. Clients should call ACUnReferencePresetList() when done with the preset list.
|
||
|
Creates a list of device color profiles of a given type.
|
||
|
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.
|
||
|
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.
|
||
|
AC_Error ACMonitorProfile(AC_Profile* profile, void* monitorID)
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, Apple RGB on Mac OS). The client should call ACUnReferenceProfile() when done with the returned profile. This API is not available on Mac 64.
|
||
|
AC_Error ACMonitorProfileN(AC_Profile* profile, void* monitorID)
|
||
|
[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. This API is not available on Mac 64.
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.
|
||
|
Gets the number of predefined color settings, as listed in the color management settings in the Acrobat user interface.
|
||
|
[DEPRECATED] Gets the file specification for a preset settings item in a preset list. This API is not available on Mac 64.
|
||
|
AC_Error ACPresetListItemFileAndNameU(AC_PresetList list, ASUns32 index, AC_String* file, AC_String* name)
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.
|
||
|
Gets the color space for a device profile.
|
||
|
AC_Error ACProfileData(AC_Profile profile, void* data)
Gets the data for a device profile. Copies the raw ICC profile data into a supplied buffer.
|
||
|
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.
|
||
|
Creates a device profile from a device profile type code. The client should call ACUnReferenceProfile() when done with the profile.
|
||
|
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.
|
||
|
Gets the number of profiles in a device color profile list.
|
||
|
Gets the profile code of a specified profile in a profile list.
|
||
|
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.
|
||
|
Gets the size in bytes of the raw ICC profile data in a device profile.
|
||
|
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.
|
||
|
Sets the AcroColor engine (ACE) for the system, changing the global default CMS/CMM choice.
|
||
|
Copies the ASCII version of a string into a supplied buffer. Either the buffer or the count can be NULL.
|
||
|
Copies the localized Unicode version of a string into a supplied buffer. Either the buffer or the count can be NULL.
|
||
|
Copies the Unicode version of a string into a supplied buffer. Either the buffer or the count can be NULL.
|
||
|
AC_Error ACUnReferencePresetList(AC_PresetList list)
Decrements the reference count of a preset list object. If this causes the object's reference count to reach zero, the method deletes it.
|
||
|
AC_Error ACUnReferenceProfile(AC_Profile profile)
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.
|
||
|
AC_Error ACUnReferenceProfileList(AC_ProfileList list)
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.
|
||
|
AC_Error ACUnReferenceSettings(AC_Settings settings)
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.
|
||
|
AC_Error ACUnReferenceString(AC_String string)
Decrements the reference count of a string object. If this causes the object's reference count to reach zero, the method deletes it.
|
||
|
AC_Error ACUnReferenceTransform(AC_Transform transform)
Decrements the reference count of a color transformation object. If this causes the object's reference count to reach zero, the method deletes it.
|
||
|
Embeds an output intent into a document.
|
||
|
ASBool PDDocColorConvertPage(PDDoc doc, PDColorConvertParams params, ASInt32 pageNum, ASProgressMonitor progMon, void* progMonData, PDColorConvertReportProc reportProc, void* reportProcData, ASBool* changed)
Converts the colors (in place) on a page, as specified by the params block.
|
||
|
ASBool PDDocColorConvertPageEx(PDDoc doc, PDColorConvertParamsEx paramsEx, ASInt32 pageNum, ASProgressMonitor progMon, void* progMonData, PDColorConvertReportProc reportProc, void* reportProcData, ASBool* changed)
Convert the colors (in place) in a page as specified by the params block. Takes an extended parameters block.
|
||
|
void SetUpAcroColorHFTServer()
|
||
| AcroColorHFTNAME |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
#define AcroColorHFTNAME "AcroColorHFT"
| File: AcroColorExpT.h |
| Line: 44 |
| AcroColorNUMSELECTORS |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
#define AcroColorNUMSELECTORS (AcroColorNUMSELECTORSplusOne - 1)
| File: AcroColorHFT.h |
| Line: 46 |
| FOUR_CHAR_CODE |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
#define FOUR_CHAR_CODE (x)
| File: AcroColorExpT.h |
| Line: 35 |
| kACEMaxPathLength |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, UNIX |
#define kACEMaxPathLength 256
| File: AcroColorExpT.h |
| Line: 1241 |
| kACEMaxPathLength |
| Product availability: Acrobat, PDFL |
| Platform availability: Windows |
#define kACEMaxPathLength 260
| File: AcroColorExpT.h |
| Line: 1239 |
| kACMaxPathLength |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, UNIX |
#define kACMaxPathLength 256
| File: AcroColorExpT.h |
| Line: 710 |
| kACMaxPathLength |
| Product availability: Acrobat, PDFL |
| Platform availability: Windows |
#define kACMaxPathLength 260
| File: AcroColorExpT.h |
| Line: 708 |
| AC_FileSpec |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_AC_FileSpec AC_FileSpec;
| File: AcroColorExpT.h |
| Line: 735 |
| AC_LabColor |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_AC_LabColor AC_LabColor;
| File: AcroColorExpT.h |
| Line: 883 |
| AC_PresetList |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef struct ACPresetList* AC_PresetList;
| File: AcroColorExpT.h |
| Line: 179 |
| AC_Profile |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef struct ACProfile* AC_Profile;
| File: AcroColorExpT.h |
| Line: 159 |
| AC_ProfileList |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef struct ACProfileList* AC_ProfileList;
| File: AcroColorExpT.h |
| Line: 90 |
| AC_Settings |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef struct ACSettings* AC_Settings;
| File: AcroColorExpT.h |
| Line: 128 |
| AC_String |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef struct ACString* AC_String;
| File: AcroColorExpT.h |
| Line: 71 |
| AC_ToneCurve |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_ACToneCurve AC_ToneCurve;
| File: AcroColorExpT.h |
| Line: 782 |
| AC_Transform |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef struct ACTransform* AC_Transform;
| File: AcroColorExpT.h |
| Line: 107 |
| AC_XYColor |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_ACXYColor AC_XYColor;
| File: AcroColorExpT.h |
| Line: 767 |
| AC_XYZColor |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_ACXYZColor AC_XYZColor;
| File: AcroColorExpT.h |
| Line: 756 |
| ACCalCMYK |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_ACCalCMYK ACCalCMYK;
| File: AcroColorExpT.h |
| Line: 867 |
| ACCalGray |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_ACCalGray ACCalGray;
| File: AcroColorExpT.h |
| Line: 905 |
| ACCalLab |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_ACCalLab ACCalLab;
| File: AcroColorExpT.h |
| Line: 995 |
| ACCalRGB |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
typedef _t_ACCalRGB ACCalRGB;
| File: AcroColorExpT.h |
| Line: 952 |
| AC_ColorSpace |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_ColorSpace {
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,
AC_Space_Null = 0,
AC_Space_MaxEnum = 0xFFFFFFFFL
}
See Also
| File: AcroColorExpT.h |
| Line: 1107 |
| AC_Error |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_Error {
AC_Error_None = 0,
AC_Error_General = FOUR_CHAR_CODE ('gen '),
AC_Error_Param = FOUR_CHAR_CODE ('parm'),
AC_Error_Version = FOUR_CHAR_CODE ('ver '),
AC_Error_UserAbort = FOUR_CHAR_CODE ('abrt'),
AC_Error_Memory = FOUR_CHAR_CODE ('memF'),
AC_Error_StackFull = FOUR_CHAR_CODE ('stkF'),
AC_Error_ScratchFull = FOUR_CHAR_CODE ('scrF'),
AC_Error_StringOverflow = FOUR_CHAR_CODE ('strO'),
AC_Error_NoASCII = FOUR_CHAR_CODE ('noA '),
AC_Error_NoUnicode = FOUR_CHAR_CODE ('noU '),
AC_Error_NoLocalized = FOUR_CHAR_CODE ('noL '),
AC_Error_BadAlignment = FOUR_CHAR_CODE ('alig'),
AC_Error_BadDescription = FOUR_CHAR_CODE ('bDes'),
AC_Error_BadConcat = FOUR_CHAR_CODE ('bCat'),
AC_Error_BadMerge = FOUR_CHAR_CODE ('bMrg'),
AC_Error_BadProfile = FOUR_CHAR_CODE ('bPro'),
AC_Error_UnsupCMS = FOUR_CHAR_CODE ('uCMS'),
AC_Error_UnsupOption = FOUR_CHAR_CODE ('uOpt'),
AC_Error_UnsupPacking = FOUR_CHAR_CODE ('uPac'),
AC_Error_UnsupProfile = FOUR_CHAR_CODE ('uPro'),
AC_Error_UnsupProfileCode = FOUR_CHAR_CODE ('uPrC'),
AC_Error_UnsupSpace = FOUR_CHAR_CODE ('uSpc'),
AC_Error_UnsupQuery = FOUR_CHAR_CODE ('uQry'),
AC_Error_MissingProfile = FOUR_CHAR_CODE ('misP'),
AC_Error_ModifiedProfile = FOUR_CHAR_CODE ('modP'),
AC_Error_FileNotFound = FOUR_CHAR_CODE ('fnf '),
AC_Error_EOF = FOUR_CHAR_CODE ('eof '),
AC_Error_FileLocked = FOUR_CHAR_CODE ('flck'),
AC_Error_DiskIO = FOUR_CHAR_CODE ('io '),
AC_Error_ColorSync = FOUR_CHAR_CODE ('csE '),
AC_Error_ICM = FOUR_CHAR_CODE ('icmE'),
AC_Error_MissingKey = FOUR_CHAR_CODE ('mKey'),
AC_Error_InvalidSettings = FOUR_CHAR_CODE ('iSet'),
AC_Error_SettingsVersion = FOUR_CHAR_CODE ('vSet'),
AC_Error_NotImplemented = FOUR_CHAR_CODE ('nImp'),
AC_Error_MaxEnum = 0xFFFFFFFFL
}
| File: AcroColorExpT.h |
| Line: 258 |
| AC_Error_None | No error. |
|
| AC_Error_General | Other error. |
|
| AC_Error_Param | Bad parameters to an API call. |
|
| AC_Error_Version | Application and ACE library mismatch. |
|
| AC_Error_UserAbort | The user aborted the operation. Returned by ACE when the client progress callback returns |
|
| AC_Error_Memory | Out of memory. |
|
| AC_Error_StackFull | Out of stack space. |
|
| AC_Error_ScratchFull | Client callback ran out of scratch space. |
|
| AC_Error_StringOverflow | String does not fit in supplied buffer. |
|
| AC_Error_NoASCII | String does not contain ASCII data. |
|
| AC_Error_NoUnicode | String does not contain Unicode data. |
|
| AC_Error_NoLocalized | String does not contain localized data. |
|
| AC_Error_BadAlignment | Data is not correctly byte aligned. |
|
| AC_Error_BadDescription | Invalid profile description. |
|
| AC_Error_BadConcat | Unable to concatenate transforms. |
|
| AC_Error_BadMerge | Unable to merge transforms. |
|
| AC_Error_BadProfile | Invalid profile. |
|
| AC_Error_UnsupCMS | Unsupported CMS. |
|
| AC_Error_UnsupOption | Unsupported ACE option. |
|
| AC_Error_UnsupPacking | Unsupported packing code. |
|
| AC_Error_UnsupProfile | Unsupported profile version. |
|
| AC_Error_UnsupProfileCode | Unsupported profile code. |
|
| AC_Error_UnsupSpace | ||
| AC_Error_UnsupQuery | Unsupported query code. |
|
| AC_Error_MissingProfile | A profile was missing from the disk. |
|
| AC_Error_ModifiedProfile | The profile on disk has been modified. |
|
| AC_Error_FileNotFound | File is missing from disk. |
|
| AC_Error_EOF | ||
| AC_Error_FileLocked | File locked error. |
|
| AC_Error_DiskIO | Disk I/O error. |
|
| AC_Error_ColorSync | A problem using ColorSync. |
|
| AC_Error_ICM | A problem using ICM. |
|
| AC_Error_MissingKey | The color settings does not contain this key. |
|
| AC_Error_InvalidSettings | ||
| AC_Error_SettingsVersion | ||
| AC_Error_NotImplemented | The function is not implemented (subsetted library). |
|
| AC_Error_MaxEnum | This constant forces the |
| AC_PackingCode |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_PackingCode {
AC_Packing_pRGB8 = FOUR_CHAR_CODE ('prgb'),
AC_Packing_RGB8 = FOUR_CHAR_CODE ('rgb '),
AC_Packing_pRGB15 = FOUR_CHAR_CODE ('PRGB'),
AC_Packing_CMYK8_Black0 = FOUR_CHAR_CODE ('cmyk'),
AC_Packing_CMYK8_White0 = FOUR_CHAR_CODE ('cmyw'),
AC_Packing_CMYK15_Black0 = FOUR_CHAR_CODE ('CMYK'),
AC_Packing_pLab8 = FOUR_CHAR_CODE ('plab'),
AC_Packing_Lab8 = FOUR_CHAR_CODE ('lab '),
AC_Packing_pLab15 = FOUR_CHAR_CODE ('PLAB'),
AC_Packing_Gray8_Black0 = FOUR_CHAR_CODE ('g8k0'),
AC_Packing_Gray8_White0 = FOUR_CHAR_CODE ('g8w0'),
AC_Packing_Gray15_Black0 = FOUR_CHAR_CODE ('G15K'),
AC_Packing_pXYZ16 = FOUR_CHAR_CODE ('PXYZ'),
AC_Packing_pABC8 = FOUR_CHAR_CODE ('pabc'),
AC_Packing_ABC8 = FOUR_CHAR_CODE ('abc '),
AC_Packing_pABC15 = FOUR_CHAR_CODE ('pABC'),
AC_Packing_ABCD8 = FOUR_CHAR_CODE ('abcd'),
AC_Packing_ABCD15 = FOUR_CHAR_CODE ('ABCD'),
AC_Packing_CS64_Gray = FOUR_CHAR_CODE ('CS01'),
AC_Packing_CS64_RGB = FOUR_CHAR_CODE ('CS02'),
AC_Packing_CS64_CMYK = FOUR_CHAR_CODE ('CS03'),
AC_Packing_CS64_Lab = FOUR_CHAR_CODE ('CS04'),
AC_Packing_CS64_XYZ = FOUR_CHAR_CODE ('CS05'),
AC_Packing_CS64_ABC = FOUR_CHAR_CODE ('CS06'),
AC_Packing_CS64_ABCD = FOUR_CHAR_CODE ('CS07'),
AC_Packing_Null = FOUR_CHAR_CODE ('null'),
AC_Packing_General = 0,
AC_Packing_MaxEnum = 0xFFFFFFFFL
}
| File: AcroColorExpT.h |
| Line: 477 |
| AC_Packing_pRGB8 | 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.
Data must be 32-bit aligned. |
|
| AC_Packing_RGB8 | Same as AC_Packing_pRGB8, without the leading pad byte. Data need only be 8-bit aligned. |
|
| AC_Packing_pRGB15 | 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.
Values greater than Data must be 64-bit aligned. |
|
| AC_Packing_CMYK8_Black0 | 8-bit CMYK.
Data must be 32-bit aligned. |
|
| AC_Packing_CMYK8_White0 | Same as AC_Packing_CMYK8_Black0 with inverse encoding. |
|
| AC_Packing_CMYK15_Black0 | 15+ bit CMYK.
Values greater than Data must be 64-bit aligned. |
|
| AC_Packing_pLab8 | 8-bit LAB, with a leading pad byte.
Data must be 32-bit aligned. |
|
| AC_Packing_Lab8 | Same as AC_Packing_pLab8, without the leading pad byte. Data need only be 8-bit aligned. |
|
| AC_Packing_pLab15 | 15+ bit LAB, with a leading pad word.
Values greater than Data must be 64-bit aligned. |
|
| AC_Packing_Gray8_Black0 | 8-bit grayscale or gamut test results, no padding.
When used for gamut test results, any value greater than or equal to |
|
| AC_Packing_Gray8_White0 | Same as AC_Packing_Gray8_Black0 with inverse encoding. |
|
| AC_Packing_Gray15_Black0 | 15+ bit grayscale or gamut test results, no padding.
Values greater than Data must be 16-bit aligned. |
|
| AC_Packing_pXYZ16 | 16-bit XYZ, with a leading pad word.
Data must be 64-bit aligned. |
|
| AC_Packing_pABC8 | Generic padded 3-component 8-bit packing. Data must be 32-bit aligned. |
|
| AC_Packing_ABC8 | Same as AC_Packing_pABC8, without the leading pad byte. Data need only be 8-bit aligned. |
|
| AC_Packing_pABC15 | Generic padded 3-component 15+ bit packing. Data must be 64-bit aligned. |
|
| AC_Packing_ABCD8 | Generic 4-component 8-bit packing. Data must be 32-bit aligned. |
|
| AC_Packing_ABCD15 | Generic 4-component 15+ bit packing. Data must be 64-bit aligned. |
|
| AC_Packing_CS64_Gray | 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 | 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 | 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 | 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 | 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 | 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 | 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 |
|
|
| AC_Packing_General | None of the above; use the general packing specification. |
|
| AC_Packing_MaxEnum | This constant forces the |
| AC_ProfileCode |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_ProfileCode {
AC_Profile_Null = 0,
AC_Profile_Lab_D50 = FOUR_CHAR_CODE ('LD50'),
AC_Profile_PCS_XYZ = FOUR_CHAR_CODE ('pXYZ'),
AC_Profile_Flat_XYZ = FOUR_CHAR_CODE ('fXYZ'),
AC_Profile_sRGB = FOUR_CHAR_CODE ('sRGB'),
AC_Profile_AppleRGB = FOUR_CHAR_CODE ('aRGB'),
AC_Profile_AdobeRGB1998 = FOUR_CHAR_CODE ('AS98'),
AC_Profile_ColorMatchRGB = FOUR_CHAR_CODE ('cmat'),
AC_Profile_Gamma18 = FOUR_CHAR_CODE ('GG18'),
AC_Profile_Gamma22 = FOUR_CHAR_CODE ('GG22'),
AC_Profile_DotGain10 = FOUR_CHAR_CODE ('DG10'),
AC_Profile_DotGain15 = FOUR_CHAR_CODE ('DG15'),
AC_Profile_DotGain20 = FOUR_CHAR_CODE ('DG20'),
AC_Profile_DotGain25 = FOUR_CHAR_CODE ('DG25'),
AC_Profile_DotGain30 = FOUR_CHAR_CODE ('DG30'),
AC_Profile_MonitorRGB = FOUR_CHAR_CODE ('mRGB'),
AC_Profile_SystemRGB = FOUR_CHAR_CODE ('sysR'),
AC_Profile_SystemCMYK = FOUR_CHAR_CODE ('sysC'),
AC_Profile_SystemGray = FOUR_CHAR_CODE ('sysG'),
AC_Profile_SystemInput = FOUR_CHAR_CODE ('sysI'),
AC_Profile_SystemOutput = FOUR_CHAR_CODE ('sysO'),
AC_Profile_SystemProofer = FOUR_CHAR_CODE ('sysP'),
AC_Profile_WorkingRGB = FOUR_CHAR_CODE ('wRGB'),
AC_Profile_WorkingCMYK = FOUR_CHAR_CODE ('wCMY'),
AC_Profile_WorkingGray = FOUR_CHAR_CODE ('wGry'),
AC_Profile_MaxEnum = 0xFFFFFFFFL
}
See Also
| File: AcroColorExpT.h |
| Line: 379 |
| AC_Profile_Null | A |
|
| AC_Profile_Lab_D50 | 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 | An XYZ profile that exactly matches the ICC's XYZ PCS space. |
|
| AC_Profile_Flat_XYZ | An XYZ profile with a flat white point encoding ( |
|
| AC_Profile_sRGB | HP's sRGB profile. The default Windows monitor profile. |
|
| AC_Profile_AppleRGB | Default RGB space using by Photoshop 4.0 and earlier. The default Mac OS monitor profile. |
|
| AC_Profile_AdobeRGB1998 | A wider gamut RGB space recommended by Adobe. |
|
| AC_Profile_ColorMatchRGB | A simplified version of Radius' ColorMatch RGB space, without Radius' non-zero black point. |
|
| AC_Profile_Gamma18 | ||
| AC_Profile_Gamma22 | ||
| AC_Profile_DotGain10 | Grayscale printer profile with a dot gain of 10. |
|
| AC_Profile_DotGain15 | Grayscale printer profile with a dot gain of 15. |
|
| AC_Profile_DotGain20 | Grayscale printer profile with a dot gain of 20. |
|
| AC_Profile_DotGain25 | Grayscale printer profile with a dot gain of 25. |
|
| AC_Profile_DotGain30 | Grayscale printer profile with a dot gain of 30. |
|
| AC_Profile_MonitorRGB | The system "Monitor RGB" profile, which is the same profile as that returned by AC_MainMonitorProfile. |
|
| AC_Profile_SystemRGB | The system default profiles for RGB color space. (Currently a ColorSync 3.0 only feature.) |
|
| AC_Profile_SystemCMYK | The system default profiles for CMYK color space. (Currently a ColorSync 3.0 only feature.) |
|
| AC_Profile_SystemGray | The system default profiles for Gray color space. (Currently a ColorSync 3.0 only feature.) |
|
| AC_Profile_SystemInput | The system default profiles for input device type. (Currently a ColorSync 3.0 only feature.) |
|
| AC_Profile_SystemOutput | The system default profiles for output device type. (Currently a ColorSync 3.0 only feature.) |
|
| AC_Profile_SystemProofer | The system default profiles for proofer device type. (Currently a ColorSync 3.0 only feature.) |
|
| AC_Profile_WorkingRGB | 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 | 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 | 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_MaxEnum | This constant forces the enum to be 32 bits wide. |
| AC_RenderIntent |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_RenderIntent {
AC_Perceptual = 0,
AC_RelColorimetric = 1,
AC_Saturation = 2,
AC_AbsColorimetric = 3,
AC_UseProfileIntent = 0xFFFFFFFFL
}
See Also
| File: AcroColorExpT.h |
| Line: 659 |
| AC_Perceptual | 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 | 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 | 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 | 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 | Use the source profile's rendering intent. |
| AC_SelectorCode |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_SelectorCode {
AC_Selector_RGB_Standard = FOUR_CHAR_CODE ('rStd'),
AC_Selector_RGB_OtherInputCapable = FOUR_CHAR_CODE ('rInp'),
AC_Selector_RGB_OtherOutputCapable = FOUR_CHAR_CODE ('rOut'),
AC_Selector_CMYK_StandardInput = FOUR_CHAR_CODE ('cSIn'),
AC_Selector_CMYK_StandardOutput = FOUR_CHAR_CODE ('cStd'),
AC_Selector_CMYK_OtherInputCapable = FOUR_CHAR_CODE ('cInp'),
AC_Selector_CMYK_OtherOutputCapable = FOUR_CHAR_CODE ('cOut'),
AC_Selector_Gray_Standard = FOUR_CHAR_CODE ('gStd'),
AC_Selector_Gray_OtherInputCapable = FOUR_CHAR_CODE ('gInp'),
AC_Selector_Gray_OtherOutputCapable = FOUR_CHAR_CODE ('gOut'),
AC_Selector_DotGain_Standard = FOUR_CHAR_CODE ('dStd'),
AC_Selector_DotGain_Other = FOUR_CHAR_CODE ('dOth'),
AC_Selector_PhotoYCC_InputCapable = FOUR_CHAR_CODE ('iYCC'),
AC_Selector_MaxEnum = 0xFFFFFFFFL
}
See Also
| File: AcroColorExpT.h |
| Line: 188 |
| AC_Selector_RGB_Standard | Standard (recommended) RGB profiles. These profiles are always bidirectional. |
|
| AC_Selector_RGB_OtherInputCapable | 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 | 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 | 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 | Standard (recommended) CMYK profiles that can be used as a destination. These profiles are also usable as a source. |
|
| AC_Selector_CMYK_OtherInputCapable | 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 | 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 | Standard (recommended) grayscale profiles. These profiles are always bidirectional. |
|
| AC_Selector_Gray_OtherInputCapable | 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 | 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 | 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 | 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 | PhotoYCC profiles that can be used as a source. |
|
| AC_Selector_MaxEnum | This constant forces the enum to be 32 bits wide. |
| AC_SettingsKey |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_SettingsKey {
AC_Key_Name = FOUR_CHAR_CODE ('name'),
AC_Key_Description = FOUR_CHAR_CODE ('desc'),
AC_Key_WriterName = FOUR_CHAR_CODE ('wNam'),
AC_Key_WorkingRGB = FOUR_CHAR_CODE ('wRGB'),
AC_Key_WorkingCMYK = FOUR_CHAR_CODE ('wCMY'),
AC_Key_WorkingGray = FOUR_CHAR_CODE ('wGry'),
AC_Key_WorkingSpot = FOUR_CHAR_CODE ('wSpt'),
AC_Key_PolicyRGB = FOUR_CHAR_CODE ('pRGB'),
AC_Key_PolicyCMYK = FOUR_CHAR_CODE ('pCMY'),
AC_Key_PolicyGray = FOUR_CHAR_CODE ('pGry'),
AC_Key_MismatchAskOpening = FOUR_CHAR_CODE ('mAsk'),
AC_Key_MismatchAskPasting = FOUR_CHAR_CODE ('pAsk'),
AC_Key_MissingAskOpening = FOUR_CHAR_CODE ('misA'),
AC_Key_EngineCMS = FOUR_CHAR_CODE ('eCMS'),
AC_Key_EngineCMM = FOUR_CHAR_CODE ('eCMM'),
AC_Key_Intent = FOUR_CHAR_CODE ('cInt'),
AC_Key_KPC = FOUR_CHAR_CODE ('kpc '),
AC_Key_Dither = FOUR_CHAR_CODE ('dith'),
AC_Key_CompressionEnabled = FOUR_CHAR_CODE ('mce '),
AC_Key_CompressionPercent = FOUR_CHAR_CODE ('mcp '),
AC_Key_BlendGammaEnabled = FOUR_CHAR_CODE ('bge '),
AC_Key_BlendGammaValue = FOUR_CHAR_CODE ('bgv '),
AC_Key_ProofType = FOUR_CHAR_CODE ('pTyp'),
AC_Key_ProofProfile = FOUR_CHAR_CODE ('pPrf'),
AC_Key_Simulate = FOUR_CHAR_CODE ('dSim'),
AC_Key_MaxEnum = 0xFFFFFFFFL
}
See Also
| File: AcroColorExpT.h |
| Line: 1003 |
| AC_Key_Name | Settings file name string (if different than the file name). |
|
| AC_Key_Description | Settings file description string. |
|
| AC_Key_WriterName | ||
| AC_Key_WorkingRGB | Working RGB profile. |
|
| AC_Key_WorkingCMYK | Working CMYK profile. |
|
| AC_Key_WorkingGray | Working gray profile. |
|
| AC_Key_WorkingSpot | Working spot profile. |
|
| AC_Key_PolicyRGB | RGB color management policy (AC_Policy |
|
| AC_Key_PolicyCMYK | CMYK color management policy (AC_Policy |
|
| AC_Key_PolicyGray | Gray color management policy (AC_Policy |
|
| AC_Key_MismatchAskOpening | Ask about profile mismatches when opening ( |
|
| AC_Key_MismatchAskPasting | Ask about profile mismatches when pasting ( |
|
| AC_Key_MissingAskOpening | Ask about missing profile when opening ( |
|
| AC_Key_EngineCMS | Conversion engine CMS code (4-char code, stored as |
|
| AC_Key_EngineCMM | Conversion engine CMM code (4-char code, stored as |
|
| AC_Key_Intent | ||
| AC_Key_KPC | ||
| AC_Key_Dither | Dither conversions between 8-bit color spaces ( |
|
| AC_Key_CompressionEnabled | Enable or disable monitor compression ( |
|
| AC_Key_CompressionPercent | Monitor compression percent (in percent). |
|
| AC_Key_BlendGammaEnabled | Enable or disable RGB blending gamma ( |
|
| AC_Key_BlendGammaValue | ||
| AC_Key_ProofType | Proof type (AC_ProofType |
|
| AC_Key_ProofProfile | Proof profile. |
|
| AC_Key_Simulate | Display simulation (AC_Simulate |
|
| AC_Key_MaxEnum | This constant forces the |
| AC_SettingsType |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum AC_SettingsType {
AC_SettingsType_Color = FOUR_CHAR_CODE ('AsCs'),
AC_SettingsType_Proof = FOUR_CHAR_CODE ('AsPs'),
AC_SettingsType_MaxEnum = 0xFFFFFFFFL
}
See Also
| File: AcroColorExpT.h |
| Line: 1090 |
| AC_SettingsType_Color | Used to hold global color settings, such as working spaces. |
|
| AC_SettingsType_Proof | Used to specify the parameters for proofing a document. The Proof Setup Files generally control a per-window setting. |
|
| AC_SettingsType_MaxEnum | This constant forces the |
| ACWorkingSpace |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum ACWorkingSpace {
kACWorkingGray = 0,
kACWorkingRGB = 1,
kACWorkingCMYK = 2,
kACWorkingSpaces = 3
}
See Also
| File: AcroColorExpT.h |
| Line: 1227 |
| kACWorkingGray | Grayscale profile. |
|
| kACWorkingRGB | RGB profile. |
|
| kACWorkingCMYK | CMYK profile. |
|
| kACWorkingSpaces | Working spaces. |
| PDCompletionCode |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum PDCompletionCode {
PDCompletionSuccess,
PDCompletionContinue,
PDCompletionAbort
}
| File: AcroColorExpT.h |
| Line: 1557 |
| PDCompletionSuccess | Success. |
|
| PDCompletionContinue | Continue. |
|
| PDCompletionAbort | Abort. |
| PDReasonCode |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
enum PDReasonCode {
PDReasonNone,
PDReasonNotImplemented
}
| File: AcroColorExpT.h |
| Line: 1570 |
| PDReasonNone | None. |
|
| PDReasonNotImplemented | None implemented. |
| _t_AC_FileSpec |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_AC_FileSpec {
FSSpec spec;
}
Contains a platform-specific version of a file specification. This is an FSSpec on Mac OS, or a full path name on other platforms.
See Also
| File: AcroColorExpT.h |
| Line: 722 |
| spec | On Mac OS, use an FSSpec. |
| _t_AC_LabColor |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_AC_LabColor {
double L;
double a;
double b;
}
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.
See Also
| File: AcroColorExpT.h |
| Line: 879 |
| _t_ACCalCMYK |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_ACCalCMYK {
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.
| File: AcroColorExpT.h |
| Line: 794 |
| w | ||
| k | Absolute XYZ value of a CMYK ink combination: K. |
|
| c | Absolute XYZ value of a CMYK ink combination: C. |
|
| m | Absolute XYZ value of a CMYK ink combination: M. |
|
| y | Absolute XYZ value of a CMYK ink combination: Y. |
|
| cm | Absolute XYZ value of a CMYK ink combination: CM. |
|
| cy | Absolute XYZ value of a CMYK ink combination: CY. |
|
| ck | Absolute XYZ value of a CMYK ink combination: CK. |
|
| my | Absolute XYZ value of a CMYK ink combination: MY. |
|
| mk | Absolute XYZ value of a CMYK ink combination: MK. |
|
| yk | Absolute XYZ value of a CMYK ink combination: YK. |
|
| cmy | Absolute XYZ value of a CMYK ink combination: CMY. |
|
| cmk | Absolute XYZ value of a CMYK ink combination: CMK. |
|
| cyk | Absolute XYZ value of a CMYK ink combination: CYK. |
|
| myk | Absolute XYZ value of a CMYK ink combination: MYK. |
|
| cmyk | Absolute XYZ value of a CMYK ink combination: CMYK. |
|
| cTRC | Dot gain curve for the cyan ink. |
|
| mTRC | Dot gain curve for the magenta ink. |
|
| yTRC | Dot gain curve for the yellow ink. |
|
| kTRC | Dot gain curve for the black ink. |
|
| 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 |
|
| white | The absolute XYZ value of paper white. It should be a duplicate of the |
|
| black | The absolute XYZ value of a legal (within total ink limits) four-color CMYK black. It is currently ignored. |
| _t_ACCalGray |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_ACCalGray {
double gamma;
AC_XYZColor white;
AC_XYZColor black;
}
A calibrated grayscale space specification.
See Also
| File: AcroColorExpT.h |
| Line: 892 |
| gamma | Gamma value. Normal values are greater than or equal to |
|
| white | Absolute XYZ value of a monitor white point (illuminant). The Y-value should be equal to |
|
| black |
| _t_ACCalLab |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_ACCalLab {
AC_XYZColor white;
AC_XYZColor black;
ASInt32 min;
ASInt32 max;
struct _t_ACCalLab::@0 rangeA;
struct _t_ACCalLab::@1 rangeB;
}
A calibrated Lab color space specification. The usual min and max values for rangeA and rangeB are -128 and +127.
See Also
| File: AcroColorExpT.h |
| Line: 963 |
| white | Color space white point. The Y value should be equal to |
|
| black | Color space black point. It is currently ignored by ACE when creating profiles, and is always set to zero when extracting from profiles. |
|
| min | The usual value is |
|
| max | The usual value |
|
| _t_ACCalRGB |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_ACCalRGB {
double redGamma;
double greenGamma;
double blueGamma;
AC_XYZColor red;
AC_XYZColor green;
AC_XYZColor blue;
AC_XYZColor white;
AC_XYZColor black;
}
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).
See Also
| File: AcroColorExpT.h |
| Line: 923 |
| redGamma | Red gamma value for each component. Normal values are greater than or equal to |
|
| greenGamma | Green gamma value for each component. Normal values are greater than or equal to |
|
| blueGamma | Blue gamma value for each component. Normal values are greater than or equal to |
|
| red | Red column of the matrix used to convert between RGB values and XYZ values. |
|
| green | Green column of the matrix used to convert between RGB values and XYZ values. |
|
| blue | Blue column of the matrix used to convert between RGB values and XYZ values. |
|
| white | The absolute XYZ value of the monitor white point (illuminant). The Y-value shall be equal to |
|
| black |
| _t_ACToneCurve |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_ACToneCurve {
ASUns32 bytesPerValue;
ASUns32 count;
void* data;
}
A tone curve value for use in a calibrated CMYK color space specification.
See Also
| File: AcroColorExpT.h |
| Line: 775 |
| bytesPerValue | The number of bytes per value (1 or 2). |
|
| count | Number of samples (often 256). |
|
| data | A pointer to the samples. |
| _t_ACXYColor |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
struct _t_ACXYColor {
double x;
double y;
}
Floating-point xy chromaticity coordinate. These can be computed from XYZ colors using x = X / (X + Y + Z) and y = Y / (X + Y + Z).
| File: AcroColorExpT.h |
| Line: 764 |
| _t_ACXYZColor |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
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.
See Also
| File: AcroColorExpT.h |
| Line: 747 |
| X | ||
| Y | ||
| Z |
| ACApplyTransform | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACApplyTransform(AC_Transform transform, const void* srcData, void* dstData, ASUns32 count, AC_PackingCode srcPacking, AC_PackingCode dstPacking)
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.
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 — | ||
dstPacking — |
|
See Also
| File: AcroColorProcs.h |
| Line: 730 |
| ACEngineCount | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
Gets the number of Color Management System/Color Management Module (CMS/CMM) choices available for the AcroColor engine (ACE).
Parameters
count — |
|
See Also
| File: AcroColorProcs.h |
| Line: 41 |
| ACEngineInfo | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
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.
Parameters
index — | The zero-based index of the CMS/CMM. The highest legal value is |
|
name — | (Filled by the method) Optional. If it is not |
|
cmsID — | (Filled by the method) Returns the CMS identifier. |
|
cmmID — | (Filled by the method) Returns the CMM identifier. |
|
See Also
| File: AcroColorProcs.h |
| Line: 62 |
| ACGetSettingsProfile | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACGetSettingsProfile(AC_Settings settings, AC_SettingsKey key, AC_Profile* profile)
Gets the current color profile for a given key from the AcroColor engine (ACE) settings object.
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.
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.
Parameters
settings — | The |
|
key — | The value key constant. |
|
profile — | (Filled by the method) A pointer to the current color profile value of the given key. |
|
See Also
| File: AcroColorProcs.h |
| Line: 307 |
| ACGetSettingsString | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACGetSettingsString(AC_Settings settings, AC_SettingsKey key, AC_String* string)
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.
Parameters
settings — | The |
|
key — | The value key constant. |
|
string — | (Filled by the method) A pointer to the current string value of the given key. |
|
See Also
| File: AcroColorProcs.h |
| Line: 383 |
| ACGetSettingsUnsigned32 | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACGetSettingsUnsigned32(AC_Settings settings, AC_SettingsKey key, ASUns32* value)
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.
Parameters
settings — | The |
|
key — | The value key constant. |
|
value — | (Filled by the method) A pointer to the current numeric value of the given key. |
|
See Also
| File: AcroColorProcs.h |
| Line: 405 |
| ACGetWorkingSpaceProfile | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACGetWorkingSpaceProfile(ACWorkingSpace space, AC_Profile* workingProfile)
Gets a working color profile in a specified color space.
Parameters
space — | ||
workingProfile — | (Filled by the method) A pointer to the working profile. When done with this object, dereference it using ACUnReferenceProfile(). |
|
See Also
| File: AcroColorProcs.h |
| Line: 892 |
| ACLoadSettings | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACLoadSettings(AC_Settings settings, AC_FileSpec* file)
[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. This API is not available on Mac 64.
Parameters
settings — | (Filled by the method) The |
|
file — | A pointer to the file specification for the file containing the settings. |
|
See Also
| File: AcroColorProcs.h |
| Line: 351 |
| ACLoadSettingsU | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACLoadSettingsU(AC_Settings settings, AC_String file)
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.
Parameters
settings |
|
file |
See Also
| File: AcroColorProcs.h |
| Line: 1105 |
| ACMakeBufferProfile | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeBufferProfile(AC_Profile* profile, void* data, ASUns32 dataSize)
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.
Parameters
profile — | (Filled by the method) The device profile. |
|
data — | The buffer containing the device profile data. |
|
dataSize — |
|
See Also
| File: AcroColorProcs.h |
| Line: 544 |
| ACMakeCalGray | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeCalGray(AC_Profile* profile, ACCalGray* spec, AC_RenderIntent intent, AC_String 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.
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- |
|
See Also
| File: AcroColorProcs.h |
| Line: 598 |
| ACMakeCalLab | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeCalLab(AC_Profile* profile, ACCalLab* spec, AC_RenderIntent intent, AC_String 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.
Parameters
profile — | (Filled by the method) A pointer to the new device color profile. |
|
spec — | ||
intent — | The rendering intent. |
|
description — | The description of the new profile. If it is non- |
|
See Also
| File: AcroColorProcs.h |
| Line: 626 |
| ACMakeCalRGB | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeCalRGB(AC_Profile* profile, ACCalRGB* spec, AC_RenderIntent intent, AC_String 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.
Parameters
profile — | (Filled by the method) A pointer to the new device color profile. |
|
spec — | ||
intent — | The rendering intent. |
|
description — | The description of the new profile. If it is non- |
|
See Also
| File: AcroColorProcs.h |
| Line: 571 |
| ACMakeColorTransform | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeColorTransform(AC_Transform* transform, AC_Profile srcProfile, AC_Profile dstProfile, AC_RenderIntent intent)
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.
Parameters
transform — | (Filled by the method) A pointer to the new color transformation object. |
|
srcProfile — | ||
dstProfile — | ||
intent — | The rendering intent for colors outside the gamut of the destination profile. |
|
See Also
| File: AcroColorProcs.h |
| Line: 706 |
| ACMakePresetList | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakePresetList(AC_PresetList* list, AC_SettingsType type)
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.
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). |
|
See Also
| File: AcroColorProcs.h |
| Line: 195 |
| ACMakeProfileList | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeProfileList(AC_ProfileList* list, AC_SelectorCode selector)
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.
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. |
|
See Also
| File: AcroColorProcs.h |
| Line: 110 |
| ACMakeSettings | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeSettings(AC_Settings* settings, AC_SettingsType type)
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.
Parameters
settings — | (Filled by the method) A pointer to the new |
|
type — | The settings type (AC_SettingsType_Color or AC_SettingsType_Proof). |
|
See Also
| File: AcroColorProcs.h |
| Line: 323 |
| ACMakeString | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMakeString(AC_String* string, const char* ascii, const ASUTF16Val* unicode)
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.
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 |
|
See Also
| File: AcroColorProcs.h |
| Line: 775 |
| ACMonitorProfile | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMonitorProfile(AC_Profile* profile, void* monitorID)
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, Apple RGB on Mac OS). The client should call ACUnReferenceProfile() when done with the returned profile. This API is not available on Mac 64.
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 |
|
See Also
| File: AcroColorProcs.h |
| Line: 514 |
| ACMonitorProfileN | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACMonitorProfileN(AC_Profile* profile, void* monitorID)
Parameters
profile |
|
monitorID |
| File: AcroColorProcs.h |
| Line: 1106 |
| ACPresetFileToName | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACPresetFileToName(const AC_FileSpec* file, AC_String* name)
[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. This API is not available on Mac 64.
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.
Parameters
file — | A pointer to the preset file specification. |
|
name — | (Filled by the method) A pointer to the display name string. |
|
See Also
| File: AcroColorProcs.h |
| Line: 259 |
| ACPresetListCount | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACPresetListCount(AC_PresetList list, ASUns32* count)
Gets the number of predefined color settings, as listed in the color management settings in the Acrobat user interface.
Parameters
list — | The preset list object. |
|
count — | (Filled by the method) A pointer to the number of settings in the list. |
|
See Also
| File: AcroColorProcs.h |
| Line: 209 |
| ACPresetListItemFile | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACPresetListItemFile(AC_PresetList list, ASUns32 index, AC_FileSpec* file)
[DEPRECATED] Gets the file specification for a preset settings item in a preset list. This API is not available on Mac 64.
Parameters
list — | The preset list object. |
|
index — | ||
file — | (Filled by the method) A pointer to the file specification for the item. |
|
See Also
| File: AcroColorProcs.h |
| Line: 229 |
| ACPresetListItemFileAndNameU | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACPresetListItemFileAndNameU(AC_PresetList list, ASUns32 index, AC_String* file, AC_String* name)
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.
Parameters
list |
|
index |
|
file |
|
name |
| File: AcroColorProcs.h |
| Line: 1093 |
| ACProfileColorSpace | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileColorSpace(AC_Profile profile, AC_ColorSpace* space)
Gets the color space for a device profile.
Parameters
profile — | The device color profile. |
|
space — |
|
See Also
| File: AcroColorProcs.h |
| Line: 637 |
| ACProfileData | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileData(AC_Profile profile, void* data)
Gets the data for a device profile. Copies the raw ICC profile data into a supplied buffer.
Parameters
profile — | The device color profile. |
|
data — |
|
See Also
| File: AcroColorProcs.h |
| Line: 662 |
| ACProfileDescription | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileDescription(AC_Profile profile, AC_String* 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.
Parameters
profile — | The device color profile. |
|
description — | (Filled by the method) A pointer to the description string. |
|
See Also
| File: AcroColorProcs.h |
| Line: 433 |
| ACProfileFromCode | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileFromCode(AC_Profile* profile, AC_ProfileCode code)
Creates a device profile from a device profile type code. The client should call ACUnReferenceProfile() when done with the profile.
Parameters
profile — | (Filled by the method) A pointer to the device color profile object. |
|
code — | The profile type code. |
|
See Also
| File: AcroColorProcs.h |
| Line: 486 |
| ACProfileFromDescription | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileFromDescription(AC_Profile* profile, AC_String 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.
Parameters
profile — | (Filled by the method) A pointer to the device color profile object. |
|
description — | The description string. |
|
See Also
| File: AcroColorProcs.h |
| Line: 465 |
| ACProfileListCount | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileListCount(AC_ProfileList list, ASUns32* count)
Gets the number of profiles in a device color profile list.
Parameters
list — | The profile list. |
|
count — | (Filled by the method) A pointer to the number of profiles in the list. |
|
See Also
| File: AcroColorProcs.h |
| Line: 124 |
| ACProfileListItemCode | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileListItemCode(AC_ProfileList list, ASUns32 index, AC_ProfileCode* code)
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.
Parameters
list — | The profile list. |
|
index — | ||
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. |
|
See Also
| File: AcroColorProcs.h |
| Line: 165 |
| ACProfileListItemDescription | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileListItemDescription(AC_ProfileList list, ASUns32 index, AC_String* 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.
Parameters
list — | The profile list. |
|
index — | ||
description — | (Filled by the method) A pointer to the profile description string. |
|
See Also
| File: AcroColorProcs.h |
| Line: 146 |
| ACProfileSize | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfileSize(AC_Profile profile, ASUns32* size)
Gets the size in bytes of the raw ICC profile data in a device profile.
Parameters
profile — | The device color profile object. |
|
size — |
|
See Also
| File: AcroColorProcs.h |
| Line: 648 |
| ACProfilesMatch | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACProfilesMatch(AC_Profile workingProfile, AC_Profile documentProfile, ASBool* match)
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.
Parameters
workingProfile — | The working device color profile. |
|
documentProfile — | The document's device color profile. |
|
match — | (Filled by the method) A pointer to the result: |
|
See Also
| File: AcroColorProcs.h |
| Line: 913 |
| ACSetEngine | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
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.
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(). |
|
See Also
| File: AcroColorProcs.h |
| Line: 87 |
| ACStringASCII | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
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).
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 |
|
maxCount — | The maximum size of |
|
See Also
| File: AcroColorProcs.h |
| Line: 809 |
| ACStringLocalized | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACStringLocalized(AC_String string, ASUTF16Val* buffer, ASUns32* count, ASUns32 maxCount)
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.
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 |
|
maxCount — | The maximum size of the |
|
See Also
| File: AcroColorProcs.h |
| Line: 843 |
| ACStringUnicode | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACStringUnicode(AC_String string, ASUTF16Val* buffer, ASUns32* count, ASUns32 maxCount)
Copies the Unicode version of a string into a supplied buffer. Either the buffer or the count can be NULL.
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 |
|
maxCount — | The maximum size of |
|
See Also
| File: AcroColorProcs.h |
| Line: 867 |
| ACUnReferencePresetList | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACUnReferencePresetList(AC_PresetList list)
Decrements the reference count of a preset list object. If this causes the object's reference count to reach zero, the method deletes it.
Parameters
list — | The preset list object. |
|
See Also
| File: AcroColorProcs.h |
| Line: 275 |
| ACUnReferenceProfile | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACUnReferenceProfile(AC_Profile profile)
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.
Parameters
profile — | The profile object. |
|
See Also
| File: AcroColorProcs.h |
| Line: 682 |
| ACUnReferenceProfileList | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACUnReferenceProfileList(AC_ProfileList list)
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.
Parameters
list — | The profile list object. |
|
See Also
| File: AcroColorProcs.h |
| Line: 175 |
| ACUnReferenceSettings | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACUnReferenceSettings(AC_Settings settings)
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.
Parameters
settings — | The |
|
See Also
| File: AcroColorProcs.h |
| Line: 416 |
| ACUnReferenceString | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
Decrements the reference count of a string object. If this causes the object's reference count to reach zero, the method deletes it.
Parameters
string — | The string object. |
|
See Also
| File: AcroColorProcs.h |
| Line: 877 |
| ACUnReferenceTransform | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
AC_Error ACUnReferenceTransform(AC_Transform transform)
Decrements the reference count of a color transformation object. If this causes the object's reference count to reach zero, the method deletes it.
Parameters
transform — | The tranform object. |
|
See Also
| File: AcroColorProcs.h |
| Line: 740 |
| PDDocColorConvertEmbedOutputIntent | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
void PDDocColorConvertEmbedOutputIntent(PDDoc doc, AC_Profile OIProfile)
Embeds an output intent into a document.
Parameters
doc — | The document in which to embed the output intent. |
|
OIProfile — | The parameters block from which to get the output intent, described as the target space. |
| File: AcroColorProcs.h |
| Line: 954 |
| PDDocColorConvertPage | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
ASBool PDDocColorConvertPage(PDDoc doc, PDColorConvertParams params, ASInt32 pageNum, ASProgressMonitor progMon, void* progMonData, PDColorConvertReportProc reportProc, void* reportProcData, ASBool* changed)
Converts the colors (in place) on a page, as specified by the params block.
Parameters
doc — | ||
params — | The parameter block that describes how color conversions are to be performed. |
|
pageNum — | ||
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 |
|
changed |
|
Exceptions
params block is malformed (for example, a reference or alias to a non-existent ink, or a circular alias). | File: AcroColorProcs.h |
| Line: 929 |
| PDDocColorConvertPageEx | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
ASBool PDDocColorConvertPageEx(PDDoc doc, PDColorConvertParamsEx paramsEx, ASInt32 pageNum, ASProgressMonitor progMon, void* progMonData, PDColorConvertReportProc reportProc, void* reportProcData, ASBool* changed)
Convert the colors (in place) in a page as specified by the params block. Takes an extended parameters block.
Parameters
doc — | ||
paramsEx — | The parameters block that describes how color conversions are to be performed. |
|
pageNum — | ||
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 |
|
changed |
|
Exceptions
params block is ill-formed (for example, a reference or alias to a non-existent ink, or a circular alias). | File: AcroColorProcs.h |
| Line: 945 |
| SetUpAcroColorHFTServer | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
void SetUpAcroColorHFTServer()
| File: AcroColorHFT.h |
| Line: 72 |