Foundation::RHI Namespace Reference

Low-level Rendering Hardware Interface (RHI) abstractions. More...

Classes
class	RHIAccelerationStructure
struct	RHIAccelerationStructureBuildDesc
struct	RHIAccelerationStructureBuildRangeInfo
struct	RHIAccelerationStructureDesc
struct	RHIAccelerationStructureGeometryInfo
struct	RHIAccelerationStructureGeometryInstance
struct	RHIAccelerationStructureGeometryInstanceData
struct	RHIAccelerationStructureGeometryTriangleData
struct	RHIAccelerationStructureSizeInfo
class	RHIApplication
	The root object of everything RHI. Implementation of this class inherently defines the RHI backend. More...
class	RHIBuffer
struct	RHIBufferDesc
class	RHICommandList
class	RHICommandPool
class	RHIDevice
class	RHIDeviceDescriptorPool
class	RHIDeviceDescriptorSet
class	RHIDeviceDescriptorSetLayout
struct	RHIDeviceDescriptorSetLayoutDesc
class	RHIDeviceFence
struct	RHIDeviceIdleGuard
	RAII guard to wait for device idle on destruction. More...
class	RHIDeviceQueryPool
class	RHIDeviceQueue
class	RHIDeviceSampler
class	RHIDeviceSemaphore
class	RHIHandle
	Handle type for RHI Objects. More...
class	RHIObject
	Base class for all RHI objects. More...
class	RHIObjectPool
	Thread-safe type-erased handle dereference facility for RHI Objects. More...
struct	RHIObjectTraits
	Provides type traits for types derived from RHIObject. More...
struct	RHIObjectTraits< RHIApplication, RHIDevice >
struct	RHIObjectTraits< RHIBuffer, RHIBuffer >
struct	RHIObjectTraits< RHICommandPool, RHICommandList >
struct	RHIObjectTraits< RHIDevice, RHIAccelerationStructure >
struct	RHIObjectTraits< RHIDevice, RHIBuffer >
struct	RHIObjectTraits< RHIDevice, RHICommandPool >
struct	RHIObjectTraits< RHIDevice, RHIDeviceDescriptorPool >
struct	RHIObjectTraits< RHIDevice, RHIDeviceDescriptorSetLayout >
struct	RHIObjectTraits< RHIDevice, RHIDeviceFence >
struct	RHIObjectTraits< RHIDevice, RHIDeviceQueryPool >
struct	RHIObjectTraits< RHIDevice, RHIDeviceSampler >
struct	RHIObjectTraits< RHIDevice, RHIDeviceSemaphore >
struct	RHIObjectTraits< RHIDevice, RHIPipelineState >
struct	RHIObjectTraits< RHIDevice, RHIPipelineStateCache >
struct	RHIObjectTraits< RHIDevice, RHIShaderModule >
struct	RHIObjectTraits< RHIDevice, RHISwapchain >
struct	RHIObjectTraits< RHIDevice, RHITexture >
struct	RHIObjectTraits< RHIDeviceDescriptorPool, RHIDeviceDescriptorSet >
struct	RHIObjectTraits< RHITexture, RHITexture >
struct	RHIObjectTraits< RHITexture, RHITextureView >
class	RHIPipelineState
class	RHIPipelineStateCache
struct	RHIResourceDesc
class	RHIScopedHandle
	Scoped move-only RAII handle wrapper for RHI Objects. More...
class	RHIShaderModule
class	RHISwapchain
struct	RHISwapchainResizeException
class	RHITexture
struct	RHITextureDesc
struct	RHITextureSubresourceLayer
struct	RHITextureSubresourceRange
class	RHITextureView
struct	RHITextureViewDesc
struct	RHIVertexAttribute
class	VulkanAccelerationStructure
class	VulkanApplication
class	VulkanBuffer
class	VulkanCommandList
class	VulkanCommandPool
class	VulkanDevice
class	VulkanDeviceDescriptorPool
class	VulkanDeviceDescriptorSet
class	VulkanDeviceDescriptorSetLayout
class	VulkanDeviceFence
class	VulkanDeviceQueryPool
class	VulkanDeviceQueue
struct	VulkanDeviceQueues
class	VulkanDeviceSampler
class	VulkanDeviceSemaphore
struct	VulkanPipelineRayTracingSBT
class	VulkanPipelineState
class	VulkanPipelineStateCache
class	VulkanShaderModule
class	VulkanSwapchain
class	VulkanTexture
class	VulkanTextureView

