xiiGALBottomLevelASVulkan Class Reference

Inheritance diagram for xiiGALBottomLevelASVulkan:

Public Member Functions
virtual xiiUInt32	GetGeometryDescriptionIndex (xiiStringView sName) const override final
	This returns the geometry description index in the BLAS triangle or axis-aligned bounding box descriptions.
virtual xiiUInt32	GetGeometryIndex (xiiStringView sName) const override final
	This returns the geometry index that can be used in a shader binding table.
virtual xiiUInt32	GetActualGeometryCount () const override final
	This returns the geometry count that was used to build the acceleration structure.
virtual xiiGALScratchBufferSizeDescription	GetScratchBufferSizeDescription () const override final
	This returns the scratch buffer information for the current acceleration structure.
Public Member Functions inherited from xiiGALBottomLevelAS
XII_ALWAYS_INLINE const xiiGALBottomLevelASCreationDescription &	GetDescription () const
	This returns the creation description for this object.
Public Member Functions inherited from xiiGALResource
virtual void	SetResourceState (xiiBitflags< xiiGALResourceStateFlags > stateFlags)
	This sets the buffer usage state.
virtual XII_ALWAYS_INLINE xiiBitflags< xiiGALResourceStateFlags >	GetResourceState () const
	This returns the buffer state.
XII_ALWAYS_INLINE bool	IsInKnownState () const
	This returns true if the resource is in known state by the engine.
XII_ALWAYS_INLINE bool	CheckState (xiiBitflags< xiiGALResourceStateFlags > resourceState) const
	This returns true if the given resource state is set.
XII_ALWAYS_INLINE bool	CheckAnyState (xiiBitflags< xiiGALResourceStateFlags > resourceState) const
	This returns true if any of the given resource state are set.
Public Member Functions inherited from xiiGALDeviceObject
XII_ALWAYS_INLINE xiiSharedPtr< xiiGALDevice >	GetDevice () const
	Returns the xiiGALDevice that created this resource.
Public Member Functions inherited from xiiGALObject
XII_ALWAYS_INLINE xiiStringView	GetDebugName () const
	Returns the debug name of this resource.
void	SetDebugName (xiiStringView sDebugName) const
	Sets the debug name for this resource.
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.
Public Member Functions inherited from xiiRefCounted
virtual	~xiiRefCounted ()=default
	Adds a virtual destructor.
Public Member Functions inherited from xiiRefCountingImpl
	xiiRefCountingImpl ()=default
	Constructor.
	xiiRefCountingImpl (const xiiRefCountingImpl &rhs)
void	operator= (const xiiRefCountingImpl &rhs)
xiiUInt32	AddRef () const
	Increments the reference counter. Returns the new reference count.
xiiUInt32	ReleaseRef () const
	Decrements the reference counter. Returns the new reference count.
bool	IsReferenced () const
	Returns true if the reference count is greater than 0, false otherwise.
xiiUInt32	GetRefCount () const
	Returns the current reference count.

Protected Member Functions
	xiiGALBottomLevelASVulkan (xiiSharedPtr< xiiGALDeviceVulkan > pDeviceVulkan, const xiiGALBottomLevelASCreationDescription &creationDescription)
virtual xiiResult	InitPlatform () override final
virtual void	SetDebugNamePlatform (xiiStringView sName) const override final
Protected Member Functions inherited from xiiGALBottomLevelAS
	xiiGALBottomLevelAS (xiiSharedPtr< xiiGALDevice > pDevice, const xiiGALBottomLevelASCreationDescription &creationDescription)
Protected Member Functions inherited from xiiGALResource
	xiiGALResource (xiiSharedPtr< xiiGALDevice > pDevice)
Protected Member Functions inherited from xiiGALDeviceObject
	xiiGALDeviceObject (xiiSharedPtr< xiiGALDevice > pDevice)

Friends
class	xiiGALDeviceVulkan
class	xiiMemoryUtils

Additional Inherited Members
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()
Protected Attributes inherited from xiiGALBottomLevelAS
xiiGALBottomLevelASCreationDescription	m_Description
Protected Attributes inherited from xiiGALResource
xiiBitflags< xiiGALResourceStateFlags >	m_ResourceState
Protected Attributes inherited from xiiGALDeviceObject
xiiSharedPtr< xiiGALDevice >	m_pDevice

Member Function Documentation

GetActualGeometryCount()

xiiUInt32 xiiGALBottomLevelASVulkan::GetActualGeometryCount ( ) const

finaloverridevirtual

This returns the geometry count that was used to build the acceleration structure.

Returns

The number of geometries that was used to build the acceleration structure.

Note

Access to the BLAS must be externally synchronized.

Implements xiiGALBottomLevelAS.

GetGeometryDescriptionIndex()

xiiUInt32 xiiGALBottomLevelASVulkan::GetGeometryDescriptionIndex ( xiiStringView sName ) const

finaloverridevirtual

This returns the geometry description index in the BLAS triangle or axis-aligned bounding box descriptions.

Parameters

sName

- The geometry name that is specified in the BLAS triangle or axis-aligned bounding box descriptions.

Returns

The geometry the index or xiiInvalidIndex if the geometry does not exist.

Note

Access to the BLAS must be externally synchronized.

Implements xiiGALBottomLevelAS.

GetGeometryIndex()

xiiUInt32 xiiGALBottomLevelASVulkan::GetGeometryIndex ( xiiStringView sName ) const

finaloverridevirtual

This returns the geometry index that can be used in a shader binding table.

Parameters

sName

- The geometry name that is specified in the BLAS triangle or axis-aligned bounding box descriptions.

Returns

The geometry index or xiiInvalidIndex if the geometry does not exist.

Note

Access to the BLAS must be externally synchronized.

Implements xiiGALBottomLevelAS.

GetScratchBufferSizeDescription()

xiiGALScratchBufferSizeDescription xiiGALBottomLevelASVulkan::GetScratchBufferSizeDescription ( ) const

finaloverridevirtual

This returns the scratch buffer information for the current acceleration structure.

Returns

The scratch buffer size description, see xiiGALScratchBufferSizeDescription.

Implements xiiGALBottomLevelAS.

InitPlatform()

xiiResult xiiGALBottomLevelASVulkan::InitPlatform ( )

finaloverrideprotectedvirtual

Implements xiiGALBottomLevelAS.

SetDebugNamePlatform()

void xiiGALBottomLevelASVulkan::SetDebugNamePlatform ( xiiStringView sName ) const

finaloverrideprotectedvirtual

Reimplemented from xiiGALObject.

---

The documentation for this class was generated from the following files:

• /home/runner/work/XII/XII/Source/Engine/GraphicsVulkan/Resources/BottomLevelASVulkan.h
• /home/runner/work/XII/XII/Source/Engine/GraphicsVulkan/Resources/Implementation/BottomLevelASVulkan.cpp