class `render::ReflectionProbeProxy`

Inherits: TReflectionProbeGetters<ReflectionProbeProxy, true>

Render-thread representation of a reflection probe, stored in packed arrays in ReflectionProbeObjectStorageBase.

Public

Methods

GetWorldTransform

const Transform &GetWorldTransform() const

Returns the world space transform for the probe.

GetWorldRadius

float GetWorldRadius() const

Returns the radius of a sphere reflection probe, scaled by world transform.

GetWorldExtents

Vector3 GetWorldExtents() const

Returns the extents of a box reflection probe, scaled by world transform.

SetRendererId

void SetRendererId(PackedRendererId id)

Sets the renderer-assigned packed slot ID.

GetRendererId

PackedRendererId GetRendererId() const

Returns the renderer-assigned packed slot ID.

GetReflectionProbeData

const TReflectionProbeData<true> &GetReflectionProbeData() const

Returns the raw reflection probe data (unscaled).

GetType

ReflectionProbeType GetType() const

Determines the type of the probe.

GetRadius

float GetRadius() const

Returns the radius of a sphere reflection probe (unscaled).

GetExtents

const Vector3 &GetExtents() const

Returns the extents of a box reflection probe (unscaled).

GetBounds

Sphere GetBounds() const

Returns world space bounds that completely encompass the probe's area of influence.

GetTransitionDistance

float GetTransitionDistance() const

Determines a distance that will be used for fading out the box reflection probe with distance.

By default it is equal to one, and can never be less than one. Only relevant for box probes.

GetFilteredTexture

const SPtr<TextureType> &GetFilteredTexture() const

Returns a pre-filtered texture that is generated either from the provided custom texture, or from scene capture.