Typedefs
template<typename T >
using	RHICommandPoolHandle = RHIHandle< RHICommandPool, T >
template<typename T >
using	RHICommandPoolScopedHandle = RHIScopedHandle< RHICommandPool, T >
using	RHIExtent1D = glm::vec< 1, uint32_t >
using	RHIExtent2D = glm::vec< 2, uint32_t >
using	RHIExtent3D = glm::vec< 3, uint32_t >
using	RHIOffset1D = glm::vec< 1, int32_t >
using	RHIOffset2D = glm::vec< 2, int32_t >
using	RHIOffset3D = glm::vec< 3, int32_t >
using	RHIClearColor = glm::vec< 4, float >
using	RHIClearDepthStencil = Pair< float, uint32_t >
template<typename T >
using	RHIDeviceDescriptorPoolHandle = RHIHandle< RHIDeviceDescriptorPool, T >
template<typename T >
using	RHIDeviceDescriptorPoolScopedHandle = RHIScopedHandle< RHIDeviceDescriptorPool, T >
using	Handle = uintptr_t
template<typename T >
using	RHIApplicationScopedHandle = RHIScopedHandle< RHIApplication, T >
template<typename T >
using	RHIApplicationHandle = RHIHandle< RHIApplication, T >
template<typename T >
using	RHIDeviceScopedHandle = RHIScopedHandle< RHIDevice, T >
template<typename T >
using	RHIDeviceHandle = RHIHandle< RHIDevice, T >
template<typename T >
using	RHIBufferScopedHandle = RHIScopedHandle< RHIBuffer, T >
template<typename T >
using	RHIBufferHandle = RHIHandle< RHIBuffer, T >
template<typename T >
using	RHITextureScopedHandle = RHIScopedHandle< RHITexture, T >
template<typename T >
using	RHITextureHandle = RHIHandle< RHITexture, T >

Enumerations
enum class	RHIResourceFormat {   Undefined = 0 , R8G8B8A8Unorm , R8G8B8A8Srgb , B8G8R8A8Unrom ,   B8G8R8A8Srgb , A2R10G10B10Unorm , A2R10G10B10Snorm , B10G11R11Ufloat ,   R32SignedFloat , R32G32SignedFloat , R32G32B32SignedFloat , R32G32B32A32SignedFloat ,   R16SignedFloat , R16G16SignedFloat , R16G16B16SignedFloat , R16G16B16A16SignedFloat ,   R32Uint , R16Uint , R16Unorm , D32SignedFloat ,   D16Unorm , Bc1RgbUnorm , Bc1RgbSrgb , Bc1RgbaUnorm ,   Bc1RgbaSrgb , Bc2Unorm , Bc2Srgb , Bc3Unorm ,   Bc3Srgb , Bc4Unorm , Bc4Snorm , Bc5Unorm ,   Bc5Snorm , Bc6HUfloat , Bc6HSfloat , Bc7Unorm ,   Bc7Srgb }
enum class	RHICommandPoolType { Persistent , Transient }
enum class	RHIDeviceQueueType : uint32_t {   Undefined = ~0u , Graphics = 0 , Compute = 1 , Transfer = 2 ,   Present = 3 }
enum class	RHIDeviceHeapType { Local , Upload , Readback }
enum class	RHITextureLayout {   Undefined , General , RenderTarget , DepthStencil ,   Present , TransferDst , TransferSrc , ShaderReadOnly }
enum class	RHIAccelerationStructureType { BottomLevel , TopLevel }
enum class	RHIAccelerationStructureBuildOp { Build , Update }
enum class	RHIAccelerationGeometryType { Triangles , Instances }
enum class	RHIResourceHostAccess { Invisible , ReadWrite , WriteOnly }
enum class	RHIDescriptorType {   Sampler , SampledImage , StorageImage , UniformBuffer ,   StorageBuffer , AccelerationStructure }
enum class	RHIMultisampleCount {   E1 , E2 , E4 , E8 ,   E16 }
enum class	RHITextureDimension {   E1D , E2D , E3D , ECube ,   E1DArray , E2DArray , ECubeArray }
enum class	RHISwapchainPresentMode { Fifo , Mailbox , Tearing }

Functions
	ENUM_NAME_CONV_END ()
	BITMASK_ENUM_END ()
