Class TemporalAASettings

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

Hierarchy

FrameworkObject
- TemporalAASettings

Index

Constructors

Accessors

filterSize isEnabled jitteredPositionCount

Methods

markAsDirty modify

Constructors

`Protected`constructor

new TemporalAASettings(isInternalConstructor?): TemporalAASettings
Parameters
- OptionalisInternalConstructor: boolean
Returns TemporalAASettings
Overrides FrameworkObject.constructor

Accessors

filterSize

get filterSize(): number
Determines the distance between temporal AA samples. Smaller values result in a sharper image.

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

isEnabled

get isEnabled(): boolean
Enables or disables temporal anti-aliasing.

Note: Other settings might effect whether or not the TAA will be effectively computed or not. To check whether or not TAA is actually being processed, use RendererView::isTemporalAntialiasingRequired()

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

jitteredPositionCount

get jitteredPositionCount(): number
Number of different jittered positions to use. Each frame will use one position and subsequent frames will use subsequent positions until this number of reached, at which point the positions start getting re-used from the start.

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

Methods

markAsDirty

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

modify

modify(action): 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.
  - - (): void
    - Returns void
Returns void