Skip to content

LiteFX

LiteFX::Rendering::Backends::VulkanBottomLevelAccelerationStructure

`LiteFX::Rendering::Backends::VulkanBottomLevelAccelerationStructure`¶

Implements a Vulkan bottom-level acceleration structure (BLAS).

Synopsis¶

Declared in <litefx/backends/vulkan.hpp>

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

Base Classes¶

Name	Description
`IBottomLevelAccelerationStructure`	A structure that holds a singular entity of geometry for hardware ray-tracing.
`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
`BoundingBoxes`	Stores a buffer that contains axis-aligned bounding boxes.
`TriangleMesh`	Represents a triangle mesh.

Type Aliases¶

Name
`handle_type`

Member Functions¶

Name	Description
`VulkanBottomLevelAccelerationStructure` [constructor]	Initializes a new Vulkan bottom-level acceleration structure (BLAS).
`~VulkanBottomLevelAccelerationStructure` [destructor] [virtual]	Destructor
`operator=`	Assignment operators
`addBoundingBox`	Adds a buffer containing axis-aligned bounding boxes to the BLAS.
`addTriangleMesh`	Adds a triangle mesh to the BLAS.
`boundingBoxes` [virtual]	Returns an array of buffers, each containing axis-aligned bounding boxes stored in the BLAS.
`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 bounding boxes and triangle meshes 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.
`name` [virtual]	Returns the name of the resource.
`offset` [virtual]	Returns the offset into `buffer` at which the acceleration structure is stored.
`remove`	`remove` overloads
`size` [virtual]	Returns the amount of memory in bytes inside `buffer` that store the acceleration structure.
`triangleMeshes` [virtual]	Returns an array of triangle meshes contained by the BLAS.
`update`	Performs an update on the acceleration structure.
`withBoundingBox`	Adds a buffer containing axis-aligned bounding boxes to the BLAS.
`withTriangleMesh`	Adds a triangle mesh to the BLAS.

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::VulkanBottomLevelAccelerationStructure::VulkanBottomLevelAccelerationStructureImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.

See Also¶

VulkanTopLevelAccelerationStructure