Foundation::RHI::VulkanDevice Class Reference

#include <Device.hpp>

Inheritance diagram for Foundation::RHI::VulkanDevice:

Public Member Functions
uint32_t	GetGraphicsQueueFamilyIndex () const
const VulkanApplication &	GetApp () const
Mutex &	GetQueueSubmitMutex () const
	VulkanDevice (VulkanApplication const &app, vk::raii::PhysicalDevice physicalDevice)
	~VulkanDevice () override
RHIDeviceCapabilities	GetCapabilities () const override
RHIPipelineStateCacheKey	GetPipelineCacheKey () const override
RHIDeviceQueue *	GetDeviceQueue (RHIDeviceQueueType type) const override
RHIDeviceScopedHandle< RHISurface >	CreateSurface (RHISurface::SurfaceDesc const &desc) override
RHISurface *	GetSurface (Handle handle) const override
void	DestroySurface (Handle handle) override
RHIDeviceScopedHandle< RHISwapchain >	CreateSwapchain (RHISwapchain::SwapchainDesc const &desc) override
RHISwapchain *	GetSwapchain (Handle handle) const override
void	DestroySwapchain (Handle handle) override
RHIDeviceScopedHandle< RHIPipelineStateCache >	CreatePipelineCache (RHIPipelineStateCache::PipelineStateCacheDesc const &desc) override
RHIPipelineStateCache *	GetPipelineCache (Handle handle) const override
void	DestroyPipelineCache (Handle handle) override
RHIDeviceScopedHandle< RHIPipelineState >	CreatePipelineState (RHIPipelineState::PipelineStateDesc const &desc) override
RHIPipelineState *	GetPipelineState (Handle handle) const override
void	DestroyPipelineState (Handle handle) override
RHIDeviceScopedHandle< RHIShaderModule >	CreateShaderModule (RHIShaderModule::ShaderModuleDesc const &desc) override
RHIShaderModule *	GetShaderModule (Handle handle) const override
void	DestroyShaderModule (Handle handle) override
RHIDeviceScopedHandle< RHICommandPool >	CreateCommandPool (RHICommandPool::PoolDesc desc) override
RHICommandPool *	GetCommandPool (Handle handle) const override
void	DestroyCommandPool (Handle handle) override
RHIDeviceScopedHandle< RHIDeviceSemaphore >	CreateSemaphore (bool is_timeline) override
RHIDeviceSemaphore *	GetSemaphore (Handle handle) const override
void	DestroySemaphore (Handle handle) override
RHIDeviceScopedHandle< RHIDeviceFence >	CreateFence (bool signaled) override
RHIDeviceFence *	GetFence (Handle handle) const override
void	DestroyFence (Handle handle) override
RHIDeviceScopedHandle< RHIBuffer >	CreateBuffer (RHIBufferDesc const &desc) override
RHIBuffer *	GetBuffer (Handle handle) const override
void	DestroyBuffer (Handle handle) override
RHIDeviceScopedHandle< RHITexture >	CreateTexture (RHITextureDesc const &desc) override
RHITexture *	GetTexture (Handle handle) const override
void	DestroyTexture (Handle handle) override
RHIDeviceScopedHandle< RHIAccelerationStructure >	CreateAccelerationStructure (RHIAccelerationStructureDesc const &desc) override
RHIAccelerationStructure *	GetAccelerationStructure (Handle handle) const override
void	DestroyAccelerationStructure (Handle handle) override
RHIDeviceScopedHandle< RHIDeviceDescriptorSetLayout >	CreateDescriptorSetLayout (RHIDeviceDescriptorSetLayoutDesc const &desc) override
RHIDeviceDescriptorSetLayout *	GetDescriptorSetLayout (Handle handle) const override
void	DestroyDescriptorSetLayout (Handle handle) override
RHIDeviceScopedHandle< RHIDeviceDescriptorPool >	CreateDescriptorPool (RHIDeviceDescriptorPool::PoolDesc const &desc) override
RHIDeviceDescriptorPool *	GetDescriptorPool (Handle handle) const override
void	DestroyDescriptorPool (Handle handle) override
RHIDeviceScopedHandle< RHIDeviceSampler >	CreateSampler (RHIDeviceSampler::SamplerDesc const &desc) override
RHIDeviceSampler *	GetSampler (Handle handle) const override
void	DestroySampler (Handle handle) override
RHIDeviceScopedHandle< RHIDeviceQueryPool >	CreateQueryPool (RHIDeviceQueryPool::QueryPoolDesc const &desc) override
RHIDeviceQueryPool *	GetQueryPool (Handle handle) const override
void	DestroyQueryPool (Handle handle) override
RHIDeviceScopedHandle< RHIVirtualAllocator >	CreateVirtualAllocator (uint64_t size) override
RHIVirtualAllocator *	GetVirtualAllocator (Handle handle) const override
void	DestroyVirtualAllocator (Handle handle) override
RHIAccelerationStructureSizeInfo	GetAccelerationStructureSizeInfo (RHIAccelerationStructureBuildDesc const &desc, Allocator *scratchAllocator=nullptr) const override
size_t	WriteAccelerationStructureInstanceData (RHIAccelerationStructureGeometryInstance const &data, void *dest) const override
void	ResetFences (Span< RHIDeviceFence *const > fences) override
bool	WaitForFences (Span< RHIDeviceFence *const > fences, bool wait_all, size_t timeout) override
	Wait for fences to arrive.
