Class RaytracingViewSettings

Settings used for controlling raytracer rendering for a particular view.

Index

Constructors

Properties

_denoiseFilter _isAIDenoiseColorOnlyEnabled _medianDenoiseRadius

Accessors

denoiseFilter isAIDenoiseColorOnlyEnabled medianDenoiseRadius

Methods

assign clone isEqual isEqual

Constructors

constructor

new RaytracingViewSettings(denoiseFilter?, isAIDenoiseColorOnlyEnabled?, medianDenoiseRadius?): RaytracingViewSettings
Parameters
- OptionaldenoiseFilter: EnumValue<RaytracingDenoiseFilter, number>
- OptionalisAIDenoiseColorOnlyEnabled: boolean
- OptionalmedianDenoiseRadius: number
Returns RaytracingViewSettings

Properties

`Protected`_denoiseFilter

_denoiseFilter: EnumValue<RaytracingDenoiseFilter, number>

`Protected`_isAIDenoiseColorOnlyEnabled

_isAIDenoiseColorOnlyEnabled: boolean

`Protected`_medianDenoiseRadius

_medianDenoiseRadius: number

Accessors

denoiseFilter

get denoiseFilter(): EnumValue<RaytracingDenoiseFilter, number>
Determines which filter to use for removing noise from the generated image.

Returns EnumValue<RaytracingDenoiseFilter, number>
set denoiseFilter(value): void
Parameters
- value: EnumValue<RaytracingDenoiseFilter, number>
Returns void

isAIDenoiseColorOnlyEnabled

get isAIDenoiseColorOnlyEnabled(): boolean
Determines if the AI denoise filter will use a color-only input, or an input consisting of color, albedo, normals and depth. Only relevant if DenoiseFilter is set to RaytracingDenoiseFilter::AI.

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

medianDenoiseRadius

get medianDenoiseRadius(): number
Radius of the filter window, in range [0, 2]. Larger values will cause the filter to visit neighboring pixels further away when calculating the current pixel median.

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

Methods

assign

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

clone

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

Returns RaytracingViewSettings

isEqual

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

`Static`isEqual

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