Class RaytracingSettings

Settings that control raytracer rendering.

Constructors

  • Parameters

    • OptionalisEnabled: boolean
    • OptionalraytracingConversionTimeSliceUs: number
    • Optionaldevices: EnumValue<RaytracingDevice, number>
    • Optionalsampler: EnumValue<RaytracingSampler, number>
    • OptionalrayMaxDepth: number
    • OptionalrayCastEpsilon: number
    • OptionalmaximumSampleCount: number
    • OptionalradianceClamp: number
    • OptionalisPreviewEnabled: boolean

    Returns RaytracingSettings

Properties

_devices: EnumValue<RaytracingDevice, number>
_isEnabled: boolean
_isPreviewEnabled: boolean
_maximumSampleCount: number
_radianceClamp: number
_rayCastEpsilon: number
_rayMaxDepth: number
_raytracingConversionTimeSliceUs: number
_sampler: EnumValue<RaytracingSampler, number>

Accessors

  • get isEnabled(): boolean
  • When set to true the active scene will be converted into a format that can be utilized by the raytracer. While active any further changes to the scene will be automatically converted as well, which may result in a performance decrease when creating/loading new objects. This feature requires a lot of memory as all meshes and textures need to be duplicated.

    This feature needs to be enabled along with setting the RenderMode to Raytraced on the camera/view in order to activate raytracing rendering.

    When enabled the scene will start undergoing a conversion process, which may be lengthy. Use RaytracingConversionTimeSliceUs value to determine how fast should the conversion proceed, and use Renderer::getRaytracingSceneConversionProgress() to understand how is the conversion progressing.

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isPreviewEnabled(): boolean
  • Renders the first 10 frames at half-resolution to speed up rendering.

    Returns boolean

  • set isPreviewEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get maximumSampleCount(): number
  • Determines the maximum number of samples that will be taken for each pixel. Higher values increase visual quality at a linear increase to rendering time.

    Returns number

  • set maximumSampleCount(value): void
  • Parameters

    • value: number

    Returns void

  • get radianceClamp(): number
  • Limits the maximum intensity (brightness) of samples in the scene. This can be used to prevent extremely bright samples (fireflies). A reasonable range for this value is [1, 25], but may be set outside of the range as required. It is suggested you set it to highest possible value as lower values will reduce overall brightness of the scene.

    Returns number

  • set radianceClamp(value): void
  • Parameters

    • value: number

    Returns void

  • get rayCastEpsilon(): number
  • Ray bias to be used(in scene units).Change this if black self - intersection artifacts seen on geometry. Usually small values are used.

    Returns number

  • set rayCastEpsilon(value): void
  • Parameters

    • value: number

    Returns void

  • get rayMaxDepth(): number
  • Maximum number of times a ray may bounce off a surface to capture reflections. Higher values increase visual quality at the cost of rendering time.

    Returns number

  • set rayMaxDepth(value): void
  • Parameters

    • value: number

    Returns void

  • get raytracingConversionTimeSliceUs(): number
  • Determines the maximum number of microseconds that raytracing conversion is allowed to use every frame. If set to zero the conversion will complete on the same frame it was requested, but will result in rendering halting during that time.

    Returns number

  • set raytracingConversionTimeSliceUs(value): void
  • Parameters

    • value: number

    Returns void

Methods