AIRaster.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "IAIFilePath.hpp"
#include "IAIColorSpace.hpp"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AISlice
	A slice, which defines a subset of a raster data to be copied or replaced, in AITile::bounds. More...
struct	AITile
	A tile, which describes local storage for copying image data to and from. More...
struct	AIRGBColorRec
	An RGB color table. More...
struct	AIExtendedRGBColorRec
	An extended (16-bit) RGB color table. More...
struct	AICMYKColorRec
	A CMYK color table. More...
struct	AIRasterRecord
	Configuration information for the raster image data associated with an art object of type kRasterArt. More...
struct	AIRasterLink
	Link information about an image. More...
struct	AIRasterOutlineParams
	Parameters for controlling the curve fitting used when outlining a raster. More...
struct	AIRasterOutlineConsumer
	When extracting an outline from a raster, the curves are enumerated to these callbacks. More...
struct	AIRasterSuite
	This suite provides functions with which to access and modify the data associated with an art object of type kRasterArt. More...
Defines
#define	kAIRasterSuite   "AI Raster Suite"
#define	kAIRasterSuiteVersion10   AIAPI_VERSION(10)
#define	kAIRasterSuiteVersion   kAIRasterSuiteVersion10
#define	kAIRasterVersion   kAIRasterSuiteVersion
#define	kMaxChannels   32
	Maximum number of channels per image pixel.
#define	kMaxSpotChannels   27
	Maximum number of spot color channels per image pixel.
#define	kRasterTypeNotSupportedErr   'RTYP'
	See AIRasterSuite.
#define	kRasterSpecifiedErr   'RSPE'
	Raster has already been specified.
#define	kRasterBitsPerPixelsNotSupportedErr   'RBIT'
	Raster bits-per-pixel not supported.
#define	kRasterLinkFileNotFoundErr   'RFNF'
	See AIRasterSuite.
#define	kRasterLinkPluginNotFoundErr   'RPNF'
	See AIRasterSuite.
#define	kRasterScratchDiskFullErr   'RFUL'
	See AIRasterSuite.
Enumerations
enum	AIRasterFlags { kRasterMaskImageType = 0x0002, kRasterInvertBits = 0x0004, kRasterGraySubtractive = 0x0008 }
	Options for raster data, bit flags for AIRasterRecord::flags. More...
enum	AIRasterColorSpace {   kColorSpaceHasAlpha = 0x10, kGrayColorSpace = 0, kRGBColorSpace = 1, kCMYKColorSpace = 2,   kLabColorSpace = 3, kSeparationColorSpace = 4, kNChannelColorSpace = 5, kIndexedColorSpace = 6,   kAlphaGrayColorSpace = (kGrayColorSpace | kColorSpaceHasAlpha), kAlphaRGBColorSpace = (kRGBColorSpace | kColorSpaceHasAlpha), kAlphaCMYKColorSpace = (kCMYKColorSpace | kColorSpaceHasAlpha), kAlphaLabColorSpace = (kLabColorSpace | kColorSpaceHasAlpha),   kAlphaSeparationColorSpace = (kSeparationColorSpace | kColorSpaceHasAlpha), kAlphaNChannelColorSpace = (kNChannelColorSpace | kColorSpaceHasAlpha), kAlphaIndexedColorSpace = (kIndexedColorSpace | kColorSpaceHasAlpha), kInvalidColorSpace = 0xFF }
	Color models for raster data. More...
enum	AIRasterLinkState { kAIRasterLinked = 0, kAIRasterEmbedded = 1 }
	Link states for AIRasterLink::linkstate. More...
enum	AIRasterDataState { kAIRasterNoData = 0, kAIRasterLinkData = 1, kAIRasterEditedData = 2 }
	Data states for AIRasterLink::datastate. More...
enum	AIResolveRasterLinkFlags {   kAIResolveCheckExternal = (1<<0), kAIResolveCheckFile = (1<<1), kAIResolveVerbose = (1<<2), kAIResolveReplace = (1<<3),   kAIResolveSearch = (1<<4) }
	Flags for AIRasterSuite::ResolveRasterLink(). More...
enum	AISplitRasterFlags { kAISplitRasterStandard = 0x0000, kAISplitRasterSeparateProcess = 0x0001 }
	Flags for AIRasterSuite::SplitChannels(). More...

---

Detailed Description

---

Define Documentation

#define kAIRasterSuite   "AI Raster Suite"

#define kAIRasterSuiteVersion   kAIRasterSuiteVersion10

#define kAIRasterSuiteVersion10   AIAPI_VERSION(10)

#define kAIRasterVersion   kAIRasterSuiteVersion