void *	vkCustomCpuAllocation (Allocator *alloc, size_t size, size_t alignment, vk::SystemAllocationScope)
void *	vkCustomCpuReallocation (Allocator *alloc, void *pOriginal, size_t size, size_t alignment, vk::SystemAllocationScope)
void	vkCustomCpuFree (Allocator *alloc, void *pMemory)
vk::AllocationCallbacks	vkCreateVulkanCpuAllocationCallbacks (Allocator *alloc)
template<typename Bits >
Bits	vkFlagsToBits (vk::Flags< Bits > flags)
vk::Format	vkFormatFromRHIFormat (RHIResourceFormat format)
vk::BufferUsageFlags	vkBufferUsageFromRHIBufferUsage (RHIBufferUsage usage)
vk::AccessFlags2	vkAccessFlagsFromRHIResourceAccess (RHIResourceAccess state)
vk::ImageLayout	vkImageLayoutFromRHITextureLayout (RHITextureLayout layout)
vk::PipelineStageFlags	vkPipelineStageFlagsFromRHIPipelineStage (RHIPipelineStage stage)
vk::PipelineStageFlags2	vkPipelineStageFlags2FromRHIPipelineStage (RHIPipelineStage stage)
vk::ShaderStageFlags	vkShaderStageFlagsFromRHIShaderStage (RHIShaderStage stage)
vk::DescriptorType	vkDescriptorTypeFromRHIDescriptorType (RHIDescriptorType type)
vk::PipelineBindPoint	vkPipelineBindPointFromRHIDevicePipelineType (RHIDevicePipelineType type)
vk::ImageUsageFlags	vkImageUsageFlagsFromRHITextureUsage (RHITextureUsage usage)
vk::SampleCountFlagBits	vkSampleCountFlagFromRHIMultisampleCount (RHIMultisampleCount count)
vk::ImageAspectFlags	vkImageAspectFlagFromRHITextureAspect (RHITextureAspectFlag aspect)
vk::AccelerationStructureTypeKHR	vkAccelerationStructureTypeFromRHIAccelerationStructureType (RHIAccelerationStructureType type)
vk::BuildAccelerationStructureModeKHR	vkBuildAccelerationStructureModeFromRHIAccelerationStructureBuildOp (RHIAccelerationStructureBuildOp op)
vk::BuildAccelerationStructureFlagsKHR	vkBuildAccelerationStructureFlagsFromRHIAccelerationStructureBuildFlags (RHIAccelerationStructureBuildFlags flags)
vk::PrimitiveTopology	GetVulkanPrimitiveTopologyFromDesc (RHIPipelineState::PipelineStateDesc::Topology topology)
vk::PolygonMode	GetVulkanPolygonModeFromDesc (RHIPipelineState::PipelineStateDesc::Rasterizer::FillMode mode)
vk::CullModeFlags	GetVulkanCullModeFromDesc (RHIPipelineState::PipelineStateDesc::Rasterizer::CullMode mode)
vk::FrontFace	GetVulkanFrontFaceFromDesc (RHIPipelineState::PipelineStateDesc::Rasterizer::FrontFace face)
vk::BlendFactor	GetVulkanBlendFactorFromDesc (RHIPipelineState::PipelineStateDesc::Attachment::Blending::BlendFactor factor)
vk::BlendOp	GetVulkanBlendOpFromDesc (RHIPipelineState::PipelineStateDesc::Attachment::Blending::BlendOp op)
VmaAllocationCreateFlags	vmaAllocationFlagsFromRHIResourceHostAccess (RHIResourceHostAccess access)
vk::AccelerationStructureGeometryTrianglesDataKHR	vkAccelerationTriangleDataFromRHI (RHIAccelerationStructureGeometryTriangleData const &desc)
vk::AccelerationStructureBuildGeometryInfoKHR	vkAccelerationBuildGeoInfoFromRHI (RHIAccelerationStructureBuildDesc const &desc, Vector< vk::AccelerationStructureGeometryKHR > &geometries, Vector< uint32_t > &primitiveCounts)
vk::AccelerationStructureBuildRangeInfoKHR	vkAccelerationBuildRangeInfoFromRHI (RHIAccelerationStructureBuildRangeInfo const &desc)
vk::PresentModeKHR	vkPresentModeFromSwapchainDesc (RHISwapchainPresentMode mode)

