Most visited

Recently visited

RendererConfiguration

public class RendererConfiguration
extends Object

java.lang.Object
   ↳ com.viro.core.RendererConfiguration


RendererConfiguration allows you to set which rendering properties and algorithms will be enabled at launch. These properties may also be dynamically turned on or off via the ViroView.

Summary

Public constructors

RendererConfiguration()

Create a new default RendererConfiguration.

Public methods

boolean isBloomEnabled()

Returns true if bloom is enabled for this configuration.

boolean isHDREnabled()

Returns true if HDR rendering is enabled for this configuration.

boolean isPBREnabled()

Returns true if physically-based rendering is enabled for this configuration.

boolean isShadowsEnabled()

Returns true if dynamic shadows are enabled for this configuration.

void setBloomEnabled(boolean enabled)

Enable or disable bloom.

void setHDREnabled(boolean enabled)

When HDR rendering is enabled, Viro uses a deeper color space and renders to a floating point texture, where a tone-mapping algorithm is applied to preserve fine details in both bright and dark regions of the scene.

void setPBREnabled(boolean enabled)

Enable or disable physically-based rendering.

void setShadowsEnabled(boolean enabled)

Enable or disable rendering dynamic shadows.

Public constructors

RendererConfiguration

RendererConfiguration ()

Create a new default RendererConfiguration. The default RendererConfiguration enables the highest fidelity rendering supported by the current device: shadows, HDR, PBR, and bloom.

Public methods

isBloomEnabled

boolean isBloomEnabled ()

Returns true if bloom is enabled for this configuration.

Returns
boolean True if bloom is enabled.

isHDREnabled

boolean isHDREnabled ()

Returns true if HDR rendering is enabled for this configuration.

Returns
boolean True if HDR is enabled.

isPBREnabled

boolean isPBREnabled ()

Returns true if physically-based rendering is enabled for this configuration.

Returns
boolean True if PBR is enabled.

isShadowsEnabled

boolean isShadowsEnabled ()

Returns true if dynamic shadows are enabled for this configuration.

Returns
boolean True if shadows are enabled.

setBloomEnabled

void setBloomEnabled (boolean enabled)

Enable or disable bloom. Bloom adds a soft glow to bright areas in scene, simulating the way bright highlights appear to the human eye. To make an object bloom, this property must be enabled, and the objects's threshold for bloom must be set via setBloomThreshold(float).

Parameters
enabled boolean: True to enable bloom for this configuration.

setHDREnabled

void setHDREnabled (boolean enabled)

When HDR rendering is enabled, Viro uses a deeper color space and renders to a floating point texture, where a tone-mapping algorithm is applied to preserve fine details in both bright and dark regions of the scene. If HDR is disabled, then features like Bloom and PBR will not work, and tone-mapping will be disabled.

HDR is not supported on all devices.

Parameters
enabled boolean: True to enable HDR for this configuration.

setPBREnabled

void setPBREnabled (boolean enabled)

Enable or disable physically-based rendering. Physically based rendering, or PBR, produces more realistic lighting results for your scenes, and provides a more intuitive workflow for artists. To use PBR, this property must be enabled, and Materials must use the PHYSICALLY_BASED lighting model. PBR is controlled by a variety of properties, see PHYSICALLY_BASED for details.

Parameters
enabled boolean: True to enable PBR for this configuration.

setShadowsEnabled

void setShadowsEnabled (boolean enabled)

Enable or disable rendering dynamic shadows. If shadows are disabled here, shadow casting Lights will simply not cast a shadow.

Shadows are not supported on all devices.

Parameters
enabled boolean: True to enable dynamic shadows for this configuration.

Hooray!