void	SignalTimelineSemaphores (Span< const Pair< RHIDeviceSemaphore *, size_t > > semaphores) override
bool	WaitForTimelineSemaphores (Span< const Pair< RHIDeviceSemaphore *, size_t > > semaphores, size_t timeout) override
	Wait for timeline semaphores to reach specified values.
void	WaitIdle () const override
void	QueryBudget (RHIDeviceHeapType heapType, size_t &used, size_t &budget) const override
void	QueryAllocationStats (size_t &blockBytes, size_t &allocationBytes) const override
void	QueryMemoryStats (RHIDeviceMemoryStats &outStats) const override
String	QueryDeviceString () const override
Allocator *	GetAllocator () const
auto const &	GetVkQueues () const
auto const &	GetVkDevice () const
auto const &	GetVkPhysicalDevice () const
auto const &	GetVkPhysicalDeviceProperties () const
auto const &	GetVkAllocator () const
vk::AllocationCallbacks const *	GetVkAllocationCallbacks () const
VkAllocationCallbacks const *	GetVkAllocationCallbacksNative () const
void	DebugSetObjectName (const char *name) override
Public Member Functions inherited from Foundation::RHI::RHIDevice
	RHIDevice (RHIApplication const &app)
Public Member Functions inherited from Foundation::RHI::RHIObject
	RHIObject ()=default
	RHIObject (RHIObject const &)=delete
RHIObject &	operator= (const RHIObject &)=delete
	RHIObject (RHIObject &&)=delete
RHIObject &	operator= (RHIObject &&)=delete
virtual	~RHIObject ()=default

Private Attributes
const VulkanApplication &	mApp
vk::raii::PhysicalDevice	mPhysicalDevice {nullptr}
vk::raii::Device	mDevice {nullptr}
VmaAllocator	mVkAllocator {nullptr}
RHIObjectPool	mStorage
UniquePtr< VulkanDeviceQueues >	mQueues {nullptr}
Mutex	mQueueSubmitMutex
vk::PhysicalDeviceProperties	mPhysicalDeviceProperties {}
RHIPipelineStateCacheKey	mPipelineCacheKey {}
RHIDeviceCapabilities	mDeviceCaps {}
uint32_t	mGraphicsQueueFamilyIndex {}

Additional Inherited Members
Public Attributes inherited from Foundation::RHI::RHIDevice
const RHIApplication &	mApp

Constructor & Destructor Documentation

VulkanDevice()