Variables
const uint32_t	kCommandQueueTransferIgnored = ~0u
static constexpr size_t	kFullSize = -1
	Graphics = 1u << 0
	Compute = 1u << 1
	Transfer = 1u << 2
	Present
	Vertex = 1 << 0
	Fragment = 1 << 1
	RayGeneration = 1 << 3
	RayAnyHit = 1 << 4
	RayClosestHit = 1 << 5
	RayMiss = 1 << 6
	RayIntersection = 1 << 7
	Task = 1 << 8
	Mesh = 1 << 9
	All
	RenderTargetWrite = 1 << 0
	RenderTargetRead = 1 << 1
	DepthStencilWrite = 1 << 2
	DepthStencilRead = 1 << 3
	TransferWrite = 1 << 4
	TransferRead = 1 << 5
	ShaderWrite = 1 << 6
	ShaderRead = 1 << 7
	UniformRead = 1 << 8
	HostWrite = 1 << 9
	HostRead = 1 << 10
	AccelerationStructureRead = 1 << 11
	AccelerationStructureWrite = 1 << 12
	DrawIndirect = 1 << 1
	VertexShader = 1 << 2
	FragmentShader = 1 << 3
	ComputeShader = 1 << 4
	RayTracingShader = 1 << 5
	MeshShader = 1 << 6
	TaskShader = 1 << 7
	RenderTargetOutput = 1 << 8
	EarlyFragmentTests = 1 << 10
	LateFragmentTests = 1 << 11
	AccelerationBuild = 1 << 12
	Host = 1 << 27
	AllGraphics = 1 << 28
	TopOfPipe = 1 << 29
	BottomOfPipe = 1 << 30
	VertexBuffer = 1 << 0
	IndexBuffer = 1 << 1
	UniformBuffer = 1 << 2
	StorageBuffer = 1 << 3
	IndirectBuffer = 1 << 4
	TransferSource = 1 << 5
	TransferDestination = 1 << 6
	DeviceAddress = 1 << 7
	AccelerationStructureStorage = 1 << 8
	AccelerationStructureBuildReadOnly = 1 << 9
	ShaderBindingTable
	RenderTarget = 1 << 0
	DepthStencil = 1 << 1
	SampledImage = 1 << 2
	StorageImage = 1 << 3
	Color = 1 << 0
	Depth = 1 << 1
	Stencil
	AllowUpdate = 1 << 0
	AllowCompaction = 1 << 1
	PreferFastTrace = 1 << 2
	PreferFastBuild = 1 << 3
	LowMemory
static constexpr Handle	kInvalidHandle = static_cast<Handle>(-1)
static constexpr size_t	kRHIObjectPoolMaxSize = 65536
constexpr size_t	kCommandBarrierReserveSize = 256
constexpr uint32_t	kInvalidQueueIndex = static_cast<uint32_t>(-1)

Detailed Description

Low-level Rendering Hardware Interface (RHI) abstractions.

Typedef Documentation

Handle

using Foundation::RHI::Handle = typedef uintptr_t

RHIApplicationHandle

template<typename T >

using Foundation::RHI::RHIApplicationHandle = typedef RHIHandle<RHIApplication, T>

RHIApplicationScopedHandle

template<typename T >

using Foundation::RHI::RHIApplicationScopedHandle = typedef RHIScopedHandle<RHIApplication, T>

RHIBufferHandle

template<typename T >

using Foundation::RHI::RHIBufferHandle = typedef RHIHandle<RHIBuffer, T>

RHIBufferScopedHandle

template<typename T >

using Foundation::RHI::RHIBufferScopedHandle = typedef RHIScopedHandle<RHIBuffer, T>

RHIClearColor

using Foundation::RHI::RHIClearColor = typedef glm::vec<4, float>

RHIClearDepthStencil

using Foundation::RHI::RHIClearDepthStencil = typedef Pair<float, uint32_t>

RHICommandPoolHandle

template<typename T >

using Foundation::RHI::RHICommandPoolHandle = typedef RHIHandle<RHICommandPool, T>

RHICommandPoolScopedHandle

template<typename T >

using Foundation::RHI::RHICommandPoolScopedHandle = typedef RHIScopedHandle<RHICommandPool, T>

RHIDeviceDescriptorPoolHandle

template<typename T >

using Foundation::RHI::RHIDeviceDescriptorPoolHandle = typedef RHIHandle<RHIDeviceDescriptorPool, T>

RHIDeviceDescriptorPoolScopedHandle

template<typename T >

using Foundation::RHI::RHIDeviceDescriptorPoolScopedHandle = typedef RHIScopedHandle<RHIDeviceDescriptorPool, T>

RHIDeviceHandle

template<typename T >