#define kMaxChannels   32

Maximum number of channels per image pixel.

#define kMaxSpotChannels   27

Maximum number of spot color channels per image pixel.

---

Enumeration Type Documentation

enum AIRasterColorSpace

Color models for raster data.

Enumerator:

kColorSpaceHasAlpha	Flag indicating that the color model has an alpha channel. The alpha component appears after the color components.
kGrayColorSpace	Each pixel value for a gray color space has a single component describing a grayscale value. The gray color space is additive so the minimum value represents black and the maximum represents white.
kRGBColorSpace	Each pixel value for a RGB color space has three components which represent red, green and blue respectively. The RGB color space is additive.
kCMYKColorSpace	Each pixel value for a CMYK color space has four components which represent cyan, magenta, yellow and black respectively. The CMYK color space is subtractive.
kLabColorSpace	Not valid as an image type; can occur only in placed linked files. See AIPlacedSuite::GetRasterInfo().
kSeparationColorSpace	Each pixel value for a separation color space has a single component describing a tint value. The separation color space is subtractive so the minimum value represents white and the maximum represents black.
kNChannelColorSpace	Each pixel value for an NChannel color space has of a variable number of components which represent individual channels in the NChannel color space. The process components of the color space could be either additive or subtractive. The spot components of the color space are subtractive.
kIndexedColorSpace	Each pixel value for an indexed color space has a single component describing an index value into a color lookup table. The number of components in the color lookup table depends on the base color space of the indexed color space.
kAlphaGrayColorSpace	A gray color space with an alpha channel.
kAlphaRGBColorSpace	An RGB color space with an alpha channel.
kAlphaCMYKColorSpace	A CMYK color space with an alpha channel.
kAlphaLabColorSpace	A LAB color space with an alpha channel.
kAlphaSeparationColorSpace	A separation color space with an alpha channel.
kAlphaNChannelColorSpace	An NChannel color space with an alpha channel.
kAlphaIndexedColorSpace	An indexed color space with an alpha channel.
kInvalidColorSpace

enum AIRasterDataState

Data states for AIRasterLink::datastate.

Direct linking of images is deprecated (although still supported). Create linked objects using the AIPlacedSuite.

Enumerator:

kAIRasterNoData	No data is available for the image (for example, when a document is opened and the linked file cannot be found).
kAIRasterLinkData	Data is available and is the same data that was read from the linked file (that is, it has not been modified since being read).
kAIRasterEditedData	Data is available and it has been modified since it was read from the file (for example, a Photoshop filter might have been run on the image).

enum AIRasterFlags

Options for raster data, bit flags for AIRasterRecord::flags.

Enumerator:

kRasterMaskImageType	Used only for 1-bit gray images. When set, the 1-bit data is to be used as a mask. In this case the path style of the image indicates the color that the bits of the image with a value of 1 are painted.
kRasterInvertBits	Used only for 1-bit gray images. Reverses the sense of the component values so that for a gray image 0=white and 1=black and for an image mask the 0 value pixels are painted.
kRasterGraySubtractive	Used only for 8-bit spot color rasters, or 16-bit if there is an extra alpha channel. When set, the gray component values are interpreted in the subtractive color spaces.

enum AIRasterLinkState

Link states for AIRasterLink::linkstate.

Direct linking of images is deprecated (although still supported). Create linked objects using the AIPlacedSuite.

Enumerator:

kAIRasterLinked	The image is linked; when saving native round-trip information, image data is not saved into the file.
kAIRasterEmbedded	The image is embedded; when saving native round-trip information, image data is saved with the file.

enum AIResolveRasterLinkFlags

Flags for AIRasterSuite::ResolveRasterLink().

Direct linking of images is deprecated (although still supported). Create linked objects using the AIPlacedSuite.

Enumerator:

kAIResolveCheckExternal	Only update if the data is not embedded.
kAIResolveCheckFile	Only update if the file has changed.
kAIResolveVerbose	Report errors to user and show progress.
kAIResolveReplace	Allow a replacement file to be selected in case of error.
kAIResolveSearch	Do automatic searching for a replacement.

enum AISplitRasterFlags

Flags for AIRasterSuite::SplitChannels().

Enumerator:

kAISplitRasterStandard	Decompose the original raster into an array of rasters specified in the standard color spaces (Gray, RGB, CMYK and spot Separation). If the original raster contains a partial set of CMYK process colors, it is expanded to the full process colors.
kAISplitRasterSeparateProcess	Decompose the CMYK process channels of the original raster into individual process Separation color spaces. If the original raster contains a partial set of CMYK process colors, is not expanded to the full process channels.