Class Renderer

Exposes global Renderer settings and related functionality to script.

Hierarchy

FrameworkObject
- Renderer

Index

Constructors

Accessors

compatibleRaytracingDevices isRaytracingSceneConversionInProgress raytracingSceneConversionProgress settings

Methods

presentFrameCaptureUI queueFrameCapture

Constructors

`Protected`constructor

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

Accessors

`Static`compatibleRaytracingDevices

get compatibleRaytracingDevices(): Iterable<RaytracingDeviceInfo>
Returns a list of hardware devices that support raytracing.

Returns Iterable<RaytracingDeviceInfo>

`Static`isRaytracingSceneConversionInProgress

get isRaytracingSceneConversionInProgress(): boolean
Returns the current progress of the conversion of the scene to a scene capable of handling raytracing. Progress is reported in range [0, 1] representing the percentage of the progress completed.

See RendererSettings::IsEnabled for more information.

Returns boolean
Note
Thread safe.

`Static`raytracingSceneConversionProgress

get raytracingSceneConversionProgress(): number
Returns the current progress of the conversion of the scene to a scene capable of handling raytracing. Progress is reported in range [0, 1] representing the percentage of the progress completed.

See RendererSettings::IsEnabled for more information.

Returns number
Note
Thread safe.

`Static`settings

get settings(): RendererSettings
Renderer settings that affect all views and scenes.

Returns RendererSettings
set settings(value): void
Parameters
- value: RendererSettings
Returns void

Methods

`Static`presentFrameCaptureUI

presentFrameCaptureUI(): void
Captures a frame for analysis with an external tool. This will capture all rendered scenes and views for that particular frame. Next rendered frame will be captured.

Returns void

`Static`queueFrameCapture

queueFrameCapture(): void
Captures a frame for analysis with an external tool. This will capture all rendered scenes and views for that particular frame. Next rendered frame will be captured.

Returns void