Class EffectSettings

Settings that control rendering for a specific camera (view).

The EffectSettings contain all settings structs and should be stored as a ScriptShared<> to be passed between managed and native with the least number of copies. All other settings structs should be marked as PlainType(true).

Hierarchy

  • FrameworkObject
    • EffectSettings

Constructors

  • Parameters

    • OptionalisInternalConstructor: boolean

    Returns EffectSettings

Accessors

  • get cullDistance(): number
  • The absolute base cull-distance for objects rendered through this camera in world units. Objects will use this distance and apply their own factor to it to determine whether they should be visible.

    Returns number

  • set cullDistance(value): void
  • Parameters

    • value: number

    Returns void

  • get exposureScale(): number
  • Log2 value to scale the eye adaptation by (for example 2^0 = 1). Smaller values yield darker image, while larger yield brighter image. Allows you to customize exposure manually, applied on top of automatic or manual exposure. In range [-8, 8].

    Returns number

  • set exposureScale(value): void
  • Parameters

    • value: number

    Returns void

  • get filterMaximumLuminance(): number
  • Threshold over which luminance values will be ignored for purposes of effects such as bloom and lens flare. Allows you to limit flickering by eliminating so called 'fireflies' (high intensity pixels). This value is relative to the average scene luminance if automatic exposure is enabled.

    Returns number

  • set filterMaximumLuminance(value): void
  • Parameters

    • value: number

    Returns void

  • get gamma(): number
  • Gamma value to adjust the image for. Larger values result in a brighter image. When tonemapping is turned on the best gamma curve for the output device is chosen automatically and this value can by used to merely tweak that curve. If tonemapping is turned off this is the exact value of the gamma curve that will be applied.

    Returns number

  • set gamma(value): void
  • Parameters

    • value: number

    Returns void

  • get isDepthPrePassEnabled(): boolean
  • When enabled all opaque geometry will be rendered to the depth buffer before the main rendering pass. This ensures the main render pass is able to quickly reject invisible pixels and thereforce significantly reduce the cost of overdraw.

    Returns boolean

  • set isDepthPrePassEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isFXAAEnabled(): boolean
  • Enables the fast approximate anti-aliasing effect.

    Returns boolean

  • set isFXAAEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isHDREnabled(): boolean
  • High dynamic range allows light intensity to be more correctly recorded when rendering by allowing for a larger range of values. The stored light is then converted into visible color range using exposure and a tone mapping operator.

    Returns boolean

  • set isHDREnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isIndirectDiffuseLightingEnabled(): boolean
  • Determines if indirect lighting (e.g. from light probes or the sky) is rendered.

    Returns boolean

  • set isIndirectDiffuseLightingEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isLightingEnabled(): boolean
  • Determines if scene objects will be lit by lights. If disabled everything will be rendered using their albedo texture with no lighting applied.

    Returns boolean

  • set isLightingEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isRenderingOverlayOnly(): boolean
  • Signals the renderer to only render overlays (like UI), and not scene objects. Such rendering doesn't require depth buffer or multi-sampled render targets and will not render any scene objects. This can improve performance and memory usage for overlay-only views.

    Returns boolean

  • set isRenderingOverlayOnly(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isSkyEnabled(): boolean
  • If enabled the camera will use the skybox for rendering the background. A skybox has to be present in the scene. When disabled the camera will use the clear color for rendering the background.

    Returns boolean

  • set isSkyEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isVelocityBufferEnabled(): boolean
  • Determines if the G-Buffer should contain per-pixel velocity information. This can be useful if you are rendering an effect that requires this information. Note that effects such as motion blur or temporal anti-aliasing might force the velocity buffer to be enabled regardless of this setting.

    Returns boolean

  • set isVelocityBufferEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get whiteBalance(): Immutable<WhiteBalanceSettings>
  • Parameters used for customizing white balancing. White balancing converts a scene illuminated by a light of the specified temperature into a scene illuminated by a standard D65 illuminant (average midday light) in order to simulate the effects of chromatic adaptation of the human visual system.

    Returns Immutable<WhiteBalanceSettings>

  • set whiteBalance(value): void
  • Returns void