class render::DecalProxy

Render-thread representation of a decal, stored in packed arrays in DecalObjectStorageBase.

Public

Methods

GetTransform

const Transform &GetTransform() const

Returns the world space transform of the decal.

GetWorldTransformMatrix

const Matrix4 &GetWorldTransformMatrix() const

Returns the world space transform matrix for the decal.

GetWorldTransformMatrixWithoutScale

const Matrix4 &GetWorldTransformMatrixWithoutScale() const

Returns the world space transform matrix without scale for the decal.

GetWorldSize

Vector2 GetWorldSize() const

Returns the decal size in world space, accounting for the scene object's scale.

GetWorldMaxDistance

float GetWorldMaxDistance() const

Returns the max distance in world space, accounting for the scene object's scale.

GetBounds

Bounds GetBounds() const

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

SetRendererId

void SetRendererId(PackedRendererId id)

Sets the renderer-assigned packed slot ID.

GetRendererId

PackedRendererId GetRendererId() const

Returns the renderer-assigned packed slot ID.

GetSize

Vector2 GetSize() const

Width and height of the decal.

GetMaterial

const MaterialType &GetMaterial() const

Determines the material to use when rendering the decal.

GetMaxDistance

float GetMaxDistance() const

Determines the maximum distance (from its origin) at which the decal is displayed.

GetLayerMask

u32 GetLayerMask() const

Bitfield that allows you to mask on which objects will the decal be projected onto.

Only objects with the matching layers will be projected onto. Note that decal layer mask only supports 32-bits and objects with layers in bits >= 32 will always be projected onto.

GetLayer

u64 GetLayer() const

Determines the layer that controls whether a system is considered visible in a specific camera.

Layer must match camera layer bitfield in order for the camera to render the decal.

Protected

Methods

GetDecalData

const TDecalData<true> &GetDecalData() const

Fields

mData

TDecalData<true> mData

mTransform

Transform mTransform

mWorldTransformMatrix

Matrix4 mWorldTransformMatrix

mWorldTransformMatrixWithoutScale

Matrix4 mWorldTransformMatrixWithoutScale

mBounds

Bounds mBounds

mRendererId

PackedRendererId mRendererId