AIRasterize.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIArtSet.h"
#include "AIColorConversion.h"
#include "AIFixedMath.h"
#include "AIRaster.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIRasterizeSettings
	Rasterization settings are collected into a single structure describing the type of raster desired, resolution, amount of anti-aliasing, and other options. More...
struct	AIRasterizeSuite
	This suite provides functions that allow you to convert any art set (see AIArtSetSuite) into a single image, represented by a standard raster art object (an art object of type kRasterArt). More...
Defines
#define	kAIRasterizeSuite   "AI Rasterize Suite"
#define	kAIRasterizeSuiteVersion12   AIAPI_VERSION(12)
#define	kAIRasterizeSuiteVersion   kAIRasterizeSuiteVersion12
#define	kAIRasterizeVersion   kAIRasterizeSuiteVersion
#define	kAIRasterizeDefaultAntialiasing   2
	The default anti-aliasing factor when rasterizing with anti-aliasing.
#define	kAIAutoRasterSettingsKey   "AI Auto Rasterize"
	Key for the Live Effect rasterization parameter dictionary, stored in the document dictionary.
#define	kDefaultRasterizeType   "colr"
	Default setting for automatic rasterization.
#define	kDefaultRasterizeDPI   "dpi."
	Default setting for automatic rasterization.
#define	kDefaultRasterizeAlias   "alis"
	Default setting for automatic rasterization.
#define	kDefaultRasterizePreserveSpot   "spot"
	Default setting for automatic rasterization.
#define	kDefaultRasterizeMask   "mask"
	Default setting for automatic rasterization.
#define	kDefaultRasterizePadding   "padd"
	Default setting for automatic rasterization.
#define	kRasterizePrefPrefix   "Rasterize/Defaults"
	If the document does not have auto-rasterize settings specified in the document dictionary (see kAIAutoRasterSettingsKey), use the values stored in the application preferences under this key.
#define	kAIRasterizeTooWideErr   'R2Wd'
	Returned when attempting to rasterize artwork with settings that exceed the maximum width.
Typedefs
typedef AIAPI AIBoolean(*	AIRasterizeProgressProc )(ai::int32 current, ai::int32 total)
	Progress callback function prototype for rasterization.
Enumerations
enum	AIRasterizeType {   kRasterizeRGB = 0, kRasterizeCMYK, kRasterizeGrayscale, kRasterizeBitmap,   kRasterizeARGB, kRasterizeACMYK, kRasterizeAGrayscale, kRasterizeABitmap,   kRasterizeSeparation, kRasterizeASeparation, kRasterizeNChannel, kRasterizeANChannel }
	The desired color model and opacity of generated raster art. More...
enum	AIRasterizeOptions {   kRasterizeOptionsNone = 0, kRasterizeOptionsDoLayers = 1<<0, kRasterizeOptionsAgainstBlack = 1<<1, kRasterizeOptionsDontAlign = 1<<2,   kRasterizeOptionsOutlineText = 1<<3, kRasterizeOptionsHinted = 1<<4, kRasterizeOptionsUseEffectsRes = 1<<5, kRasterizeOptionsUseMinTiles = 1<<6,   kRasterizeOptionsCMYKWhiteMatting = 1<<7, kRasterizeOptionsSpotColorRasterOk = 1<<8, kRasterizeOptionsNChannelOk = 1<<9, kFillBlackAndIgnoreTransparancy = 1<<10 }
	Options for how to perform rasterization. More...
enum	AIResamplingType { kSubsample = 0, kDownsample, kBicubicDownsample }
	The image resampling method for AIRasterizeSuite::ImageResample(). More...

---

Detailed Description

---

Define Documentation

#define kAIRasterizeDefaultAntialiasing   2

The default anti-aliasing factor when rasterizing with anti-aliasing.

#define kAIRasterizeSuite   "AI Rasterize Suite"

#define kAIRasterizeSuiteVersion   kAIRasterizeSuiteVersion12

#define kAIRasterizeSuiteVersion12   AIAPI_VERSION(12)

#define kAIRasterizeVersion   kAIRasterizeSuiteVersion

#define kRasterizePrefPrefix   "Rasterize/Defaults"

If the document does not have auto-rasterize settings specified in the document dictionary (see kAIAutoRasterSettingsKey), use the values stored in the application preferences under this key.

---

Typedef Documentation

typedef AIAPI AIBoolean(* AIRasterizeProgressProc)(ai::int32 current, ai::int32 total)

Progress callback function prototype for rasterization.

You can supply this procedure to display a progress bar during a lengthy operation.

Parameters:

	current	The index of the current tile being rasterized.
	total	The total number of tiles to be rasterized.

Returns:

False to cancel the operation; otherwise true.

---

Enumeration Type Documentation

enum AIRasterizeOptions

Options for how to perform rasterization.

Bit flags can be combined with logical OR.

Enumerator:

kRasterizeOptionsNone	Clear all options.
kRasterizeOptionsDoLayers	When set, incorporates layer attributes (such as opacity and blend mode) into the raster result. Otherwise, ignores layers in the input set.
kRasterizeOptionsAgainstBlack	When set, rasterize against a black background, rather than white.
kRasterizeOptionsDontAlign	When set, does not align 72 dpi images to the pixel grid.
kRasterizeOptionsOutlineText	When set, converts text to outlines before rasterizing it.
kRasterizeOptionsHinted	When set, does not supersamples; preserves type hinting.
kRasterizeOptionsUseEffectsRes	When set, uses the Document Raster Effects Settings resolution.
kRasterizeOptionsUseMinTiles	When set, uses a minimum of 5 tiles when rasterizing with anti-alias on (useful for better user feedback on progress bars).
kRasterizeOptionsCMYKWhiteMatting	When set, matte transparency with CMYK white.
kRasterizeOptionsSpotColorRasterOk	When set, rasterizes to spot-color raster when a single separation channel is sufficient.
kRasterizeOptionsNChannelOk	When set, rasterization to NChannel image is allowed.
kFillBlackAndIgnoreTransparancy	[Internal] When set, fill path and stroke with black color and ignore transparency

enum AIRasterizeType

The desired color model and opacity of generated raster art.

See AIRasterizeSuite.

Enumerator:

kRasterizeRGB	RGB no alpha.
kRasterizeCMYK	CMYK no alpha.
kRasterizeGrayscale	Grayscale no alpha.
kRasterizeBitmap	opaque bitmap
kRasterizeARGB	RGB with alpha.
kRasterizeACMYK	CMYK with alpha.
kRasterizeAGrayscale	Grayscale with alpha.
kRasterizeABitmap	Bitmap with transparent 0-pixels.
kRasterizeSeparation	Separation no alpha.
kRasterizeASeparation	Separation with alpha.
kRasterizeNChannel	NChannel no alpha.
kRasterizeANChannel	NChannel with alpha.

enum AIResamplingType

The image resampling method for AIRasterizeSuite::ImageResample().

Enumerator:

kSubsample	Default (anti-aliasing off). Fast, lowest quality
kDownsample	Averaging sample (anti-aliasing on). Slower, better quality
kBicubicDownsample	Weighted average sample. Slowest, best quality