Enumeration CompositeOperation

The composite operation defines how path fills and strokes are blended with previously rendered paths.

Constructors

`Protected`constructor

new CompositeOperation(do_not_, construct_, this_, type_): CompositeOperation
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns CompositeOperation

Values

`Static` `Readonly`Copy

Copy = 9

Displays the source image. The destination image is ignored

`Static` `Readonly`DestinationAtop

DestinationAtop = 7

Displays the destination image on top of the source image. The part of the destination image that is outside the source image is not shown

`Static` `Readonly`DestinationIn

DestinationIn = 5

Displays the destination image in to the source image. Only the part of the destination image that is INSIDE the source image is shown, and the source image is transparent

`Static` `Readonly`DestinationOut

DestinationOut = 6

Displays the destination image out of the source image. Only the part of the destination image that is OUTSIDE the source image is shown, and the source image is transparent

`Static` `Readonly`DestinationOver

DestinationOver = 4

Displays the destination image over the source image

`Static` `Readonly`Lighter

Lighter = 8

Displays the source image + the destination image

`Static` `Readonly`SourceAtop

SourceAtop = 3

Displays the source image on top of the destination image. The part of the source image that is outside the destination image is not shown

`Static` `Readonly`SourceIn

SourceIn = 1

Displays the source image in to the destination image. Only the part of the source image that is INSIDE the destination image is shown, and the destination image is transparent

`Static` `Readonly`SourceOut

SourceOut = 2

Displays the source image out of the destination image. Only the part of the source image that is OUTSIDE the destination image is shown, and the destination image is transparent

`Static` `Readonly`SourceOver

SourceOver = 0

Displays the source image over the destination image

`Static` `Readonly`Xor

Xor = 10

The source image is combined by using an exclusive OR with the destination image

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

combineFlags<T>(values): EnumValueTyped<T, number>
Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

getValueAtIndex<T>(index): EnumValueTyped<T, number>
Gets the enumeration value at the specified index.
Type Parameters
- T = number
Parameters
- index: number
  The index.
Returns EnumValueTyped<T, number>
The enumeration value or undefined if not found.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>
Iterates the enumeration values
Type Parameters
- T = any
Returns Generator<EnumValueTyped<T, number>, any, any>
The enumeration values.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

splitFlags<T>(value): EnumValueTyped<T, number>[]
Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enum value to have it's value split using bitwise-and operator.
Returns EnumValueTyped<T, number>[]
An array of each "bit flag" set in the enum.

Enumeration CompositeOperation

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns CompositeOperation

Values

Static ReadonlyCopy

Static ReadonlyDestinationAtop

Static ReadonlyDestinationIn

Static ReadonlyDestinationOut

Static ReadonlyDestinationOver

Static ReadonlyLighter

Static ReadonlySourceAtop

Static ReadonlySourceIn

Static ReadonlySourceOut

Static ReadonlySourceOver

Static ReadonlyXor

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

Parameters

Returns string

Obsolete

StaticgetEnumNames

Returns string[]

Obsolete

StaticgetEnumValue

Parameters

Returns number

Obsolete

StaticgetEnumValues

Returns number[]

Obsolete

StaticgetNameForValue

Type Parameters

Parameters

Returns string

StaticgetNames

Returns string[]

StaticgetValueAtIndex

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetValues

Type Parameters

Returns EnumValueTyped<T, number>[]

StatichasFlag

Type Parameters

Parameters

Returns boolean

StatichasFlagChanged

Type Parameters

Parameters

Returns boolean

StaticiterateNames

Returns Generator<string, any, any>

StaticiterateValues

Type Parameters

Returns Generator<EnumValueTyped<T, number>, any, any>

StaticremoveFlag

Type Parameters

Parameters

Returns K

StaticsplitFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>[]

Settings

`Protected`constructor

`Static` `Readonly`Copy

`Static` `Readonly`DestinationAtop

`Static` `Readonly`DestinationIn

`Static` `Readonly`DestinationOut

`Static` `Readonly`DestinationOver

`Static` `Readonly`Lighter

`Static` `Readonly`SourceAtop

`Static` `Readonly`SourceIn

`Static` `Readonly`SourceOut

`Static` `Readonly`SourceOver

`Static` `Readonly`Xor

`Static`addFlag

`Static`combineFlags

`Static`getEnumName

`Static`getEnumNames

`Static`getEnumValue

`Static`getEnumValues

`Static`getNameForValue

`Static`getNames

`Static`getValueAtIndex

`Static`getValues

`Static`hasFlag

`Static`hasFlagChanged

`Static`iterateNames

`Static`iterateValues

`Static`removeFlag

`Static`splitFlags