High Fidelity API Reference

Render

• Properties • Methods • Signals • Type Definitions • Method Details • Signal Details •

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

The Render API enables you to configure the graphics engine.

Properties

Name Type Summary
renderMethod Render.RenderMethod

The render method being used.
shadowsEnabled boolean

true if shadows are enabled, false if they're disabled.
ambientOcclusionEnabled boolean

true if ambient occlusion is enabled, false if it's disabled.
antialiasingEnabled boolean

true if anti-aliasing is enabled, false if it's disabled.
viewportResolutionScale number

The view port resolution scale, > 0.0.

Methods

Name Return Value Summary
getAmbientOcclusionEnabled boolean

Gets whether or not ambient occlusion is enabled.
getAntialiasingEnabled boolean

Gets whether or not anti-aliasing is enabled.
getConfig object

Gets the configuration for a rendering job by name.

Warning: For internal, debugging purposes. Subject to change.
getRenderMethod Render.RenderMethod

Gets the render method being used.
getRenderMethodNames Array.<string>

Gets the names of the possible render methods, per Render.RenderMethod.
getShadowsEnabled boolean

Gets whether or not shadows are enabled.
getViewportResolutionScale number

Gets the view port resolution scale.
setAmbientOcclusionEnabled None

Sets whether or not ambient occlusion is enabled.
setAntialiasingEnabled None

Sets whether or not anti-aliasing is enabled.
setRenderMethod None

Sets the render method to use.
setShadowsEnabled None

Sets whether or not shadows are enabled.
setViewportResolutionScale None

Sets the view port resolution scale.

Signals

Name Summary
settingsChanged

Triggered when one of the Render API's properties changes.

Type Definitions

RenderMethod
Type: number

The rendering method is specified by the following values:

ValueNameDescription
0DEFERREDMore complex rendering pipeline where lighting is applied to the scene as a whole after all objects have been rendered.
1FORWARDSimpler rendering pipeline where each object in the scene, in turn, is rendered and has lighting applied.

Method Details

(static) getAmbientOcclusionEnabled( ) → {boolean}
Returns: true if ambient occlusion is enabled, false if it's disabled.

Gets whether or not ambient occlusion is enabled.
(static) getAntialiasingEnabled( ) → {boolean}
Returns: true if anti-aliasing is enabled, false if it's disabled.

Gets whether or not anti-aliasing is enabled.
(static) getConfig( name ) → {object}
Returns: The configuration for the rendering job.

Gets the configuration for a rendering job by name.

Warning: For internal, debugging purposes. Subject to change.

Parameters

Name Type Description
name string

The name of the rendering job.
(static) getRenderMethod( ) → {Render.RenderMethod}
Returns: The render method being used.

Gets the render method being used.

Example

Report the current render method.

var renderMethod = Render.getRenderMethod();
print("Current render method: " + Render.getRenderMethodNames()[renderMethod]);
(static) getRenderMethodNames( ) → {Array.<string>}
Returns: The names of the possible render methods.

Gets the names of the possible render methods, per Render.RenderMethod.

Example

Report the names of the possible render methods.

var renderMethods = Render.getRenderMethodNames();
print("Render methods:");
for (var i = 0; i < renderMethods.length; i++) {
    print("- " + renderMethods[i]);
}
(static) getShadowsEnabled( ) → {boolean}
Returns: true if shadows are enabled, false if they're disabled.

Gets whether or not shadows are enabled.
(static) getViewportResolutionScale( ) → {number}
Returns: The view port resolution scale, > 0.0.

Gets the view port resolution scale.
(static) setAmbientOcclusionEnabled( enabled )

Sets whether or not ambient occlusion is enabled.

Parameters

Name Type Description
enabled boolean

true to enable ambient occlusion, false to disable.
(static) setAntialiasingEnabled( enabled )

Sets whether or not anti-aliasing is enabled.

Parameters

Name Type Description
enabled boolean

true to enable anti-aliasing, false to disable.
(static) setRenderMethod( renderMethod )

Sets the render method to use.

Parameters

Name Type Description
renderMethod Render.RenderMethod

The render method to use.
(static) setShadowsEnabled( enabled )

Sets whether or not shadows are enabled.

Parameters

Name Type Description
enabled boolean

true to enable shadows, false to disable.
(static) setViewportResolutionScale( resolutionScale )

Sets the view port resolution scale.

Parameters

Name Type Description
resolutionScale number

The view port resolution scale to set, > 0.0.

Signal Details

settingsChanged( )
Returns: Signal

Triggered when one of the Render API's properties changes.

Example

Report when a render setting changes.

Render.settingsChanged.connect(function () {
    print("Render setting changed");
});
// Toggle Developer > Render > Shadows or similar to trigger.