Skip to content

LiteFX::Rendering::ITopLevelAccelerationStructure

A structure that stores the instance data for a IBottomLevelAccelerationStructure.

Synopsis

Declared in <litefx/rendering_api.hpp>

class [[dllimport, dllexport]] ITopLevelAccelerationStructure
    : public virtual IAccelerationStructure

Base Classes

NameDescription
IAccelerationStructureBase interface for a ray tracing acceleration structure.

Types

NameDescription
Instance Represents an instance of an IBottomLevelAccelerationStructure.

Member Functions

NameDescription
~ITopLevelAccelerationStructure [destructor] [virtual]Destructor
addInstance Adds an instance to the TLAS.
buffer Returns the acceleration structure backing buffer, that stores its last build.
build Performs a complete build of the acceleration structure.
clear [virtual]Clears all instances from the acceleration structure.
copy Copies the acceleration structure into the acceleration structure provided by destination.
flags [virtual]Returns the flags that control how the acceleration structure should be built.
instances [virtual]Returns an array of instances in the TLAS.
name [virtual]Returns the name of the resource.
offset [virtual]Returns the offset into buffer at which the acceleration structure is stored.
remove [virtual]Removes an instance from the acceleration structure.
size [virtual]Returns the amount of memory in bytes inside buffer that store the acceleration structure.
update Performs an update on the acceleration structure.
withInstance Adds an instance to the current TLAS.

Protected Member Functions

NameDescription
ITopLevelAccelerationStructure [constructor]Constructors
operator= Assignment operators

Derived Classes

NameDescription
DirectX12TopLevelAccelerationStructure Implements a DirectX 12 top-level acceleration structure (TLAS).
VulkanTopLevelAccelerationStructure Implements a Vulkan top-level acceleration structure (TLAS).

See Also

IBottomLevelAccelerationStructure