Foundation::RHI::RHIDevice Class Reference

#include <Device.hpp>

Inheritance diagram for Foundation::RHI::RHIDevice:

Classes
struct	DeviceDesc

Public Member Functions
	RHIDevice (RHIApplication const &app)
virtual Span< RHIResourceFormat const >	GetSwapchainSupportedFormats () const =0
virtual Span< RHISwapchainPresentMode const >	GetSwapchainSupportedPresentModes () const =0
virtual RHIDeviceScopedHandle< RHISwapchain >	CreateSwapchain (RHISwapchain::SwapchainDesc const &desc)=0
virtual RHISwapchain *	GetSwapchain (Handle handle) const =0
virtual void	DestroySwapchain (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIPipelineStateCache >	CreatePipelineCache (RHIPipelineStateCache::PipelineStateCacheDesc const &desc)=0
virtual RHIPipelineStateCache *	GetPipelineCache (Handle handle) const =0
virtual void	DestroyPipelineCache (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIPipelineState >	CreatePipelineState (RHIPipelineState::PipelineStateDesc const &desc)=0
virtual RHIPipelineState *	GetPipelineState (Handle handle) const =0
virtual void	DestroyPipelineState (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIShaderModule >	CreateShaderModule (RHIShaderModule::ShaderModuleDesc const &desc)=0
virtual RHIShaderModule *	GetShaderModule (Handle handle) const =0
virtual void	DestroyShaderModule (Handle handle)=0
virtual RHIDeviceScopedHandle< RHICommandPool >	CreateCommandPool (RHICommandPool::PoolDesc type)=0
virtual RHICommandPool *	GetCommandPool (Handle handle) const =0
virtual void	DestroyCommandPool (Handle handle)=0
virtual RHIDeviceQueue *	GetDeviceQueue (RHIDeviceQueueType type) const =0
virtual RHIDeviceScopedHandle< RHIDeviceSemaphore >	CreateSemaphore (bool is_timeline=false)=0
virtual RHIDeviceSemaphore *	GetSemaphore (Handle handle) const =0
virtual void	DestroySemaphore (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIDeviceFence >	CreateFence (bool signaled=true)=0
virtual RHIDeviceFence *	GetFence (Handle handle) const =0
virtual void	DestroyFence (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIBuffer >	CreateBuffer (RHIBufferDesc const &desc)=0
virtual RHIBuffer *	GetBuffer (Handle handle) const =0
virtual void	DestroyBuffer (Handle handle)=0
virtual RHIDeviceScopedHandle< RHITexture >	CreateTexture (RHITextureDesc const &desc)=0
virtual RHITexture *	GetImage (Handle handle) const =0
virtual void	DestroyImage (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIDeviceDescriptorSetLayout >	CreateDescriptorSetLayout (RHIDeviceDescriptorSetLayoutDesc const &desc)=0
virtual RHIDeviceDescriptorSetLayout *	GetDescriptorSetLayout (Handle handle) const =0
virtual void	DestroyDescriptorSetLayout (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIDeviceDescriptorPool >	CreateDescriptorPool (RHIDeviceDescriptorPool::PoolDesc const &desc)=0
virtual RHIDeviceDescriptorPool *	GetDescriptorPool (Handle handle) const =0
virtual void	DestroyDescriptorPool (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIDeviceSampler >	CreateSampler (RHIDeviceSampler::SamplerDesc const &desc)=0
virtual RHIDeviceSampler *	GetSampler (Handle handle) const =0
virtual void	DestroySampler (Handle handle)=0
virtual RHIDeviceScopedHandle< RHIDeviceQueryPool >	CreateQueryPool (RHIDeviceQueryPool::QueryPoolDesc const &desc)=0
virtual RHIDeviceQueryPool *	GetQueryPool (Handle handle) const =0
virtual void	DestroyQueryPool (Handle handle)=0
virtual void	ResetFences (Span< RHIDeviceFence *const > fences)=0
virtual bool	WaitForFences (Span< RHIDeviceFence *const > fences, bool wait_all, size_t timeout)=0
	Wait for fences to arrive.
virtual void	SignalTimelineSemaphores (Span< const Pair< RHIDeviceSemaphore *, size_t > > semaphores)=0
virtual bool	WaitForTimelineSemaphores (Span< const Pair< RHIDeviceSemaphore *, size_t > > semaphores, size_t timeout)=0
	Wait for timeline semaphores to reach specified values.
virtual void	WaitIdle () const =0
virtual void	QueryBudget (size_t &used, size_t &budget) const =0
virtual String	QueryDeviceString () const =0
virtual void	DebugSetObjectName (const char *name)=0
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

Protected Attributes
const RHIApplication &	mApp

Constructor & Destructor Documentation

RHIDevice()

Foundation::RHI::RHIDevice::RHIDevice ( RHIApplication const &  app )

inline

Member Function Documentation

CreateBuffer()

virtual RHIDeviceScopedHandle< RHIBuffer > Foundation::RHI::RHIDevice::CreateBuffer ( RHIBufferDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateCommandPool()

virtual RHIDeviceScopedHandle< RHICommandPool > Foundation::RHI::RHIDevice::CreateCommandPool ( RHICommandPool::PoolDesc  type )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateDescriptorPool()

virtual RHIDeviceScopedHandle< RHIDeviceDescriptorPool > Foundation::RHI::RHIDevice::CreateDescriptorPool ( RHIDeviceDescriptorPool::PoolDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateDescriptorSetLayout()

virtual RHIDeviceScopedHandle< RHIDeviceDescriptorSetLayout > Foundation::RHI::RHIDevice::CreateDescriptorSetLayout ( RHIDeviceDescriptorSetLayoutDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateFence()

virtual RHIDeviceScopedHandle< RHIDeviceFence > Foundation::RHI::RHIDevice::CreateFence ( bool  signaled = true )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreatePipelineCache()

virtual RHIDeviceScopedHandle< RHIPipelineStateCache > Foundation::RHI::RHIDevice::CreatePipelineCache ( RHIPipelineStateCache::PipelineStateCacheDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreatePipelineState()

virtual RHIDeviceScopedHandle< RHIPipelineState > Foundation::RHI::RHIDevice::CreatePipelineState ( RHIPipelineState::PipelineStateDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateQueryPool()

virtual RHIDeviceScopedHandle< RHIDeviceQueryPool > Foundation::RHI::RHIDevice::CreateQueryPool ( RHIDeviceQueryPool::QueryPoolDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateSampler()

virtual RHIDeviceScopedHandle< RHIDeviceSampler > Foundation::RHI::RHIDevice::CreateSampler ( RHIDeviceSampler::SamplerDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateSemaphore()

virtual RHIDeviceScopedHandle< RHIDeviceSemaphore > Foundation::RHI::RHIDevice::CreateSemaphore ( bool  is_timeline = false )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateShaderModule()

virtual RHIDeviceScopedHandle< RHIShaderModule > Foundation::RHI::RHIDevice::CreateShaderModule ( RHIShaderModule::ShaderModuleDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateSwapchain()

virtual RHIDeviceScopedHandle< RHISwapchain > Foundation::RHI::RHIDevice::CreateSwapchain ( RHISwapchain::SwapchainDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

CreateTexture()

virtual RHIDeviceScopedHandle< RHITexture > Foundation::RHI::RHIDevice::CreateTexture ( RHITextureDesc const &  desc )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DebugSetObjectName()

virtual void Foundation::RHI::RHIDevice::DebugSetObjectName ( const char *  name )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyBuffer()

virtual void Foundation::RHI::RHIDevice::DestroyBuffer ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyCommandPool()

virtual void Foundation::RHI::RHIDevice::DestroyCommandPool ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyDescriptorPool()

virtual void Foundation::RHI::RHIDevice::DestroyDescriptorPool ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyDescriptorSetLayout()

virtual void Foundation::RHI::RHIDevice::DestroyDescriptorSetLayout ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyFence()

virtual void Foundation::RHI::RHIDevice::DestroyFence ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyImage()

virtual void Foundation::RHI::RHIDevice::DestroyImage ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyPipelineCache()

virtual void Foundation::RHI::RHIDevice::DestroyPipelineCache ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyPipelineState()

virtual void Foundation::RHI::RHIDevice::DestroyPipelineState ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyQueryPool()

virtual void Foundation::RHI::RHIDevice::DestroyQueryPool ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroySampler()

virtual void Foundation::RHI::RHIDevice::DestroySampler ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroySemaphore()

virtual void Foundation::RHI::RHIDevice::DestroySemaphore ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroyShaderModule()

virtual void Foundation::RHI::RHIDevice::DestroyShaderModule ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

DestroySwapchain()

virtual void Foundation::RHI::RHIDevice::DestroySwapchain ( Handle  handle )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetBuffer()

virtual RHIBuffer * Foundation::RHI::RHIDevice::GetBuffer ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetCommandPool()

virtual RHICommandPool * Foundation::RHI::RHIDevice::GetCommandPool ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetDescriptorPool()

virtual RHIDeviceDescriptorPool * Foundation::RHI::RHIDevice::GetDescriptorPool ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetDescriptorSetLayout()

virtual RHIDeviceDescriptorSetLayout * Foundation::RHI::RHIDevice::GetDescriptorSetLayout ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetDeviceQueue()

virtual RHIDeviceQueue * Foundation::RHI::RHIDevice::GetDeviceQueue ( RHIDeviceQueueType  type ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetFence()

virtual RHIDeviceFence * Foundation::RHI::RHIDevice::GetFence ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetImage()

virtual RHITexture * Foundation::RHI::RHIDevice::GetImage ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetPipelineCache()

virtual RHIPipelineStateCache * Foundation::RHI::RHIDevice::GetPipelineCache ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetPipelineState()

virtual RHIPipelineState * Foundation::RHI::RHIDevice::GetPipelineState ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetQueryPool()

virtual RHIDeviceQueryPool * Foundation::RHI::RHIDevice::GetQueryPool ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetSampler()

virtual RHIDeviceSampler * Foundation::RHI::RHIDevice::GetSampler ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetSemaphore()

virtual RHIDeviceSemaphore * Foundation::RHI::RHIDevice::GetSemaphore ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetShaderModule()

virtual RHIShaderModule * Foundation::RHI::RHIDevice::GetShaderModule ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetSwapchain()

virtual RHISwapchain * Foundation::RHI::RHIDevice::GetSwapchain ( Handle  handle ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetSwapchainSupportedFormats()

virtual Span< RHIResourceFormat const > Foundation::RHI::RHIDevice::GetSwapchainSupportedFormats ( ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

GetSwapchainSupportedPresentModes()

virtual Span< RHISwapchainPresentMode const > Foundation::RHI::RHIDevice::GetSwapchainSupportedPresentModes ( ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

QueryBudget()

virtual void Foundation::RHI::RHIDevice::QueryBudget ( size_t &  used, size_t &  budget  ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

QueryDeviceString()

virtual String Foundation::RHI::RHIDevice::QueryDeviceString ( ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

ResetFences()

virtual void Foundation::RHI::RHIDevice::ResetFences ( Span< RHIDeviceFence *const >  fences )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

SignalTimelineSemaphores()

virtual void Foundation::RHI::RHIDevice::SignalTimelineSemaphores ( Span< const Pair< RHIDeviceSemaphore *, size_t > >  semaphores )

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

WaitForFences()

virtual bool Foundation::RHI::RHIDevice::WaitForFences ( Span< RHIDeviceFence *const >  fences, bool  wait_all, size_t  timeout  )

pure virtual

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.

Implemented in Foundation::RHI::VulkanDevice.

WaitForTimelineSemaphores()

virtual bool Foundation::RHI::RHIDevice::WaitForTimelineSemaphores ( Span< const Pair< RHIDeviceSemaphore *, size_t > >  semaphores, size_t  timeout  )

pure virtual

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.

Implemented in Foundation::RHI::VulkanDevice.

WaitIdle()

virtual void Foundation::RHI::RHIDevice::WaitIdle ( ) const

pure virtual

Implemented in Foundation::RHI::VulkanDevice.

Member Data Documentation

mApp

const RHIApplication& Foundation::RHI::RHIDevice::mApp

protected

---

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

• Source/RHICore/Device.hpp