Class ChromaticAberrationSettings

Settings that control the chromatic aberration effect.

Index

Constructors

Properties

_fringeTexture _isEnabled _shiftAmount _type

Accessors

fringeTexture isEnabled shiftAmount type

Methods

assign clone isEqual isEqual

Constructors

constructor

new ChromaticAberrationSettings(fringeTexture?, isEnabled?, type?, shiftAmount?): ChromaticAberrationSettings
Parameters
- OptionalfringeTexture: ResourceHandle<Texture>
- OptionalisEnabled: boolean
- Optionaltype: EnumValue<ChromaticAberrationType, number>
- OptionalshiftAmount: number
Returns ChromaticAberrationSettings

Properties

`Protected`_fringeTexture

_fringeTexture: ResourceHandle<Texture>

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_shiftAmount

_shiftAmount: number

`Protected`_type

_type: EnumValue<ChromaticAberrationType, number>

Accessors

fringeTexture

get fringeTexture(): ResourceHandle<Texture>
Optional texture to apply to generate the channel shift fringe, allowing you to modulate the shifted colors. This texture should be 3x1 size, where the first pixel modules red, second green and third blue channel. If using the complex aberration effect you can use a larger texture, Nx1 size.

Returns ResourceHandle<Texture>
set fringeTexture(value): void
Parameters
- value: ResourceHandle<Texture>
Returns void

isEnabled

get isEnabled(): boolean
Enables or disables the effect.

Returns boolean
set isEnabled(value): void
Parameters
- value: boolean
Returns void

shiftAmount

get shiftAmount(): number
Determines the brightness of the lens flare effect. Value of 1 means the lens flare will be displayed at the same intensity as the scene it was derived from. In range [0, 1], default being 0.05.

Returns number
set shiftAmount(value): void
Parameters
- value: number
Returns void

type

get type(): EnumValue<ChromaticAberrationType, number>
Type of algorithm to use for rendering the effect.

Returns EnumValue<ChromaticAberrationType, number>
set type(value): void
Parameters
- value: EnumValue<ChromaticAberrationType, number>
Returns void

Methods

assign

assign(other): ChromaticAberrationSettings
Copies all properties defined by the prototype of ChromaticAberrationSettings from other to this instance.
Parameters
- other: Immutable<ChromaticAberrationSettings>
Returns ChromaticAberrationSettings

clone

clone(): ChromaticAberrationSettings
Clones this instance and returns a new ChromaticAberrationSettings with identical values.

Returns ChromaticAberrationSettings

isEqual

isEqual(this, other): boolean
Determines if this ChromaticAberrationSettings instance is equal to the other instance.
Parameters
- this: Immutable<ChromaticAberrationSettings>
- other: Immutable<ChromaticAberrationSettings>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both ChromaticAberrationSettings instances are equal.
Parameters
- lhs: Immutable<ChromaticAberrationSettings>
- rhs: Immutable<ChromaticAberrationSettings>
Returns boolean