using Foundation::RHI::RHIDeviceHandle = typedef RHIHandle<RHIDevice, T>

RHIDeviceScopedHandle

template<typename T >

using Foundation::RHI::RHIDeviceScopedHandle = typedef RHIScopedHandle<RHIDevice, T>

RHIExtent1D

using Foundation::RHI::RHIExtent1D = typedef glm::vec<1, uint32_t>

RHIExtent2D

using Foundation::RHI::RHIExtent2D = typedef glm::vec<2, uint32_t>

RHIExtent3D

using Foundation::RHI::RHIExtent3D = typedef glm::vec<3, uint32_t>

RHIOffset1D

using Foundation::RHI::RHIOffset1D = typedef glm::vec<1, int32_t>

RHIOffset2D

using Foundation::RHI::RHIOffset2D = typedef glm::vec<2, int32_t>

RHIOffset3D

using Foundation::RHI::RHIOffset3D = typedef glm::vec<3, int32_t>

RHITextureHandle

template<typename T >

using Foundation::RHI::RHITextureHandle = typedef RHIHandle<RHITexture, T>

RHITextureScopedHandle

template<typename T >

using Foundation::RHI::RHITextureScopedHandle = typedef RHIScopedHandle<RHITexture, T>

Enumeration Type Documentation

RHIAccelerationGeometryType

enum class Foundation::RHI::RHIAccelerationGeometryType

strong

Enumerator
Triangles
Instances

RHIAccelerationStructureBuildOp

enum class Foundation::RHI::RHIAccelerationStructureBuildOp

strong

Enumerator
Build
Update

RHIAccelerationStructureType

enum class Foundation::RHI::RHIAccelerationStructureType

strong

Enumerator
BottomLevel
TopLevel

RHICommandPoolType

enum class Foundation::RHI::RHICommandPoolType

strong

Enumerator
Persistent
Transient

RHIDescriptorType

enum class Foundation::RHI::RHIDescriptorType

strong

Enumerator
Sampler
SampledImage
StorageImage
UniformBuffer
StorageBuffer
AccelerationStructure

RHIDeviceHeapType

enum class Foundation::RHI::RHIDeviceHeapType

strong

Enumerator
Local
Upload
Readback

RHIDeviceQueueType

enum class Foundation::RHI::RHIDeviceQueueType : uint32_t

strong

Enumerator
Undefined
Graphics
Compute
Transfer
Present

RHIMultisampleCount

enum class Foundation::RHI::RHIMultisampleCount

strong

Enumerator
E1
E2
E4
E8
E16

RHIResourceFormat

enum class Foundation::RHI::RHIResourceFormat

strong

Enumerator
Undefined
R8G8B8A8Unorm
R8G8B8A8Srgb
B8G8R8A8Unrom
B8G8R8A8Srgb
A2R10G10B10Unorm
A2R10G10B10Snorm
B10G11R11Ufloat
R32SignedFloat
R32G32SignedFloat
R32G32B32SignedFloat
R32G32B32A32SignedFloat
R16SignedFloat
R16G16SignedFloat
R16G16B16SignedFloat
R16G16B16A16SignedFloat
R32Uint
R16Uint
R16Unorm
D32SignedFloat
D16Unorm
Bc1RgbUnorm
Bc1RgbSrgb
Bc1RgbaUnorm
Bc1RgbaSrgb
Bc2Unorm
Bc2Srgb
Bc3Unorm
Bc3Srgb
Bc4Unorm
Bc4Snorm
Bc5Unorm
Bc5Snorm
Bc6HUfloat
Bc6HSfloat
Bc7Unorm
Bc7Srgb

RHIResourceHostAccess

enum class Foundation::RHI::RHIResourceHostAccess

strong

Enumerator
Invisible
ReadWrite
WriteOnly

RHISwapchainPresentMode

enum class Foundation::RHI::RHISwapchainPresentMode

strong

Enumerator
Fifo
Mailbox
Tearing

RHITextureDimension

enum class Foundation::RHI::RHITextureDimension

strong

Enumerator
E1D
E2D
E3D
ECube
E1DArray
E2DArray
ECubeArray

RHITextureLayout

enum class Foundation::RHI::RHITextureLayout

strong

Enumerator
Undefined
General
RenderTarget
DepthStencil
Present
TransferDst
TransferSrc
ShaderReadOnly

Function Documentation

BITMASK_ENUM_END()

Foundation::RHI::BITMASK_ENUM_END

(

)

ENUM_NAME_CONV_END()