VulkanDevice::VulkanDevice	(	VulkanApplication const &	app,
		vk::raii::PhysicalDevice	physicalDevice
	)

~VulkanDevice()

VulkanDevice::~VulkanDevice ( )

override

Member Function Documentation

CreateAccelerationStructure()

RHIDeviceScopedHandle< RHIAccelerationStructure > VulkanDevice::CreateAccelerationStructure ( RHIAccelerationStructureDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateBuffer()

RHIDeviceScopedHandle< RHIBuffer > VulkanDevice::CreateBuffer ( RHIBufferDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateCommandPool()

RHIDeviceScopedHandle< RHICommandPool > VulkanDevice::CreateCommandPool ( RHICommandPool::PoolDesc  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateDescriptorPool()

RHIDeviceScopedHandle< RHIDeviceDescriptorPool > VulkanDevice::CreateDescriptorPool ( RHIDeviceDescriptorPool::PoolDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateDescriptorSetLayout()

RHIDeviceScopedHandle< RHIDeviceDescriptorSetLayout > VulkanDevice::CreateDescriptorSetLayout ( RHIDeviceDescriptorSetLayoutDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateFence()

auto VulkanDevice::CreateFence ( bool  signaled )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreatePipelineCache()

RHIDeviceScopedHandle< RHIPipelineStateCache > VulkanDevice::CreatePipelineCache ( RHIPipelineStateCache::PipelineStateCacheDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreatePipelineState()

RHIDeviceScopedHandle< RHIPipelineState > VulkanDevice::CreatePipelineState ( RHIPipelineState::PipelineStateDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateQueryPool()

RHIDeviceScopedHandle< RHIDeviceQueryPool > VulkanDevice::CreateQueryPool ( RHIDeviceQueryPool::QueryPoolDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateSampler()

RHIDeviceScopedHandle< RHIDeviceSampler > VulkanDevice::CreateSampler ( RHIDeviceSampler::SamplerDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateSemaphore()

RHIDeviceScopedHandle< RHIDeviceSemaphore > VulkanDevice::CreateSemaphore ( bool  is_timeline )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateShaderModule()

RHIDeviceScopedHandle< RHIShaderModule > VulkanDevice::CreateShaderModule ( RHIShaderModule::ShaderModuleDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateSurface()

RHIDeviceScopedHandle< RHISurface > VulkanDevice::CreateSurface ( RHISurface::SurfaceDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateSwapchain()

RHIDeviceScopedHandle< RHISwapchain > VulkanDevice::CreateSwapchain ( RHISwapchain::SwapchainDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateTexture()

RHIDeviceScopedHandle< RHITexture > VulkanDevice::CreateTexture ( RHITextureDesc const &  desc )

overridevirtual

Implements Foundation::RHI::RHIDevice.

CreateVirtualAllocator()

RHIDeviceScopedHandle< RHIVirtualAllocator > VulkanDevice::CreateVirtualAllocator ( uint64_t  size )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DebugSetObjectName()

void VulkanDevice::DebugSetObjectName ( const char *  name )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyAccelerationStructure()

void VulkanDevice::DestroyAccelerationStructure ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyBuffer()

void VulkanDevice::DestroyBuffer ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyCommandPool()

void VulkanDevice::DestroyCommandPool ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyDescriptorPool()

void VulkanDevice::DestroyDescriptorPool ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyDescriptorSetLayout()

void VulkanDevice::DestroyDescriptorSetLayout ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyFence()

void VulkanDevice::DestroyFence ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyPipelineCache()

void VulkanDevice::DestroyPipelineCache ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyPipelineState()

void VulkanDevice::DestroyPipelineState ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyQueryPool()

void VulkanDevice::DestroyQueryPool ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroySampler()

void VulkanDevice::DestroySampler ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroySemaphore()

void VulkanDevice::DestroySemaphore ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyShaderModule()

void VulkanDevice::DestroyShaderModule ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroySurface()

void VulkanDevice::DestroySurface ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroySwapchain()

void VulkanDevice::DestroySwapchain ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyTexture()

void VulkanDevice::DestroyTexture ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

DestroyVirtualAllocator()

void VulkanDevice::DestroyVirtualAllocator ( Handle  handle )

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetAccelerationStructure()

RHIAccelerationStructure * VulkanDevice::GetAccelerationStructure ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetAccelerationStructureSizeInfo()

RHIAccelerationStructureSizeInfo VulkanDevice::GetAccelerationStructureSizeInfo ( RHIAccelerationStructureBuildDesc const &  desc, Allocator *  scratchAllocator = nullptr  ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetAllocator()

Allocator * VulkanDevice::GetAllocator

(

)

const

GetApp()

const VulkanApplication & Foundation::RHI::VulkanDevice::GetApp ( ) const

inline

GetBuffer()

RHIBuffer * VulkanDevice::GetBuffer ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetCapabilities()

RHIDeviceCapabilities Foundation::RHI::VulkanDevice::GetCapabilities ( ) const

inlineoverridevirtual

Implements Foundation::RHI::RHIDevice.

GetCommandPool()

RHICommandPool * VulkanDevice::GetCommandPool ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetDescriptorPool()

RHIDeviceDescriptorPool * VulkanDevice::GetDescriptorPool ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetDescriptorSetLayout()

RHIDeviceDescriptorSetLayout * VulkanDevice::GetDescriptorSetLayout ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetDeviceQueue()

RHIDeviceQueue * VulkanDevice::GetDeviceQueue ( RHIDeviceQueueType  type ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetFence()

RHIDeviceFence * VulkanDevice::GetFence ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetGraphicsQueueFamilyIndex()

uint32_t Foundation::RHI::VulkanDevice::GetGraphicsQueueFamilyIndex ( ) const

inline

GetPipelineCache()

RHIPipelineStateCache * VulkanDevice::GetPipelineCache ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetPipelineCacheKey()

RHIPipelineStateCacheKey Foundation::RHI::VulkanDevice::GetPipelineCacheKey ( ) const

inlineoverridevirtual

Implements Foundation::RHI::RHIDevice.

GetPipelineState()

RHIPipelineState * VulkanDevice::GetPipelineState ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetQueryPool()

RHIDeviceQueryPool * VulkanDevice::GetQueryPool ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetQueueSubmitMutex()

Mutex & Foundation::RHI::VulkanDevice::GetQueueSubmitMutex ( ) const

inline

GetSampler()

RHIDeviceSampler * VulkanDevice::GetSampler ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetSemaphore()

RHIDeviceSemaphore * VulkanDevice::GetSemaphore ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetShaderModule()

RHIShaderModule * VulkanDevice::GetShaderModule ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetSurface()

RHISurface * VulkanDevice::GetSurface ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetSwapchain()

RHISwapchain * VulkanDevice::GetSwapchain ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetTexture()

RHITexture * VulkanDevice::GetTexture ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetVirtualAllocator()

RHIVirtualAllocator * VulkanDevice::GetVirtualAllocator ( Handle  handle ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

GetVkAllocationCallbacks()

vk::AllocationCallbacks const * VulkanDevice::GetVkAllocationCallbacks

(

)

const

GetVkAllocationCallbacksNative()

VkAllocationCallbacks const * VulkanDevice::GetVkAllocationCallbacksNative

(

)

const

GetVkAllocator()

auto const & Foundation::RHI::VulkanDevice::GetVkAllocator ( ) const

inline

GetVkDevice()

auto const & Foundation::RHI::VulkanDevice::GetVkDevice ( ) const

inline

GetVkPhysicalDevice()

auto const & Foundation::RHI::VulkanDevice::GetVkPhysicalDevice ( ) const

inline

GetVkPhysicalDeviceProperties()

auto const & Foundation::RHI::VulkanDevice::GetVkPhysicalDeviceProperties ( ) const

inline

GetVkQueues()

auto const & Foundation::RHI::VulkanDevice::GetVkQueues ( ) const

inline

QueryAllocationStats()

void VulkanDevice::QueryAllocationStats ( size_t &  blockBytes, size_t &  allocationBytes  ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

QueryBudget()

void VulkanDevice::QueryBudget ( RHIDeviceHeapType  heapType, size_t &  used, size_t &  budget  ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

QueryDeviceString()

String VulkanDevice::QueryDeviceString ( ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

QueryMemoryStats()

void VulkanDevice::QueryMemoryStats ( RHIDeviceMemoryStats &  outStats ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

ResetFences()

void VulkanDevice::ResetFences ( Span< RHIDeviceFence *const >  fences )

overridevirtual

Implements Foundation::RHI::RHIDevice.

SignalTimelineSemaphores()

void VulkanDevice::SignalTimelineSemaphores ( Span< const Pair< RHIDeviceSemaphore *, size_t > >  semaphores )

overridevirtual

Implements Foundation::RHI::RHIDevice.

WaitForFences()

bool VulkanDevice::WaitForFences ( Span< RHIDeviceFence *const >  fences, bool  wait_all, size_t  timeout  )

overridevirtual

Wait for fences to arrive.

Parameters

timeout

Wait timeout in nanoseconds. Set to 0 for no wait and return immediately, -1 for infinite wait.

Returns

true if fence reached, false if timeout occurred.

Implements Foundation::RHI::RHIDevice.

WaitForTimelineSemaphores()

bool VulkanDevice::WaitForTimelineSemaphores ( Span< const Pair< RHIDeviceSemaphore *, size_t > >  semaphores, size_t  timeout  )

overridevirtual

Wait for timeline semaphores to reach specified values.

Parameters

timeout

Wait timeout in nanoseconds. Set to 0 for no wait and return immediately.

Returns

true if all semaphores reached the specified values, false if timeout occurred.

Implements Foundation::RHI::RHIDevice.

WaitIdle()

void VulkanDevice::WaitIdle ( ) const

overridevirtual

Implements Foundation::RHI::RHIDevice.

WriteAccelerationStructureInstanceData()

size_t VulkanDevice::WriteAccelerationStructureInstanceData ( RHIAccelerationStructureGeometryInstance const &  data, void *  dest  ) const

overridevirtual

Parameters

dest	If nullptr, only the size is calculated.

Returns

Stride size of the written instance data.

Implements Foundation::RHI::RHIDevice.

Member Data Documentation

mApp

const VulkanApplication& Foundation::RHI::VulkanDevice::mApp

private

mDevice

vk::raii::Device Foundation::RHI::VulkanDevice::mDevice {nullptr}

private

mDeviceCaps

RHIDeviceCapabilities Foundation::RHI::VulkanDevice::mDeviceCaps {}

private

mGraphicsQueueFamilyIndex

uint32_t Foundation::RHI::VulkanDevice::mGraphicsQueueFamilyIndex {}

private

mPhysicalDevice

vk::raii::PhysicalDevice Foundation::RHI::VulkanDevice::mPhysicalDevice {nullptr}

private

mPhysicalDeviceProperties

vk::PhysicalDeviceProperties Foundation::RHI::VulkanDevice::mPhysicalDeviceProperties {}

private

mPipelineCacheKey

RHIPipelineStateCacheKey Foundation::RHI::VulkanDevice::mPipelineCacheKey {}

private

mQueues

UniquePtr<VulkanDeviceQueues> Foundation::RHI::VulkanDevice::mQueues {nullptr}

private

mQueueSubmitMutex

Mutex Foundation::RHI::VulkanDevice::mQueueSubmitMutex

mutableprivate

mStorage

RHIObjectPool Foundation::RHI::VulkanDevice::mStorage

private

mVkAllocator

VmaAllocator Foundation::RHI::VulkanDevice::mVkAllocator {nullptr}

private

---

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

• Source/RHIVulkan/Device.hpp
• Source/RHIVulkan/Device.cpp