Skip to content

LiteFX

LiteFX::Rendering::Backends::VulkanTopLevelAccelerationStructure

`LiteFX::Rendering::Backends::VulkanTopLevelAccelerationStructure`¶

Implements a Vulkan top-level acceleration structure (TLAS).

Synopsis¶

Declared in <litefx/backends/vulkan.hpp>

class [[dllimport, dllexport]] VulkanTopLevelAccelerationStructure final
    : public ITopLevelAccelerationStructure
    , public virtual IVulkanAccelerationStructure
    , public virtual StateResource
    , public virtual Resource<VkAccelerationStructureKHR>

Base Classes¶

Name	Description
`ITopLevelAccelerationStructure`	A structure that stores the instance data for a `IBottomLevelAccelerationStructure`.
`IVulkanAccelerationStructure`	Represents the base interface for a Vulkan acceleration structure implementation.
`StateResource`	Base class for a resource that can be identified by a name string within a `DeviceState`.
`Resource<VkAccelerationStructureKHR>`	Implements the `IResource` interface.

Types¶

Name	Description
`Instance`	Represents an instance of an `IBottomLevelAccelerationStructure`.

Type Aliases¶

Name
`handle_type`

Member Functions¶

Name	Description
`VulkanTopLevelAccelerationStructure` [constructor]	Initializes a new Vulkan top-level acceleration structure (BLAS).
`~VulkanTopLevelAccelerationStructure` [destructor] [virtual]	Destructor
`operator=`	Assignment operators
`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.
`handle` [virtual]	Returns the resource managed by the class.
`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`	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¶

Name	Description
`operator=`	Assignment operators
`handle` [virtual]	Returns the resource managed by the class.
`name`	Returns the name of the resource.

Friends¶

Name	Description
`LiteFX::Rendering::Backends::VulkanCommandBuffer`	Records commands for a `VulkanQueue`
`LiteFX::Rendering::Backends::VulkanDevice`	Implements a Vulkan graphics device.
`LiteFX::Rendering::Backends::VulkanTopLevelAccelerationStructure::VulkanTopLevelAccelerationStructureImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.

See Also¶

VulkanBottomLevelAccelerationStructure