AIMask.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIArtStyle.h"
#include "AIDictionary.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIBlendStyleSuite
	This suite provides function for working with blend styles. More...
struct	AIMaskSuite
	This suite provides functions to access the opacity mask that can be associated with an art object. More...
Defines
#define	kAIBlendStyleSuite   "AI Blend Style Suite"
#define	kAIBlendStyleSuiteVersion5   AIAPI_VERSION(5)
#define	kAIBlendStyleSuiteVersion   kAIBlendStyleSuiteVersion5
#define	kAIBlendStyleVersion   kAIBlendStyleSuiteVersion
#define	kAIMaskSuite   "AI Mask Suite"
#define	kAIMaskSuiteVersion5   AIAPI_VERSION(5)
#define	kAIMaskSuiteVersion   kAIMaskSuiteVersion5
#define	kAIMaskVersion   kAIMaskSuiteVersion
#define	kAIBlendModeKey   "Mode"
	Dictionary key for mode of a blend style, contains AIBlendingModeValues.
#define	kAIBlendOpacityKey   "Opacity"
	Dictionary key for opacity of a blend style, contains an AIReal value in the range [0..1].
#define	kAIBlendIsolatedKey   "Isolated"
	Dictionary key for isolation state of a blend style, contains a boolean value.
#define	kAIBlendKnockoutKey   "Knockout"
	Dictionary key for knockout state of a blend style, contains an AIKnockout value.
#define	kAIBlendAlphaIsShapeKey   "AlphaIsShape"
	Dictionary key for alpha state of a blend style, contains a boolean value.
Typedefs
typedef struct _AIMask *	AIMaskRef
	An opaque reference to a mask.
typedef ai::int32	AIBlendingMode
	The various blending modes that can be used to composite an object.
Enumerations
enum	AIBlendingModeValues {   kAINormalBlendingMode = 0, kAIMultiplyBlendingMode = 1, kAIScreenBlendingMode = 2, kAIOverlayBlendingMode = 3,   kAISoftLightBlendingMode = 4, kAIHardLightBlendingMode = 5, kAIColorDodgeBlendingMode = 6, kAIColorBurnBlendingMode = 7,   kAIDarkenBlendingMode = 8, kAILightenBlendingMode = 9, kAIDifferenceBlendingMode = 10, kAIExclusionBlendingMode = 11,   kAIHueBlendingMode = 12, kAISaturationBlendingMode = 13, kAIColorBlendingMode = 14, kAILuminosityBlendingMode = 15,   kAINumBlendingModes = 16 }
	Values for AIBlendingMode. More...
enum	AIKnockout { kAIKnockoutUnknown = -1, kAIKnockoutOff = 0, kAIKnockoutOn, kAIKnockoutInherit }
	Knockout tri-state. More...

---

Define Documentation

#define kAIBlendStyleSuite   "AI Blend Style Suite"

#define kAIBlendStyleSuiteVersion   kAIBlendStyleSuiteVersion5

#define kAIBlendStyleSuiteVersion5   AIAPI_VERSION(5)

#define kAIBlendStyleVersion   kAIBlendStyleSuiteVersion

#define kAIMaskSuite   "AI Mask Suite"

#define kAIMaskSuiteVersion   kAIMaskSuiteVersion5

#define kAIMaskSuiteVersion5   AIAPI_VERSION(5)

#define kAIMaskVersion   kAIMaskSuiteVersion

---

Typedef Documentation

typedef ai::int32 AIBlendingMode

The various blending modes that can be used to composite an object.

These modes correspond to the ones in Photoshop. See AIBlendingModeValues.

typedef struct _AIMask* AIMaskRef

An opaque reference to a mask.

There is a one-to-one correspondence between objects and masks.

---

Enumeration Type Documentation

enum AIBlendingModeValues

Values for AIBlendingMode.

Enumerator:

kAINormalBlendingMode
kAIMultiplyBlendingMode
kAIScreenBlendingMode
kAIOverlayBlendingMode
kAISoftLightBlendingMode
kAIHardLightBlendingMode
kAIColorDodgeBlendingMode
kAIColorBurnBlendingMode
kAIDarkenBlendingMode
kAILightenBlendingMode
kAIDifferenceBlendingMode
kAIExclusionBlendingMode
kAIHueBlendingMode
kAISaturationBlendingMode
kAIColorBlendingMode
kAILuminosityBlendingMode
kAINumBlendingModes

enum AIKnockout

Knockout tri-state.

Enumerator:

kAIKnockoutUnknown
kAIKnockoutOff	No knockout.
kAIKnockoutOn	Knockout.
kAIKnockoutInherit	Use parent's knockout value.