Foundation::RHI::ENUM_NAME_CONV_END

(

)

GetVulkanBlendFactorFromDesc()

vk::BlendFactor Foundation::RHI::GetVulkanBlendFactorFromDesc ( RHIPipelineState::PipelineStateDesc::Attachment::Blending::BlendFactor  factor )

inline

GetVulkanBlendOpFromDesc()

vk::BlendOp Foundation::RHI::GetVulkanBlendOpFromDesc ( RHIPipelineState::PipelineStateDesc::Attachment::Blending::BlendOp  op )

inline

GetVulkanCullModeFromDesc()

vk::CullModeFlags Foundation::RHI::GetVulkanCullModeFromDesc ( RHIPipelineState::PipelineStateDesc::Rasterizer::CullMode  mode )

inline

GetVulkanFrontFaceFromDesc()

vk::FrontFace Foundation::RHI::GetVulkanFrontFaceFromDesc ( RHIPipelineState::PipelineStateDesc::Rasterizer::FrontFace  face )

inline

GetVulkanPolygonModeFromDesc()

vk::PolygonMode Foundation::RHI::GetVulkanPolygonModeFromDesc ( RHIPipelineState::PipelineStateDesc::Rasterizer::FillMode  mode )

inline

GetVulkanPrimitiveTopologyFromDesc()

vk::PrimitiveTopology Foundation::RHI::GetVulkanPrimitiveTopologyFromDesc ( RHIPipelineState::PipelineStateDesc::Topology  topology )

inline

vkAccelerationBuildGeoInfoFromRHI()

vk::AccelerationStructureBuildGeometryInfoKHR Foundation::RHI::vkAccelerationBuildGeoInfoFromRHI	(	RHIAccelerationStructureBuildDesc const &	desc,
		Vector< vk::AccelerationStructureGeometryKHR > &	geometries,
		Vector< uint32_t > &	primitiveCounts
	)

vkAccelerationBuildRangeInfoFromRHI()

vk::AccelerationStructureBuildRangeInfoKHR Foundation::RHI::vkAccelerationBuildRangeInfoFromRHI

(

RHIAccelerationStructureBuildRangeInfo const &

desc

)

vkAccelerationStructureTypeFromRHIAccelerationStructureType()

vk::AccelerationStructureTypeKHR Foundation::RHI::vkAccelerationStructureTypeFromRHIAccelerationStructureType ( RHIAccelerationStructureType  type )

inline

vkAccelerationTriangleDataFromRHI()

vk::AccelerationStructureGeometryTrianglesDataKHR Foundation::RHI::vkAccelerationTriangleDataFromRHI

(

RHIAccelerationStructureGeometryTriangleData const &

desc

)

vkAccessFlagsFromRHIResourceAccess()

vk::AccessFlags2 Foundation::RHI::vkAccessFlagsFromRHIResourceAccess ( RHIResourceAccess  state )

inline

vkBufferUsageFromRHIBufferUsage()

vk::BufferUsageFlags Foundation::RHI::vkBufferUsageFromRHIBufferUsage ( RHIBufferUsage  usage )

inline

vkBuildAccelerationStructureFlagsFromRHIAccelerationStructureBuildFlags()

vk::BuildAccelerationStructureFlagsKHR Foundation::RHI::vkBuildAccelerationStructureFlagsFromRHIAccelerationStructureBuildFlags ( RHIAccelerationStructureBuildFlags  flags )

inline

vkBuildAccelerationStructureModeFromRHIAccelerationStructureBuildOp()

vk::BuildAccelerationStructureModeKHR Foundation::RHI::vkBuildAccelerationStructureModeFromRHIAccelerationStructureBuildOp ( RHIAccelerationStructureBuildOp  op )

inline

vkCreateVulkanCpuAllocationCallbacks()

vk::AllocationCallbacks Foundation::RHI::vkCreateVulkanCpuAllocationCallbacks

(

Allocator *

alloc

)

vkCustomCpuAllocation()

void * Foundation::RHI::vkCustomCpuAllocation	(	Allocator *	alloc,
		size_t	size,
		size_t	alignment,
		vk::SystemAllocationScope
	)

vkCustomCpuFree()

void Foundation::RHI::vkCustomCpuFree	(	Allocator *	alloc,
		void *	pMemory
	)

vkCustomCpuReallocation()

void * Foundation::RHI::vkCustomCpuReallocation	(	Allocator *	alloc,
		void *	pOriginal,
		size_t	size,
		size_t	alignment,
		vk::SystemAllocationScope
	)

