Class AlphaChannelUsageSettings

Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

Index

Constructors

Accessors

depthEncodeFar depthEncodeNear mode

Methods

markAsDirty modify

Constructors

`Protected`constructor

new AlphaChannelUsageSettings(
isInternalConstructor?: boolean,
): AlphaChannelUsageSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns AlphaChannelUsageSettings

Overrides FrameworkObject.constructor

Accessors

depthEncodeFar

get depthEncodeFar(): number

Determins the depth value encoded to 0 when writing depth to the alpha channel.

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

depthEncodeNear

get depthEncodeNear(): number

Determins the depth value encoded to 1 when writing depth to the alpha channel.

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

mode

get mode(): EnumValue<AlphaChannelUsageMode>

Controls what to write into the alpha channel of the rendered image.

Returns EnumValue<AlphaChannelUsageMode>
set mode(value: EnumValue<AlphaChannelUsageMode>): void
Parameters
- value: EnumValue<AlphaChannelUsageMode>
Returns void

Methods

markAsDirty

markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action: () => void): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: () => void
  The scope where the object is modified.
Returns void