vkDescriptorTypeFromRHIDescriptorType()

vk::DescriptorType Foundation::RHI::vkDescriptorTypeFromRHIDescriptorType ( RHIDescriptorType  type )

inline

vkFlagsToBits()

template<typename Bits >

Bits Foundation::RHI::vkFlagsToBits

(

vk::Flags< Bits >

flags

)

vkFormatFromRHIFormat()

vk::Format Foundation::RHI::vkFormatFromRHIFormat ( RHIResourceFormat  format )

inline

vkImageAspectFlagFromRHITextureAspect()

vk::ImageAspectFlags Foundation::RHI::vkImageAspectFlagFromRHITextureAspect ( RHITextureAspectFlag  aspect )

inline

vkImageLayoutFromRHITextureLayout()

vk::ImageLayout Foundation::RHI::vkImageLayoutFromRHITextureLayout ( RHITextureLayout  layout )

inline

vkImageUsageFlagsFromRHITextureUsage()

vk::ImageUsageFlags Foundation::RHI::vkImageUsageFlagsFromRHITextureUsage ( RHITextureUsage  usage )

inline

vkPipelineBindPointFromRHIDevicePipelineType()

vk::PipelineBindPoint Foundation::RHI::vkPipelineBindPointFromRHIDevicePipelineType ( RHIDevicePipelineType  type )

inline

vkPipelineStageFlags2FromRHIPipelineStage()

vk::PipelineStageFlags2 Foundation::RHI::vkPipelineStageFlags2FromRHIPipelineStage ( RHIPipelineStage  stage )

inline

vkPipelineStageFlagsFromRHIPipelineStage()

vk::PipelineStageFlags Foundation::RHI::vkPipelineStageFlagsFromRHIPipelineStage ( RHIPipelineStage  stage )

inline

vkPresentModeFromSwapchainDesc()

vk::PresentModeKHR Foundation::RHI::vkPresentModeFromSwapchainDesc ( RHISwapchainPresentMode  mode )

inline

vkSampleCountFlagFromRHIMultisampleCount()

vk::SampleCountFlagBits Foundation::RHI::vkSampleCountFlagFromRHIMultisampleCount ( RHIMultisampleCount  count )

inline

vkShaderStageFlagsFromRHIShaderStage()

vk::ShaderStageFlags Foundation::RHI::vkShaderStageFlagsFromRHIShaderStage ( RHIShaderStage  stage )

inline

vmaAllocationFlagsFromRHIResourceHostAccess()

VmaAllocationCreateFlags Foundation::RHI::vmaAllocationFlagsFromRHIResourceHostAccess ( RHIResourceHostAccess  access )

inline

Variable Documentation

AccelerationBuild

Foundation::RHI::AccelerationBuild = 1 << 12

AccelerationStructureBuildReadOnly

Foundation::RHI::AccelerationStructureBuildReadOnly = 1 << 9

AccelerationStructureRead

Foundation::RHI::AccelerationStructureRead = 1 << 11

AccelerationStructureStorage

Foundation::RHI::AccelerationStructureStorage = 1 << 8

AccelerationStructureWrite

Foundation::RHI::AccelerationStructureWrite = 1 << 12

All

Foundation::RHI::All

Initial value:

= ~0u
    BITMASK_ENUM_END()

AllGraphics

Foundation::RHI::AllGraphics = 1 << 28

AllowCompaction

Foundation::RHI::AllowCompaction = 1 << 1

AllowUpdate

Foundation::RHI::AllowUpdate = 1 << 0

BottomOfPipe

Foundation::RHI::BottomOfPipe = 1 << 30

Color

Foundation::RHI::Color = 1 << 0

Compute

case Foundation::RHI::Compute = 1u << 1

ComputeShader

Foundation::RHI::ComputeShader = 1 << 4

Depth

Foundation::RHI::Depth = 1 << 1

DepthStencil

Foundation::RHI::DepthStencil = 1 << 1

DepthStencilRead

Foundation::RHI::DepthStencilRead = 1 << 3

DepthStencilWrite

Foundation::RHI::DepthStencilWrite = 1 << 2

DeviceAddress

Foundation::RHI::DeviceAddress = 1 << 7

DrawIndirect

Foundation::RHI::DrawIndirect = 1 << 1

EarlyFragmentTests

Foundation::RHI::EarlyFragmentTests = 1 << 10

Fragment

case Foundation::RHI::Fragment = 1 << 1

FragmentShader

Foundation::RHI::FragmentShader = 1 << 3

Graphics

Foundation::RHI::Graphics = 1u << 0

Host

Foundation::RHI::Host = 1 << 27

HostRead

Foundation::RHI::HostRead = 1 << 10

HostWrite

Foundation::RHI::HostWrite = 1 << 9

IndexBuffer

Foundation::RHI::IndexBuffer = 1 << 1

IndirectBuffer

Foundation::RHI::IndirectBuffer = 1 << 4

kCommandBarrierReserveSize

constexpr size_t Foundation::RHI::kCommandBarrierReserveSize = 256

constexpr

kCommandQueueTransferIgnored

const uint32_t Foundation::RHI::kCommandQueueTransferIgnored = ~0u

kFullSize

constexpr size_t Foundation::RHI::kFullSize = -1

staticconstexpr

kInvalidHandle

constexpr Handle Foundation::RHI::kInvalidHandle = static_cast<Handle>(-1)

staticconstexpr

kInvalidQueueIndex

constexpr uint32_t Foundation::RHI::kInvalidQueueIndex = static_cast<uint32_t>(-1)

constexpr

kRHIObjectPoolMaxSize

constexpr size_t Foundation::RHI::kRHIObjectPoolMaxSize = 65536

staticconstexpr

LateFragmentTests

Foundation::RHI::LateFragmentTests = 1 << 11

LowMemory

Foundation::RHI::LowMemory

Initial value:

= 1 << 4
 
 
 
        TriangleCullDisable = 1 << 0

Mesh

case Foundation::RHI::Mesh = 1 << 9

MeshShader

Foundation::RHI::MeshShader = 1 << 6

PreferFastBuild

Foundation::RHI::PreferFastBuild = 1 << 3

PreferFastTrace

Foundation::RHI::PreferFastTrace = 1 << 2

Present

Foundation::RHI::Present

Initial value:

= 1u << 3
 
 
    enum class RHIDevicePipelineType {
        Graphics,
        Compute,
        RayTracing
    }

RayAnyHit

case Foundation::RHI::RayAnyHit = 1 << 4

RayClosestHit

case Foundation::RHI::RayClosestHit = 1 << 5

RayGeneration

case Foundation::RHI::RayGeneration = 1 << 3

RayIntersection

case Foundation::RHI::RayIntersection = 1 << 7

RayMiss

case Foundation::RHI::RayMiss = 1 << 6

RayTracingShader

Foundation::RHI::RayTracingShader = 1 << 5

RenderTarget

Foundation::RHI::RenderTarget = 1 << 0

RenderTargetOutput

Foundation::RHI::RenderTargetOutput = 1 << 8

RenderTargetRead

Foundation::RHI::RenderTargetRead = 1 << 1

RenderTargetWrite

Foundation::RHI::RenderTargetWrite = 1 << 0

SampledImage

Foundation::RHI::SampledImage = 1 << 2

ShaderBindingTable

Foundation::RHI::ShaderBindingTable

Initial value:

= 1 << 10
    BITMASK_ENUM_END()

ShaderRead

Foundation::RHI::ShaderRead = 1 << 7

ShaderWrite

Foundation::RHI::ShaderWrite = 1 << 6

Stencil

Foundation::RHI::Stencil

Initial value:

= 1 << 2
    BITMASK_ENUM_END()

StorageBuffer

Foundation::RHI::StorageBuffer = 1 << 3

StorageImage

Foundation::RHI::StorageImage = 1 << 3

Task

case Foundation::RHI::Task = 1 << 8

TaskShader

Foundation::RHI::TaskShader = 1 << 7

TopOfPipe

Foundation::RHI::TopOfPipe = 1 << 29

Transfer

Foundation::RHI::Transfer = 1u << 2

TransferDestination

Foundation::RHI::TransferDestination = 1 << 6

TransferRead

Foundation::RHI::TransferRead = 1 << 5

TransferSource

Foundation::RHI::TransferSource = 1 << 5

TransferWrite

Foundation::RHI::TransferWrite = 1 << 4

UniformBuffer

Foundation::RHI::UniformBuffer = 1 << 2

UniformRead

Foundation::RHI::UniformRead = 1 << 8

Vertex

case Foundation::RHI::Vertex = 1 << 0

VertexBuffer

Foundation::RHI::VertexBuffer = 1 << 0

VertexShader

Foundation::RHI::VertexShader = 1 << 2