Diligent namespace

Classes

struct APIInfo

Diligent API Info. This tructure can be used to verify API compatibility.

struct AttachmentReference

Attachment reference description.

class BasicFileStream

Basic file stream implementation.

struct BeginRenderPassAttribs

BeginRenderPass command attributes.

struct BindingTableVk

This structure contains the data that can be used as input arguments for vkCmdTraceRaysKHR() command.

struct BLASBoundingBoxDesc

Defines bottom level acceleration structure axis-aligned bounding boxes description.

struct BLASBuildBoundingBoxData

AABB geometry data description.

struct BLASBuildTriangleData

Triangle geometry data description.

struct BLASTriangleDesc

Defines bottom level acceleration structure triangles description.

struct BlendStateDesc

Blend state description.

template<typename EngineImplTraits>

class BottomLevelASBase

Template class implementing base functionality of the bottom-level acceleration structure object.

class BottomLevelASD3D12Impl

Bottom-level acceleration structure object implementation in Direct3D12 backend.

struct BottomLevelASDesc

Bottom-level AS description.

struct Box

Box.

template<typename EngineImplTraits>

class BufferBase

Template class implementing base functionality of the buffer object.

class BufferD3D11Impl

Buffer object implementation in Direct3D11 backend.

class BufferD3D12Impl

Buffer object implementation in Direct3D12 backend.

struct BufferData

Describes the buffer initial data.

struct BufferDesc

Buffer description.

struct BufferFormat

Buffer format description.

class BufferGLImpl

Buffer object implementation in OpenGL backend.

struct BufferSuballocatorCreateInfo

Buffer suballocator create information.

struct BufferToTextureCopyInfo

Information required to perform a copy operation between a buffer and a texture.

template<typename EngineImplTraits>

class BufferViewBase

Template class implementing base functionality of the buffer view object.

class BufferViewD3D11Impl

Buffer view implementation in Direct3D11 backend.

class BufferViewD3D12Impl

Buffer view implementation in Direct3D12 backend.

struct BufferViewDesc

Buffer view description.

class BufferViewGLImpl

Buffer view implementation in OpenGL backend.

class BufferViewVkImpl

Buffer view implementation in Vulkan backend.

class BufferVkImpl

Buffer object implementation in Vulkan backend.

struct BuildBLASAttribs

This structure is used by IDeviceContext::BuildBLAS().

struct BuildTLASAttribs

This structure is used by IDeviceContext::BuildTLAS().

class ComErrorDesc

Helper class that provides description of a COM error.

template<typename EngineImplTraits>

class CommandListBase

Template class implementing base functionality of the command list object.

class CommandListD3D11Impl

Command list implementation in Direct3D11 backend.

class CommandListD3D12Impl

Command list implementation in Direct3D12 backend.

class CommandListVkImpl

Command list implementation in Vulkan backend.

class CommandQueueD3D12Impl

Implementation of the Diligent::ICommandQueueD3D12 interface.

class CommandQueueVkImpl

Implementation of the Diligent::ICommandQueueVk interface.

struct ComputePipelineStateCreateInfo

Compute pipeline state description.

struct CopyBLASAttribs

This structure is used by IDeviceContext::CopyBLAS().

struct CopyTextureAttribs

Defines copy texture command attributes.

struct CopyTLASAttribs

This structure is used by IDeviceContext::CopyTLAS().

struct D3D11ResourceBindPoints

Resource binding points in all shader stages.

struct D3D11ResourceRangeCounters

Shader resource counters for one specific resource range.

class D3D12ResourceBase

Base implementation of a D3D12 resource.

class DataBlobImpl

Base interface for a data blob.

struct DepthStencilClearValue

Defines optimized depth-stencil clear value.

struct DepthStencilStateDesc

Depth stencil state description.

struct DeviceCaps

Device capabilities.

template<typename EngineImplTraits>

class DeviceContextBase

Base implementation of the device context.

class DeviceContextD3D11Impl

Device context implementation in Direct3D11 backend.

class DeviceContextD3D12Impl

Device context implementation in Direct3D12 backend.

class DeviceContextGLImpl

Device context implementation in OpenGL backend.

template<typename EngineImplTraits>

class DeviceContextNextGenBase

Base implementation of the device context for next-generation backends.

class DeviceContextVkImpl

Device context implementation in Vulkan backend.

struct DeviceFeatures

Describes the device features.

struct DeviceObjectAttribs

Describes common device object attributes.

template<class BaseInterface, typename RenderDeviceImplType, typename ObjectDescType>

class DeviceObjectBase

Template class implementing base functionality of the device object.

struct DeviceProperties

Device properties.

struct DispatchComputeAttribs

Describes dispatch command arguments.

struct DispatchComputeIndirectAttribs

Describes dispatch command arguments.

struct DisplayModeAttribs

Display mode attributes.

struct DrawAttribs

Defines the draw command attributes.

struct DrawIndexedAttribs

Defines the indexed draw command attributes.

struct DrawIndexedIndirectAttribs

Defines the indexed indirect draw command attributes.

struct DrawIndirectAttribs

Defines the indirect draw command attributes.

struct DrawMeshAttribs

Defines the mesh draw command attributes.

struct DrawMeshIndirectAttribs

Defines the mesh indirect draw command attributes.

struct DrawMeshIndirectCountAttribs

Defines the mesh indirect draw count command attributes.

class DurationQueryHelper

Helper class to manage duration queries. One DurationQueryHelper instance must be used once per frame.

class DynamicAtlasManager

Dynamic 2D atlas manager.

class DynamicBuffer

Dynamically resizable buffer.

class DynamicLinearAllocator

Implementation of a linear allocator on fixed memory pages.

class DynamicStaleResourceWrapper

Helper class that wraps stale resources of different types.

struct DynamicTextureAtlasCreateInfo

Dynamic texture atlas create information.

struct EngineCreateInfo

Engine creation attibutes.

struct EngineD3D11CreateInfo

Attributes specific to D3D11 engine.

struct EngineD3D12CreateInfo

Attributes specific to D3D12 engine.

template<class BaseInterface>

class EngineFactoryBase

Template class implementing base functionality of the engine factory.

class EngineFactoryD3D11Impl

Engine factory for D3D11 implementation.

class EngineFactoryD3D12Impl

Engine factory for D3D12 implementation.

class EngineFactoryOpenGLImpl

Engine factory for OpenGL implementation.

class EngineFactoryVkImpl

Engine factory for Vk implementation.

struct EngineGLCreateInfo

Attributes of the OpenGL-based engine implementation.

struct EngineMtlCreateInfo

Attributes of the Metal-based engine implementation.

struct EngineVkCreateInfo

Attributes specific to Vulkan engine.

class FastRand

Fast random number generator.

class FastRandInt

Generates an integer random number in [Min, Max] range.

template<typename Type>

class FastRandReal

Generates a real random number in [Min, Max] range.

template<typename EngineImplTraits>

class FenceBase

Template class implementing base functionality of the fence object.

class FenceD3D11Impl

Fence implementation in Direct3D11 backend.

class FenceD3D12Impl

Fence implementation in Direct3D12 backend.

struct FenceDesc

Fence description.

class FenceGLImpl

Fence object implementation in OpenGL backend.

class FenceVkImpl

Fence implementation in Vulkan backend.

class FixedBlockMemoryAllocator

Memory allocator that allocates memory in a fixed-size chunks.

class FixedLinearAllocator

Implementation of a linear allocator on a fixed-size memory page.

template<typename EngineImplTraits>

class FramebufferBase

Template class implementing base functionality of the framebuffer object.

class FramebufferD3D11Impl

Render pass implementation in Direct3D11 backend.

class FramebufferD3D12Impl

Render pass implementation in Direct3D12 backend.

struct FramebufferDesc

Framebuffer description.

class FramebufferGLImpl

Framebuffer implementation in OpenGL backend.

class FramebufferVkImpl

Framebuffer implementation in Vulkan backend.

struct FullScreenModeDesc

Full screen mode description.

struct GraphicsAdapterInfo

Graphics adapter properties.

struct GraphicsPipelineDesc

Graphics pipeline state description.

struct GraphicsPipelineStateCreateInfo

Graphics pipeline state creation attributes.

struct HashMapStringKey

This helper structure is intended to facilitate using strings as a hash table key. It provides constructors that can make a copy of the source string or just keep a pointer to it, which enables searching in the hash using raw const Char* pointers.

class HLSL2GLSLConverterImpl

HLSL to GLSL shader source code converter implementation.

class HLSL2GLSLConverterObject

Implementation of the Diligent::IHLSL2GLSLConverter interface.

struct HLSLShaderResourceDesc

HLSL resource description.

struct IBottomLevelAS

Bottom-level AS interface.

struct IBottomLevelASD3D12

Exposes Direct3D12-specific functionality of a bottom-level acceleration structure object.

struct IBottomLevelASVk

Exposes Vulkan-specific functionality of a Bottom-level acceleration structure object.

struct IBuffer

Buffer interface.

struct IBufferD3D11

Exposes Direct3D11-specific functionality of a buffer object.

struct IBufferD3D12

Exposes Direct3D12-specific functionality of a buffer object.

struct IBufferGL

Exposes OpenGL-specific functionality of a buffer object.

class IBufferMtl

Exposes Metal-specific functionality of a buffer object.

struct IBufferSuballocation

Buffer suballocation.

struct IBufferSuballocator

Buffer suballocator.

struct IBufferView

Buffer view interface.

struct IBufferViewD3D11

Exposes Direct3D11-specific functionality of a buffer view object.

struct IBufferViewD3D12

Exposes Direct3D12-specific functionality of a buffer view object.

struct IBufferViewGL

Exposes OpenGL-specific functionality of a buffer view object.

class IBufferViewMtl

Exposes Metal-specific functionality of a buffer view object.

struct IBufferViewVk

Exposes Vulkan-specific functionality of a buffer view object.

struct IBufferVk

Exposes Vulkan-specific functionality of a buffer object.

class ICommandList

Command list interface.

struct ICommandQueueD3D12

Command queue interface.

struct ICommandQueueVk

Command queue interface.

struct IDataBlob

Base interface for a file stream.

struct IDeviceContext

Device context interface.

struct IDeviceContextD3D11

Exposes Direct3D11-specific functionality of a device context.

struct IDeviceContextD3D12

Exposes Direct3D12-specific functionality of a device context.

struct IDeviceContextGL

Exposes OpenGL-specific functionality of a device context.

class IDeviceContextMtl

Exposes Metal-specific functionality of a device context.

struct IDeviceContextVk

Exposes Vulkan-specific functionality of a device context.

struct IDeviceObject

Base interface for all objects created by the render device Diligent::IRenderDevice.

class IDXCompiler

DXC compiler interface.

struct IDynamicTextureAtlas

Dynamic texture atlas.

struct IEngineFactory

Engine factory base interface.

struct IEngineFactoryD3D11

Engine factory for Direct3D11 rendering backend.

struct IEngineFactoryD3D12

Engine factory for Direct3D12 rendering backend.

struct IFence

Fence interface.

class IFenceD3D11

Exposes Direct3D11-specific functionality of a fence object.

struct IFenceD3D12

Exposes Direct3D12-specific functionality of a fence object.

struct IFenceGL

Exposes OpenGL-specific functionality of a fence object.

class IFenceMtl

Exposes Metal-specific functionality of a fence object.

struct IFenceVk

Exposes Vulkan-specific functionality of a fence object.

struct IFileStream

Base interface for a file stream.

class IFramebuffer

Framebuffer interface.

struct IFramebufferVk

Exposes Vulkan-specific functionality of a Framebuffer object.

struct IHLSL2GLSLConverter

Interface to the buffer object implemented in OpenGL.

struct IMemoryAllocator

Base interface for a raw memory allocator.

struct ImmutableSamplerDesc

Immutable sampler description.

struct InputLayoutDesc

Layout description.

struct InstanceMatrix

Row-major matrix.

struct INTERFACE_ID

Unique interface identifier.

struct IObject

Base interface for all dynamic objects in the engine.

struct IPipelineResourceSignature

Pipeline resource signature interface.

struct IPipelineState

Pipeline state interface.

struct IPipelineStateD3D11

Exposes Direct3D11-specific functionality of a pipeline state object.

struct IPipelineStateD3D12

Exposes Direct3D12-specific functionality of a pipeline state object.

struct IPipelineStateGL

Exposes OpenGL-specific functionality of a pipeline state object.

class IPipelineStateMtl

Exposes Metal-specific functionality of a pipeline state object.

struct IPipelineStateVk

Exposes Vulkan-specific functionality of a pipeline state object.

struct IQuery

Query interface.

struct IQueryD3D11

Exposes Direct3D11-specific functionality of a Query object.

struct IQueryD3D12

Exposes Direct3D12-specific functionality of a Query object.

struct IQueryGL

Exposes OpenGL-specific functionality of a Query object.

class IQueryMtl

Exposes Metal-specific functionality of a Query object.

struct IQueryVk

Exposes Vulkan-specific functionality of a Query object.

class IReferenceCounters

Base interface for a reference counter object that stores the number of strong and weak references and the pointer to the object. It is necessary to separate reference counters from the object to support weak pointers.

struct IRenderDevice

Render device interface.

struct IRenderDeviceD3D11

Exposes Direct3D11-specific functionality of a render device.

struct IRenderDeviceD3D12

Exposes Direct3D12-specific functionality of a render device.

struct IRenderDeviceGL

Exposes OpenGL-specific functionality of a render device.

class IRenderDeviceGLES

Interface to the render device object implemented in OpenGLES.

class IRenderDeviceMtl

Exposes Metal-specific functionality of a render device.

struct IRenderDeviceVk

Exposes Vulkan-specific functionality of a render device.

class IRenderPass

Render pass interface.

struct IRenderPassVk

Exposes Vulkan-specific functionality of a RenderPass object.

struct IResourceMapping

Resouce mapping.

struct ISampler

Texture sampler interface.

struct ISamplerD3D11

Exposes Direct3D11-specific functionality of a sampler object.

struct ISamplerD3D12

Exposes Direct3D12-specific functionality of a sampler object.

struct ISamplerGL

Exposes OpenGL-specific functionality of a sampler object.

class ISamplerMtl

Exposes Metal-specific functionality of a sampler object.

struct ISamplerVk

Exposes Vulkan-specific functionality of a sampler object.

struct IShader

Shader interface.

struct IShaderBindingTable

Shader binding table interface.

struct IShaderBindingTableD3D12

Exposes Direct3D12-specific functionality of a shader binding table object.

struct IShaderBindingTableVk

Exposes Vulkan-specific functionality of a Shader binding table object.

struct IShaderD3D

Exposes Direct3D-specific functionality of a shader object.

struct IShaderD3D11

Exposes Direct3D11-specific functionality of a shader object.

struct IShaderD3D12

Exposes Direct3D12-specific functionality of a shader object.

struct IShaderGL

Exposes OpenGL-specific functionality of a shader object.

class IShaderMtl

Exposes Metal-specific functionality of a shader object.

struct IShaderResourceBinding

Shader resource binding interface.

struct IShaderResourceBindingD3D11

Exposes Direct3D11-specific functionality of a shader resource binding object.

struct IShaderResourceBindingD3D12

Exposes Direct3D12-specific functionality of a shader resource binding.

struct IShaderResourceBindingGL

Exposes OpenGL-specific functionality of a shader resource binding object.

class IShaderResourceBindingMtl

Exposes Metal-specific functionality of a shader resource binding object.

struct IShaderResourceBindingVk

Exposes Vulkan-specific functionality of a shader resource binding object.

struct IShaderResourceVariable

Shader resource variable.

class IShaderResourceVariableD3D

Interface to the Direct3D ShaderResourceVariable resource variable.

struct IShaderSourceInputStreamFactory

Shader source stream factory interface.

class IShaderVk

Exposes Vulkan-specific functionality of a shader object.

struct ISwapChain

Swap chain interface.

struct ISwapChainD3D11

Exposes Direct3D11-specific functionality of a swap chain.

struct ISwapChainD3D12

Exposes Direct3D12-specific functionality of a swap chain.

struct ISwapChainGL

Exposes OpenGL-specific functionality of a swap chain.

class ISwapChainMtl

Exposes Metal-specific functionality of a swap chain.

struct ISwapChainVk

Exposes Vulkan-specific functionality of a swap chain.

struct ITexture

Texture inteface.

struct ITextureAtlasSuballocation

Dynamic texture atlas suballocation.

struct ITextureD3D11

Exposes Direct3D11-specific functionality of a texture object.

struct ITextureD3D12

Exposes Direct3D12-specific functionality of a texture object.

struct ITextureGL

Exposes OpenGL-specific functionality of a texture object.

class ITextureMtl

Exposes Metal-specific functionality of a texture object.

class ITextureUploader

Asynchronous texture uplader.

struct ITextureView

Texture view interface.

struct ITextureViewD3D11

Exposes Direct3D11-specific functionality of a texture view object.

struct ITextureViewD3D12

Exposes Direct3D12-specific functionality of a texture view object.

struct ITextureViewGL

Exposes OpenGL-specific functionality of a texture view object.

class ITextureViewMtl

Exposes Metal-specific functionality of a texture view object.

struct ITextureViewVk

Exposes Vulkan-specific functionality of a texture view object.

struct ITextureVk

Exposes Vulkan-specific functionality of a texture object.

struct ITopLevelAS

Top-level AS interface.

struct ITopLevelASD3D12

Exposes Direct3D12-specific functionality of a top-level acceleration structure object.

struct ITopLevelASVk

Exposes Vulkan-specific functionality of a Top-level acceleration structure object.

struct LayoutElement

Description of a single element of the input layout.

struct LinearTexFilterSampleInfo

Linear texture filter sample info.

template<typename DataType, bool KeepStrongReferences = false>

class MapHelper

Facilitates resource mapping.

class MemoryFileStream

Memory file stream implementation.

struct MipLevelProperties

Describes the mip level properties.

template<typename BaseInterface>

class ObjectBase

Template class implementing base functionality for an object.

struct OptimizedClearValue

Defines optimized clear value.

class PipelineLayoutVk

Implementation of the Diligent::PipelineLayoutVk class.

struct PipelineResourceDesc

Pipeline resource description.

struct PipelineResourceLayoutDesc

Pipeline layout description.

template<typename EngineImplTraits>

class PipelineResourceSignatureBase

Template class implementing base functionality of the pipeline resource signature object.

class PipelineResourceSignatureD3D11Impl

Implementation of the Diligent::PipelineResourceSignatureD3D11Impl class.

class PipelineResourceSignatureD3D12Impl

Implementation of the Diligent::PipelineResourceSignatureD3D12Impl class.

struct PipelineResourceSignatureDesc

Pipeline resource signature description.

class PipelineResourceSignatureGLImpl

Implementation of the Diligent::PipelineResourceSignatureGLImpl class.

class PipelineResourceSignatureVkImpl

Implementation of the Diligent::PipelineResourceSignatureVkImpl class.

template<typename EngineImplTraits>

class PipelineStateBase

Template class implementing base functionality of the pipeline state object.

struct PipelineStateCreateInfo

Pipeline state creation attributes.

class PipelineStateD3D11Impl

Pipeline state object implementation in Direct3D11 backend.

class PipelineStateD3D12Impl

Pipeline state object implementation in Direct3D12 backend.

struct PipelineStateDesc

Pipeline state description.

class PipelineStateGLImpl

Pipeline state object implementation in OpenGL backend.

class PipelineStateVkImpl

Pipeline state object implementation in Vulkan backend.

template<typename EngineImplTraits>

class QueryBase

Template class implementing base functionality of the query object.

class QueryD3D11Impl

Query implementation in Direct3D11 backend.

class QueryD3D12Impl

Query implementation in Direct3D12 backend.

struct QueryDataBinaryOcclusion

Binary occlusion query data. This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_BINARY_OCCLUSION query type.

struct QueryDataDuration

Duration query data. This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_DURATION query type.

struct QueryDataOcclusion

Occlusion query data. This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_OCCLUSION query type.

struct QueryDataPipelineStatistics

Pipeline statistics query data. This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_PIPELINE_STATISTICS query type.

struct QueryDataTimestamp

Timestamp query data. This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_TIMESTAMP query type.

struct QueryDesc

Query description.

class QueryGLImpl

Query object implementation in OpenGL backend.

class QueryVkImpl

Query implementation in Vulkan backend.

struct RasterizerStateDesc

Rasterizer state description.

struct RayTracingGeneralShaderGroup

Ray tracing general shader group description.

struct RayTracingPipelineDesc

This structure describes the ray tracing pipeline state and is part of the RayTracingPipelineStateCreateInfo structure.

struct RayTracingPipelineStateCreateInfo

Ray tracing pipeline state description.

struct RayTracingProceduralHitShaderGroup

Ray tracing procedural hit shader group description.

struct RayTracingTriangleHitShaderGroup

Ray tracing triangle hit shader group description.

struct Rect

Describes the rectangle.

template<typename T>

class RefCntAutoPtr

Template class that implements reference counting.

template<typename T>

class RefCntWeakPtr

Implementation of weak pointers.

template<typename Base>

class RefCountedObject

Base class for all reference counting objects.

template<typename EngineImplTraits>

class RenderDeviceBase

Base implementation of a render device.

class RenderDeviceD3D11Impl

Render device implementation in Direct3D11 backend.

class RenderDeviceD3D12Impl

Render device implementation in Direct3D12 backend.

template<typename EngineImplTraits>

class RenderDeviceD3DBase

Base implementation of a D3D render device.

class RenderDeviceGLImpl

Render device implementation in OpenGL backend.

template<class TBase, typename CommandQueueType>

class RenderDeviceNextGenBase

Base implementation of the render device for next-generation backends.

class RenderDeviceVkImpl

Render device implementation in Vulkan backend.

struct RenderPassAttachmentDesc

Render pass attachment description.

template<typename EngineImplTraits>

class RenderPassBase

Template class implementing base functionality of the render pass object.

class RenderPassD3D11Impl

Render pass implementation in Direct3D11 backend.

class RenderPassD3D12Impl

Render pass implementation in Direct3D12 backend.

struct RenderPassDesc

Render pass description.

class RenderPassGLImpl

Render pass implementation in OpenGL backend.

class RenderPassVkImpl

Render pass implementation in Vulkan backend.

struct RenderTargetBlendDesc

Describes a blend state for a single render target.

struct ResolveTextureSubresourceAttribs

Describes multi-sampled texture resolve command arguments.

struct ResourceMappingDesc

Resource mapping description.

struct ResourceMappingEntry

Describes the resourse mapping object entry.

class ResourceMappingImpl

Implementation of the resource mapping.

template<typename ResourceWrapperType>

class ResourceReleaseQueue

Facilitates safe resource destruction in D3D12 and Vulkan.

class RingBuffer

Implementation of a ring buffer. The class is not thread-safe.

class RootParamsManager

Container for root parameters.

class RootSignatureCacheD3D12

Root signature cache that deduplicates RootSignatureD3D12 objects.

class RootSignatureD3D12

Implementation of the Diligent::RootSignature class.

struct SampleDesc

Sample description.

template<typename EngineImplTraits>

class SamplerBase

Template class implementing base functionality of the sampler object.

struct SamplerCaps

Texture sampler capabilities.

class SamplerD3D11Impl

Sampler implementation in Direct3D11 backend.

class SamplerD3D12Impl

Sampler object implementation in Direct3D12 backend.

struct SamplerDesc

Sampler description.

class SamplerGLImpl

Sampler implementation in OpenGL backend.

class SamplerVkImpl

Sampler object object implementation in Vulkan backend.

class ScopedQueryHelper

Helper class to manage scoped queries. One scoped query instance must be used once per frame.

struct ScratchBufferSizes

Defines the scratch buffer info for acceleration structure.

template<typename EngineImplTraits>

class ShaderBase

Template class implementing base functionality of the shader object.

template<typename EngineImplTraits>

class ShaderBindingTableBase

Template class implementing base functionality of the shader binding table object.

class ShaderBindingTableD3D12Impl

Shader binding table object implementation in Direct3D12 backend.

struct ShaderBindingTableDesc

Shader binding table description.

struct ShaderCreateInfo

Shader creation attributes.

class ShaderD3D11Impl

Shader implementation in Direct3D11 backend.

class ShaderD3D12Impl

Implementation of a shader object in Direct3D12 backend.

class ShaderD3DBase

Base implementation of a D3D shader.

struct ShaderDesc

Shader description.

class ShaderGLImpl

Shader object implementation in OpenGL backend.

template<typename EngineImplTraits>

class ShaderResourceBindingBase

Template class implementing base functionality of the shader resource binding.

class ShaderResourceBindingD3D11Impl

Implementation of shader resource binding object in Direct3D11 backend.

class ShaderResourceBindingD3D12Impl

Implementation of the Diligent::IShaderResourceBindingD3D12 interface.

class ShaderResourceBindingGLImpl

Shader resource binding object implementation in OpenGL backend.

class ShaderResourceBindingVkImpl

Implementation of the Diligent::IShaderResourceBindingVk interface.

class ShaderResourceCacheD3D11

The class implements a cache that holds resources bound to all shader stages.

class ShaderResourceCacheGL

The class implements a cache that holds resources bound to a specific GL program.

struct ShaderResourceDesc

Shader resource description.

class ShaderResources

Diligent::ShaderResources class.

class ShaderResourcesD3D11

Diligent::ShaderResourcesD3D11 class.

class ShaderResourcesD3D12

Diligent::ShaderResourcesD3D12 class.

struct ShaderResourceVariableDesc

Describes shader variable.

template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>

struct ShaderVariableBase

Base implementation of a shader variable.

class ShaderVariableManagerD3D11

Diligent::ShaderVariableManagerD3D11 class.

struct ShaderVersion

Shader version.

class ShaderVkImpl

Shader object object implementation in Vulkan backend.

class SPIRVShaderResources

Diligent::SPIRVShaderResources class.

template<typename ResourceDescType>

class StateObjectsRegistry

Template class implementing state object registry.

struct StateTransitionDesc

Resource state transition barrier description.

template<typename ResourceType>

class StaticStaleResourceWrapper

Helper class that wraps stale resources of the same type.

struct StencilOpDesc

Describes stencil operations that are performed based on the results of depth test.

class StringDataBlobImpl

Base interface for a file stream.

class StringPool

Implementation of a simple fixed-size string pool.

struct SubpassDependencyDesc

Subpass dependency description.

struct SubpassDesc

Render pass subpass decription.

template<class BaseInterface>

class SwapChainBase

Base implementation of the swap chain.

class SwapChainD3D11Impl

Swap chain implementation in Direct3D11 backend.

class SwapChainD3D12Impl

Swap chain implementation in Direct3D12 backend.

template<class BaseInterface, typename DXGISwapChainType>

class SwapChainD3DBase

Base implementation of a D3D swap chain.

struct SwapChainDesc

Swap chain description.

template<class BaseInterface>

class SwapChainGLBase

Base implementation of a swap chain for OpenGL.

class SwapChainGLImpl

Swap chain implementation in OpenGL backend.

class SwapChainGLIOS

Implementation of the Diligent::ISwapChainGL interface on IOS.

class SwapChainVkImpl

Swap chain implementation in Vulkan backend.

class Texture1D_D3D11

Implementation of a 1D texture in Direct3D11 backend.

class Texture1D_GL

1D texture implementation in OpenGL backend.

class Texture1DArray_GL

1D texture array implementation in OpenGL backend.

class Texture2D_D3D11

Implementation of a 2D texture in Direct3D11 backend.

class Texture2D_GL

2D texture implementation in OpenGL backend.

class Texture2DArray_GL

2D texture array implementation in OpenGL backend.

class Texture3D_D3D11

Implementation of a 3D texture in Direct3D11 backend.

class Texture3D_GL

3D texture implementation in OpenGL backend.

template<typename EngineImplTraits>

class TextureBase

Base implementation of the ITexture interface.

class TextureBaseD3D11

Base implementation of a texture object in Direct3D11 backend.

class TextureBaseGL

Base implementation of a texture object in OpenGL backend.

struct TextureCaps

Texture capabilities.

class TextureCube_GL

Cube texture implementation in OpenGL backend.

class TextureCubeArray_GL

Cube array texture implementation in OpenGL backend.

class TextureD3D12Impl

Implementation of a texture object in Direct3D12 backend.

struct TextureData

Describes the initial data to store in the texture.

struct TextureDesc

Texture description.

struct TextureFormatAttribs

Describes invariant texture format attributes. These attributes are intrinsic to the texture format itself and do not depend on the format support.

struct TextureFormatInfo

Basic texture format description.

struct TextureFormatInfoExt

Extended texture format information.

struct TextureSubResData

Describes data for one subresource.

struct TextureUploaderDesc

Texture uploader description.

struct TextureUploaderStats

Texture uploader statistics.

template<typename EngineImplTraits>

class TextureViewBase

Template class implementing base functionality of the texture view interface.

class TextureViewD3D11Impl

Texture view implementation in Direct3D11 backend.

class TextureViewD3D12Impl

Texture view object implementation in Direct3D12 backend.

struct TextureViewDesc

Texture view description.

class TextureViewGLImpl

Texture view implementation in OpenGL backend.

class TextureViewVkImpl

Texture view implementation in Vulkan backend.

class TextureVkImpl

Texture object implementation in Vulkan backend.

struct TLASBuildInfo

Defines TLAS state that was used in the last build.

struct TLASBuildInstanceData

This structure is used by BuildTLASAttribs.

struct TLASInstanceDesc

Top-level AS instance description.

template<typename EngineImplTraits>

class TopLevelASBase

Template class implementing base functionality of the top-level acceleration structure object.

class TopLevelASD3D12Impl

Top-level acceleration structure object implementation in Direct3D12 backend.

struct TopLevelASDesc

Top-level AS description.

struct TraceRaysAttribs

This structure is used by IDeviceContext::TraceRays().

struct TraceRaysIndirectAttribs

This structure is used by IDeviceContext::TraceRaysIndirect().

struct UpdateIndirectRTBufferAttribs

This structure is used by IDeviceContext::UpdateSBT().

struct UploadBufferDesc

Upload buffer description.

template<VALUE_TYPE ValType>

struct VALUE_TYPE2CType

Template structure to convert VALUE_TYPE enumeration into C-type.

template<>

struct VALUE_TYPE2CType<VT_FLOAT16>

VALUE_TYPE2CType<> template specialization for half-precision 16-bit floating-point value type.

template<>

struct VALUE_TYPE2CType<VT_FLOAT32>

VALUE_TYPE2CType<> template specialization for full-precision 32-bit floating-point value type.

template<>

struct VALUE_TYPE2CType<VT_INT16>

VALUE_TYPE2CType<> template specialization for 16-bit integer value type.

template<>

struct VALUE_TYPE2CType<VT_INT32>

VALUE_TYPE2CType<> template specialization for 32-bit integer value type.

template<>

struct VALUE_TYPE2CType<VT_INT8>

VALUE_TYPE2CType<> template specialization for 8-bit integer value type.

template<>

struct VALUE_TYPE2CType<VT_UINT16>

VALUE_TYPE2CType<> template specialization for 16-bit unsigned-integer value type.

template<>

struct VALUE_TYPE2CType<VT_UINT32>

VALUE_TYPE2CType<> template specialization for 32-bit unsigned-integer value type.

template<>

struct VALUE_TYPE2CType<VT_UINT8>

VALUE_TYPE2CType<> template specialization for 8-bit unsigned-integer value type.

template<typename BufferImplType>

struct VertexStreamInfo

Describes input vertex stream.

struct Viewport

Describes the viewport.

struct VulkanDescriptorPoolSize

Descriptor pool size.

struct WaveOpProperties

Wave operation properties.

struct WriteBLASCompactedSizeAttribs

This structure is used by IDeviceContext::WriteBLASCompactedSize().

struct WriteTLASCompactedSizeAttribs

This structure is used by IDeviceContext::WriteTLASCompactedSize().

Enums

enum class ResourceCacheContentType: Uint8 { Signature, SRB }

The type of the content that is stored in the shader resource cache.

enum BLEND_FACTOR: Int8 { BLEND_FACTOR_UNDEFINED = 0, BLEND_FACTOR_ZERO, BLEND_FACTOR_ONE, BLEND_FACTOR_SRC_COLOR, BLEND_FACTOR_INV_SRC_COLOR, BLEND_FACTOR_SRC_ALPHA, BLEND_FACTOR_INV_SRC_ALPHA, BLEND_FACTOR_DEST_ALPHA, BLEND_FACTOR_INV_DEST_ALPHA, BLEND_FACTOR_DEST_COLOR, BLEND_FACTOR_INV_DEST_COLOR, BLEND_FACTOR_SRC_ALPHA_SAT, BLEND_FACTOR_BLEND_FACTOR, BLEND_FACTOR_INV_BLEND_FACTOR, BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_INV_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, BLEND_FACTOR_INV_SRC1_ALPHA, BLEND_FACTOR_NUM_FACTORS }

Blend factors.

enum BLEND_OPERATION: Int8 { BLEND_OPERATION_UNDEFINED = 0, BLEND_OPERATION_ADD, BLEND_OPERATION_SUBTRACT, BLEND_OPERATION_REV_SUBTRACT, BLEND_OPERATION_MIN, BLEND_OPERATION_MAX, BLEND_OPERATION_NUM_OPERATIONS }

Blending operation.

enum COLOR_MASK: Int8 { COLOR_MASK_NONE = 0, COLOR_MASK_RED = 1, COLOR_MASK_GREEN = 2, COLOR_MASK_BLUE = 4, COLOR_MASK_ALPHA = 8, COLOR_MASK_ALL = (((COLOR_MASK_RED | COLOR_MASK_GREEN) | COLOR_MASK_BLUE) | COLOR_MASK_ALPHA) }

Color component write flags.

enum LOGIC_OPERATION: Int8 { LOGIC_OP_CLEAR = 0, LOGIC_OP_SET, LOGIC_OP_COPY, LOGIC_OP_COPY_INVERTED, LOGIC_OP_NOOP, LOGIC_OP_INVERT, LOGIC_OP_AND, LOGIC_OP_NAND, LOGIC_OP_OR, LOGIC_OP_NOR, LOGIC_OP_XOR, LOGIC_OP_EQUIV, LOGIC_OP_AND_REVERSE, LOGIC_OP_AND_INVERTED, LOGIC_OP_OR_REVERSE, LOGIC_OP_OR_INVERTED, LOGIC_OP_NUM_OPERATIONS }

Logic operation.

enum RAYTRACING_BUILD_AS_FLAGS: Uint8 { RAYTRACING_BUILD_AS_NONE = 0, RAYTRACING_BUILD_AS_ALLOW_UPDATE = 0x01, RAYTRACING_BUILD_AS_ALLOW_COMPACTION = 0x02, RAYTRACING_BUILD_AS_PREFER_FAST_TRACE = 0x04, RAYTRACING_BUILD_AS_PREFER_FAST_BUILD = 0x08, RAYTRACING_BUILD_AS_LOW_MEMORY = 0x10, RAYTRACING_BUILD_AS_FLAGS_LAST = RAYTRACING_BUILD_AS_LOW_MEMORY }

Defines acceleration structures build flags.

enum BUFFER_MODE: Uint8 { BUFFER_MODE_UNDEFINED = 0, BUFFER_MODE_FORMATTED, BUFFER_MODE_STRUCTURED, BUFFER_MODE_RAW, BUFFER_MODE_NUM_MODES }

Describes the buffer access mode.

enum STENCIL_OP: Int8 { STENCIL_OP_UNDEFINED = 0, STENCIL_OP_KEEP = 1, STENCIL_OP_ZERO = 2, STENCIL_OP_REPLACE = 3, STENCIL_OP_INCR_SAT = 4, STENCIL_OP_DECR_SAT = 5, STENCIL_OP_INVERT = 6, STENCIL_OP_INCR_WRAP = 7, STENCIL_OP_DECR_WRAP = 8, STENCIL_OP_NUM_OPS }

Stencil operation.

enum DRAW_FLAGS: Uint8 { DRAW_FLAG_NONE = 0x00, DRAW_FLAG_VERIFY_STATES = 0x01, DRAW_FLAG_VERIFY_DRAW_ATTRIBS = 0x02, DRAW_FLAG_VERIFY_RENDER_TARGETS = 0x04, DRAW_FLAG_VERIFY_ALL = DRAW_FLAG_VERIFY_STATES | DRAW_FLAG_VERIFY_DRAW_ATTRIBS | DRAW_FLAG_VERIFY_RENDER_TARGETS, DRAW_FLAG_DYNAMIC_RESOURCE_BUFFERS_INTACT = 0x08 }

Draw command flags.

enum RESOURCE_STATE_TRANSITION_MODE: Uint8 { RESOURCE_STATE_TRANSITION_MODE_NONE = 0, RESOURCE_STATE_TRANSITION_MODE_TRANSITION, RESOURCE_STATE_TRANSITION_MODE_VERIFY }

Defines resource state transition mode performed by various commands.

enum CLEAR_DEPTH_STENCIL_FLAGS: Uint32 { CLEAR_DEPTH_FLAG_NONE = 0x00, CLEAR_DEPTH_FLAG = 0x01, CLEAR_STENCIL_FLAG = 0x02 }

Defines which parts of the depth-stencil buffer to clear.

enum SET_VERTEX_BUFFERS_FLAGS: Uint8 { SET_VERTEX_BUFFERS_FLAG_NONE = 0x00, SET_VERTEX_BUFFERS_FLAG_RESET = 0x01 }

Defines allowed flags for IDeviceContext::SetVertexBuffers() function.

enum RAYTRACING_INSTANCE_FLAGS: Uint8 { RAYTRACING_INSTANCE_NONE = 0, RAYTRACING_INSTANCE_TRIANGLE_FACING_CULL_DISABLE = 0x01, RAYTRACING_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE = 0x02, RAYTRACING_INSTANCE_FORCE_OPAQUE = 0x04, RAYTRACING_INSTANCE_FORCE_NO_OPAQUE = 0x08, RAYTRACING_INSTANCE_FLAGS_LAST = RAYTRACING_INSTANCE_FORCE_NO_OPAQUE }

TLAS instance flags that are used in IDeviceContext::BuildTLAS().

enum COPY_AS_MODE: Uint8 { COPY_AS_MODE_CLONE = 0, COPY_AS_MODE_COMPACT, COPY_AS_MODE_LAST = COPY_AS_MODE_COMPACT }

Defines acceleration structure copy mode.

enum RAYTRACING_GEOMETRY_FLAGS: Uint8 { RAYTRACING_GEOMETRY_FLAG_NONE = 0, RAYTRACING_GEOMETRY_FLAG_OPAQUE = 0x01, RAYTRACING_GEOMETRY_FLAG_NO_DUPLICATE_ANY_HIT_INVOCATION = 0x02, RAYTRACING_GEOMETRY_FLAGS_LAST = RAYTRACING_GEOMETRY_FLAG_NO_DUPLICATE_ANY_HIT_INVOCATION }

Defines geometry flags for ray tracing.

enum VALUE_TYPE: Uint8 { VT_UNDEFINED = 0, VT_INT8, VT_INT16, VT_INT32, VT_UINT8, VT_UINT16, VT_UINT32, VT_FLOAT16, VT_FLOAT32, VT_NUM_TYPES }

Value type.

enum SHADER_TYPE: Uint32 { SHADER_TYPE_UNKNOWN = 0x0000, SHADER_TYPE_VERTEX = 0x0001, SHADER_TYPE_PIXEL = 0x0002, SHADER_TYPE_GEOMETRY = 0x0004, SHADER_TYPE_HULL = 0x0008, SHADER_TYPE_DOMAIN = 0x0010, SHADER_TYPE_COMPUTE = 0x0020, SHADER_TYPE_AMPLIFICATION = 0x0040, SHADER_TYPE_MESH = 0x0080, SHADER_TYPE_RAY_GEN = 0x0100, SHADER_TYPE_RAY_MISS = 0x0200, SHADER_TYPE_RAY_CLOSEST_HIT = 0x0400, SHADER_TYPE_RAY_ANY_HIT = 0x0800, SHADER_TYPE_RAY_INTERSECTION = 0x1000, SHADER_TYPE_CALLABLE = 0x2000, SHADER_TYPE_LAST = SHADER_TYPE_CALLABLE, SHADER_TYPE_ALL_GRAPHICS = SHADER_TYPE_VERTEX | SHADER_TYPE_PIXEL | SHADER_TYPE_GEOMETRY | SHADER_TYPE_HULL | SHADER_TYPE_DOMAIN, SHADER_TYPE_ALL_MESH = SHADER_TYPE_AMPLIFICATION | SHADER_TYPE_MESH | SHADER_TYPE_PIXEL, SHADER_TYPE_ALL_RAY_TRACING = SHADER_TYPE_RAY_GEN | SHADER_TYPE_RAY_MISS | SHADER_TYPE_RAY_CLOSEST_HIT | SHADER_TYPE_RAY_ANY_HIT | SHADER_TYPE_RAY_INTERSECTION | SHADER_TYPE_CALLABLE }

Describes the shader type.

enum BIND_FLAGS: Uint32 { BIND_NONE = 0x0, BIND_VERTEX_BUFFER = 0x1, BIND_INDEX_BUFFER = 0x2, BIND_UNIFORM_BUFFER = 0x4, BIND_SHADER_RESOURCE = 0x8, BIND_STREAM_OUTPUT = 0x10, BIND_RENDER_TARGET = 0x20, BIND_DEPTH_STENCIL = 0x40, BIND_UNORDERED_ACCESS = 0x80, BIND_INDIRECT_DRAW_ARGS = 0x100, BIND_INPUT_ATTACHMENT = 0x200, BIND_RAY_TRACING = 0x400, BIND_FLAGS_LAST = 0x400 }

Resource binding flags.

enum USAGE: Uint8 { USAGE_IMMUTABLE = 0, USAGE_DEFAULT, USAGE_DYNAMIC, USAGE_STAGING, USAGE_UNIFIED, USAGE_NUM_USAGES }

Resource usage.

enum CPU_ACCESS_FLAGS: Uint8 { CPU_ACCESS_NONE = 0x00, CPU_ACCESS_READ = 0x01, CPU_ACCESS_WRITE = 0x02 }

Allowed CPU access mode flags when mapping a resource.

enum MAP_TYPE: Uint8 { MAP_READ = 0x01, MAP_WRITE = 0x02, MAP_READ_WRITE = 0x03 }

Resource mapping type.

enum MAP_FLAGS: Uint8 { MAP_FLAG_NONE = 0x000, MAP_FLAG_DO_NOT_WAIT = 0x001, MAP_FLAG_DISCARD = 0x002, MAP_FLAG_NO_OVERWRITE = 0x004 }

Special map flags.

enum RESOURCE_DIMENSION: Uint8 { RESOURCE_DIM_UNDEFINED = 0, RESOURCE_DIM_BUFFER, RESOURCE_DIM_TEX_1D, RESOURCE_DIM_TEX_1D_ARRAY, RESOURCE_DIM_TEX_2D, RESOURCE_DIM_TEX_2D_ARRAY, RESOURCE_DIM_TEX_3D, RESOURCE_DIM_TEX_CUBE, RESOURCE_DIM_TEX_CUBE_ARRAY, RESOURCE_DIM_NUM_DIMENSIONS }

Describes resource dimension.

enum TEXTURE_VIEW_TYPE: Uint8 { TEXTURE_VIEW_UNDEFINED = 0, TEXTURE_VIEW_SHADER_RESOURCE, TEXTURE_VIEW_RENDER_TARGET, TEXTURE_VIEW_DEPTH_STENCIL, TEXTURE_VIEW_UNORDERED_ACCESS, TEXTURE_VIEW_NUM_VIEWS }

Texture view type.

enum BUFFER_VIEW_TYPE: Uint8 { BUFFER_VIEW_UNDEFINED = 0, BUFFER_VIEW_SHADER_RESOURCE, BUFFER_VIEW_UNORDERED_ACCESS, BUFFER_VIEW_NUM_VIEWS }

Buffer view type.

enum TEXTURE_FORMAT: Uint16 { TEX_FORMAT_UNKNOWN = 0, TEX_FORMAT_RGBA32_TYPELESS, TEX_FORMAT_RGBA32_FLOAT, TEX_FORMAT_RGBA32_UINT, TEX_FORMAT_RGBA32_SINT, TEX_FORMAT_RGB32_TYPELESS, TEX_FORMAT_RGB32_FLOAT, TEX_FORMAT_RGB32_UINT, TEX_FORMAT_RGB32_SINT, TEX_FORMAT_RGBA16_TYPELESS, TEX_FORMAT_RGBA16_FLOAT, TEX_FORMAT_RGBA16_UNORM, TEX_FORMAT_RGBA16_UINT, TEX_FORMAT_RGBA16_SNORM, TEX_FORMAT_RGBA16_SINT, TEX_FORMAT_RG32_TYPELESS, TEX_FORMAT_RG32_FLOAT, TEX_FORMAT_RG32_UINT, TEX_FORMAT_RG32_SINT, TEX_FORMAT_R32G8X24_TYPELESS, TEX_FORMAT_D32_FLOAT_S8X24_UINT, TEX_FORMAT_R32_FLOAT_X8X24_TYPELESS, TEX_FORMAT_X32_TYPELESS_G8X24_UINT, TEX_FORMAT_RGB10A2_TYPELESS, TEX_FORMAT_RGB10A2_UNORM, TEX_FORMAT_RGB10A2_UINT, TEX_FORMAT_R11G11B10_FLOAT, TEX_FORMAT_RGBA8_TYPELESS, TEX_FORMAT_RGBA8_UNORM, TEX_FORMAT_RGBA8_UNORM_SRGB, TEX_FORMAT_RGBA8_UINT, TEX_FORMAT_RGBA8_SNORM, TEX_FORMAT_RGBA8_SINT, TEX_FORMAT_RG16_TYPELESS, TEX_FORMAT_RG16_FLOAT, TEX_FORMAT_RG16_UNORM, TEX_FORMAT_RG16_UINT, TEX_FORMAT_RG16_SNORM, TEX_FORMAT_RG16_SINT, TEX_FORMAT_R32_TYPELESS, TEX_FORMAT_D32_FLOAT, TEX_FORMAT_R32_FLOAT, TEX_FORMAT_R32_UINT, TEX_FORMAT_R32_SINT, TEX_FORMAT_R24G8_TYPELESS, TEX_FORMAT_D24_UNORM_S8_UINT, TEX_FORMAT_R24_UNORM_X8_TYPELESS, TEX_FORMAT_X24_TYPELESS_G8_UINT, TEX_FORMAT_RG8_TYPELESS, TEX_FORMAT_RG8_UNORM, TEX_FORMAT_RG8_UINT, TEX_FORMAT_RG8_SNORM, TEX_FORMAT_RG8_SINT, TEX_FORMAT_R16_TYPELESS, TEX_FORMAT_R16_FLOAT, TEX_FORMAT_D16_UNORM, TEX_FORMAT_R16_UNORM, TEX_FORMAT_R16_UINT, TEX_FORMAT_R16_SNORM, TEX_FORMAT_R16_SINT, TEX_FORMAT_R8_TYPELESS, TEX_FORMAT_R8_UNORM, TEX_FORMAT_R8_UINT, TEX_FORMAT_R8_SNORM, TEX_FORMAT_R8_SINT, TEX_FORMAT_A8_UNORM, TEX_FORMAT_R1_UNORM, TEX_FORMAT_RGB9E5_SHAREDEXP, TEX_FORMAT_RG8_B8G8_UNORM, TEX_FORMAT_G8R8_G8B8_UNORM, TEX_FORMAT_BC1_TYPELESS, TEX_FORMAT_BC1_UNORM, TEX_FORMAT_BC1_UNORM_SRGB, TEX_FORMAT_BC2_TYPELESS, TEX_FORMAT_BC2_UNORM, TEX_FORMAT_BC2_UNORM_SRGB, TEX_FORMAT_BC3_TYPELESS, TEX_FORMAT_BC3_UNORM, TEX_FORMAT_BC3_UNORM_SRGB, TEX_FORMAT_BC4_TYPELESS, TEX_FORMAT_BC4_UNORM, TEX_FORMAT_BC4_SNORM, TEX_FORMAT_BC5_TYPELESS, TEX_FORMAT_BC5_UNORM, TEX_FORMAT_BC5_SNORM, TEX_FORMAT_B5G6R5_UNORM, TEX_FORMAT_B5G5R5A1_UNORM, TEX_FORMAT_BGRA8_UNORM, TEX_FORMAT_BGRX8_UNORM, TEX_FORMAT_R10G10B10_XR_BIAS_A2_UNORM, TEX_FORMAT_BGRA8_TYPELESS, TEX_FORMAT_BGRA8_UNORM_SRGB, TEX_FORMAT_BGRX8_TYPELESS, TEX_FORMAT_BGRX8_UNORM_SRGB, TEX_FORMAT_BC6H_TYPELESS, TEX_FORMAT_BC6H_UF16, TEX_FORMAT_BC6H_SF16, TEX_FORMAT_BC7_TYPELESS, TEX_FORMAT_BC7_UNORM, TEX_FORMAT_BC7_UNORM_SRGB, TEX_FORMAT_NUM_FORMATS }

Texture formats.

enum FILTER_TYPE: Uint8 { FILTER_TYPE_UNKNOWN = 0, FILTER_TYPE_POINT, FILTER_TYPE_LINEAR, FILTER_TYPE_ANISOTROPIC, FILTER_TYPE_COMPARISON_POINT, FILTER_TYPE_COMPARISON_LINEAR, FILTER_TYPE_COMPARISON_ANISOTROPIC, FILTER_TYPE_MINIMUM_POINT, FILTER_TYPE_MINIMUM_LINEAR, FILTER_TYPE_MINIMUM_ANISOTROPIC, FILTER_TYPE_MAXIMUM_POINT, FILTER_TYPE_MAXIMUM_LINEAR, FILTER_TYPE_MAXIMUM_ANISOTROPIC, FILTER_TYPE_NUM_FILTERS }

Filter type.

enum TEXTURE_ADDRESS_MODE: Uint8 { TEXTURE_ADDRESS_UNKNOWN = 0, TEXTURE_ADDRESS_WRAP = 1, TEXTURE_ADDRESS_MIRROR = 2, TEXTURE_ADDRESS_CLAMP = 3, TEXTURE_ADDRESS_BORDER = 4, TEXTURE_ADDRESS_MIRROR_ONCE = 5, TEXTURE_ADDRESS_NUM_MODES }

Texture address mode.

enum COMPARISON_FUNCTION: Uint8 { COMPARISON_FUNC_UNKNOWN = 0, COMPARISON_FUNC_NEVER, COMPARISON_FUNC_LESS, COMPARISON_FUNC_EQUAL, COMPARISON_FUNC_LESS_EQUAL, COMPARISON_FUNC_GREATER, COMPARISON_FUNC_NOT_EQUAL, COMPARISON_FUNC_GREATER_EQUAL, COMPARISON_FUNC_ALWAYS, COMPARISON_FUNC_NUM_FUNCTIONS }

Comparison function.

enum MISC_TEXTURE_FLAGS: Uint8 { MISC_TEXTURE_FLAG_NONE = 0x00, MISC_TEXTURE_FLAG_GENERATE_MIPS = 0x01 }

Miscellaneous texture flags.

enum PRIMITIVE_TOPOLOGY: Uint8 { PRIMITIVE_TOPOLOGY_UNDEFINED = 0, PRIMITIVE_TOPOLOGY_TRIANGLE_LIST, PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP, PRIMITIVE_TOPOLOGY_POINT_LIST, PRIMITIVE_TOPOLOGY_LINE_LIST, PRIMITIVE_TOPOLOGY_LINE_STRIP, PRIMITIVE_TOPOLOGY_1_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_2_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_3_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_4_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_5_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_6_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_7_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_8_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_9_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_10_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_11_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_12_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_13_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_14_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_15_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_16_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_17_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_18_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_19_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_20_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_21_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_22_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_23_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_24_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_25_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_26_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_27_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_28_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_29_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_30_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_31_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_32_CONTROL_POINT_PATCHLIST, PRIMITIVE_TOPOLOGY_NUM_TOPOLOGIES }

Input primitive topology.

enum ADAPTER_TYPE: Uint8 { ADAPTER_TYPE_UNKNOWN = 0, ADAPTER_TYPE_SOFTWARE, ADAPTER_TYPE_HARDWARE }

Hardware adapter type.

enum SCALING_MODE { SCALING_MODE_UNSPECIFIED = 0, SCALING_MODE_CENTERED = 1, SCALING_MODE_STRETCHED = 2 }

Flags indicating how an image is stretched to fit a given monitor's resolution.

enum SCANLINE_ORDER { SCANLINE_ORDER_UNSPECIFIED = 0, SCANLINE_ORDER_PROGRESSIVE = 1, SCANLINE_ORDER_UPPER_FIELD_FIRST = 2, SCANLINE_ORDER_LOWER_FIELD_FIRST = 3 }

Flags indicating the method the raster uses to create an image on a surface.

enum SWAP_CHAIN_USAGE_FLAGS: Uint32 { SWAP_CHAIN_USAGE_NONE = 0x00L, SWAP_CHAIN_USAGE_RENDER_TARGET = 0x01L, SWAP_CHAIN_USAGE_SHADER_INPUT = 0x02L, SWAP_CHAIN_USAGE_COPY_SOURCE = 0x04L, SWAP_CHAIN_USAGE_LAST = SWAP_CHAIN_USAGE_COPY_SOURCE }

Defines allowed swap chain usage flags.

enum SURFACE_TRANSFORM: Uint32 { SURFACE_TRANSFORM_OPTIMAL = 0, SURFACE_TRANSFORM_IDENTITY, SURFACE_TRANSFORM_ROTATE_90, SURFACE_TRANSFORM_ROTATE_180, SURFACE_TRANSFORM_ROTATE_270, SURFACE_TRANSFORM_HORIZONTAL_MIRROR, SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90, SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180, SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270 }

The transform applied to the image content prior to presentation.

enum QUERY_TYPE { QUERY_TYPE_UNDEFINED = 0, QUERY_TYPE_OCCLUSION, QUERY_TYPE_BINARY_OCCLUSION, QUERY_TYPE_TIMESTAMP, QUERY_TYPE_PIPELINE_STATISTICS, QUERY_TYPE_DURATION, QUERY_TYPE_NUM_TYPES }

Query type.

enum RENDER_DEVICE_TYPE { RENDER_DEVICE_TYPE_UNDEFINED = 0, RENDER_DEVICE_TYPE_D3D11, RENDER_DEVICE_TYPE_D3D12, RENDER_DEVICE_TYPE_GL, RENDER_DEVICE_TYPE_GLES, RENDER_DEVICE_TYPE_VULKAN, RENDER_DEVICE_TYPE_METAL }

Device type.

enum DEVICE_FEATURE_STATE: Uint8 { DEVICE_FEATURE_STATE_DISABLED = 0, DEVICE_FEATURE_STATE_ENABLED = 1, DEVICE_FEATURE_STATE_OPTIONAL = 2 }

Device feature state.

enum ADAPTER_VENDOR: Uint8 { ADAPTER_VENDOR_UNKNOWN = 0, ADAPTER_VENDOR_NVIDIA, ADAPTER_VENDOR_AMD, ADAPTER_VENDOR_INTEL, ADAPTER_VENDOR_ARM, ADAPTER_VENDOR_QUALCOMM, ADAPTER_VENDOR_IMGTECH, ADAPTER_VENDOR_MSFT }

Graphics adapter vendor.

enum WAVE_FEATURE: Uint32 { WAVE_FEATURE_UNKNOWN = 0x00, WAVE_FEATURE_BASIC = 0x01, WAVE_FEATURE_VOTE = 0x02, WAVE_FEATURE_ARITHMETIC = 0x04, WAVE_FEATURE_BALLOUT = 0x08, WAVE_FEATURE_SHUFFLE = 0x10, WAVE_FEATURE_SHUFFLE_RELATIVE = 0x20, WAVE_FEATURE_CLUSTERED = 0x40, WAVE_FEATURE_QUAD = 0x80, WAVE_FEATURE_LAST = WAVE_FEATURE_QUAD }

Describes the wave feature types. In Vulkan backend, you should check which features are supported by device. In Direct3D12 backend, all shader model 6.0 wave functions are supported if WaveOp feature is enabled. see doc/WaveOp.md.

enum D3D11_DEBUG_FLAGS: Uint32 { D3D11_DEBUG_FLAG_NONE = 0x00, D3D11_DEBUG_FLAG_CREATE_DEBUG_DEVICE = 0x01, D3D11_DEBUG_FLAG_VERIFY_COMMITTED_SHADER_RESOURCES = 0x02, D3D11_DEBUG_FLAG_VERIFY_COMMITTED_RESOURCE_RELEVANCE = 0x04 }

Debug flags that can be specified when creating Direct3D11-based engine implementation.

enum DIRECT3D_FEATURE_LEVEL: Uint8 { DIRECT3D_FEATURE_LEVEL_10_0, DIRECT3D_FEATURE_LEVEL_10_1, DIRECT3D_FEATURE_LEVEL_11_0, DIRECT3D_FEATURE_LEVEL_11_1, DIRECT3D_FEATURE_LEVEL_12_0, DIRECT3D_FEATURE_LEVEL_12_1 }

Direct3D11/12 feature level.

enum COMPONENT_TYPE: Uint8 { COMPONENT_TYPE_UNDEFINED, COMPONENT_TYPE_FLOAT, COMPONENT_TYPE_SNORM, COMPONENT_TYPE_UNORM, COMPONENT_TYPE_UNORM_SRGB, COMPONENT_TYPE_SINT, COMPONENT_TYPE_UINT, COMPONENT_TYPE_DEPTH, COMPONENT_TYPE_DEPTH_STENCIL, COMPONENT_TYPE_COMPOUND, COMPONENT_TYPE_COMPRESSED }

Describes texture format component type.

enum RESOURCE_DIMENSION_SUPPORT: Uint32 { RESOURCE_DIMENSION_SUPPORT_NONE = 0, RESOURCE_DIMENSION_SUPPORT_BUFFER = 1 << RESOURCE_DIM_BUFFER, RESOURCE_DIMENSION_SUPPORT_TEX_1D = 1 << RESOURCE_DIM_TEX_1D, RESOURCE_DIMENSION_SUPPORT_TEX_1D_ARRAY = 1 << RESOURCE_DIM_TEX_1D_ARRAY, RESOURCE_DIMENSION_SUPPORT_TEX_2D = 1 << RESOURCE_DIM_TEX_2D, RESOURCE_DIMENSION_SUPPORT_TEX_2D_ARRAY = 1 << RESOURCE_DIM_TEX_2D_ARRAY, RESOURCE_DIMENSION_SUPPORT_TEX_3D = 1 << RESOURCE_DIM_TEX_3D, RESOURCE_DIMENSION_SUPPORT_TEX_CUBE = 1 << RESOURCE_DIM_TEX_CUBE, RESOURCE_DIMENSION_SUPPORT_TEX_CUBE_ARRAY = 1 << RESOURCE_DIM_TEX_CUBE_ARRAY }

Describes device support of a particular resource dimension for a given texture format.

enum PIPELINE_STAGE_FLAGS: Uint32 { PIPELINE_STAGE_FLAG_UNDEFINED = 0x00000000, PIPELINE_STAGE_FLAG_TOP_OF_PIPE = 0x00000001, PIPELINE_STAGE_FLAG_DRAW_INDIRECT = 0x00000002, PIPELINE_STAGE_FLAG_VERTEX_INPUT = 0x00000004, PIPELINE_STAGE_FLAG_VERTEX_SHADER = 0x00000008, PIPELINE_STAGE_FLAG_HULL_SHADER = 0x00000010, PIPELINE_STAGE_FLAG_DOMAIN_SHADER = 0x00000020, PIPELINE_STAGE_FLAG_GEOMETRY_SHADER = 0x00000040, PIPELINE_STAGE_FLAG_PIXEL_SHADER = 0x00000080, PIPELINE_STAGE_FLAG_EARLY_FRAGMENT_TESTS = 0x00000100, PIPELINE_STAGE_FLAG_LATE_FRAGMENT_TESTS = 0x00000200, PIPELINE_STAGE_FLAG_RENDER_TARGET = 0x00000400, PIPELINE_STAGE_FLAG_COMPUTE_SHADER = 0x00000800, PIPELINE_STAGE_FLAG_TRANSFER = 0x00001000, PIPELINE_STAGE_FLAG_BOTTOM_OF_PIPE = 0x00002000, PIPELINE_STAGE_FLAG_HOST = 0x00004000, PIPELINE_STAGE_FLAG_CONDITIONAL_RENDERING = 0x00040000, PIPELINE_STAGE_FLAG_SHADING_RATE_TEXTURE = 0x00400000, PIPELINE_STAGE_FLAG_RAY_TRACING_SHADER = 0x00200000, PIPELINE_STAGE_FLAG_ACCELERATION_STRUCTURE_BUILD = 0x02000000, PIPELINE_STAGE_FLAG_TASK_SHADER = 0x00080000, PIPELINE_STAGE_FLAG_MESH_SHADER = 0x00100000, PIPELINE_STAGE_FLAG_FRAGMENT_DENSITY_PROCESS = 0x00800000, PIPELINE_STAGE_FLAG_DEFAULT = 0x80000000 }

Pipeline stage flags.

enum ACCESS_FLAGS: Uint32 { ACCESS_FLAG_NONE = 0x00000000, ACCESS_FLAG_INDIRECT_COMMAND_READ = 0x00000001, ACCESS_FLAG_INDEX_READ = 0x00000002, ACCESS_FLAG_VERTEX_READ = 0x00000004, ACCESS_FLAG_UNIFORM_READ = 0x00000008, ACCESS_FLAG_INPUT_ATTACHMENT_READ = 0x00000010, ACCESS_FLAG_SHADER_READ = 0x00000020, ACCESS_FLAG_SHADER_WRITE = 0x00000040, ACCESS_FLAG_RENDER_TARGET_READ = 0x00000080, ACCESS_FLAG_RENDER_TARGET_WRITE = 0x00000100, ACCESS_FLAG_DEPTH_STENCIL_READ = 0x00000200, ACCESS_FLAG_DEPTH_STENCIL_WRITE = 0x00000400, ACCESS_FLAG_COPY_SRC = 0x00000800, ACCESS_FLAG_COPY_DST = 0x00001000, ACCESS_FLAG_HOST_READ = 0x00002000, ACCESS_FLAG_HOST_WRITE = 0x00004000, ACCESS_FLAG_MEMORY_READ = 0x00008000, ACCESS_FLAG_MEMORY_WRITE = 0x00010000, ACCESS_FLAG_CONDITIONAL_RENDERING_READ = 0x00100000, ACCESS_FLAG_SHADING_RATE_TEXTURE_READ = 0x00800000, ACCESS_FLAG_ACCELERATION_STRUCTURE_READ = 0x00200000, ACCESS_FLAG_ACCELERATION_STRUCTURE_WRITE = 0x00400000, ACCESS_FLAG_FRAGMENT_DENSITY_MAP_READ = 0x01000000, ACCESS_FLAG_DEFAULT = 0x80000000 }

Access flag.

enum RESOURCE_STATE: Uint32 { RESOURCE_STATE_UNKNOWN = 0x00000, RESOURCE_STATE_UNDEFINED = 0x00001, RESOURCE_STATE_VERTEX_BUFFER = 0x00002, RESOURCE_STATE_CONSTANT_BUFFER = 0x00004, RESOURCE_STATE_INDEX_BUFFER = 0x00008, RESOURCE_STATE_RENDER_TARGET = 0x00010, RESOURCE_STATE_UNORDERED_ACCESS = 0x00020, RESOURCE_STATE_DEPTH_WRITE = 0x00040, RESOURCE_STATE_DEPTH_READ = 0x00080, RESOURCE_STATE_SHADER_RESOURCE = 0x00100, RESOURCE_STATE_STREAM_OUT = 0x00200, RESOURCE_STATE_INDIRECT_ARGUMENT = 0x00400, RESOURCE_STATE_COPY_DEST = 0x00800, RESOURCE_STATE_COPY_SOURCE = 0x01000, RESOURCE_STATE_RESOLVE_DEST = 0x02000, RESOURCE_STATE_RESOLVE_SOURCE = 0x04000, RESOURCE_STATE_INPUT_ATTACHMENT = 0x08000, RESOURCE_STATE_PRESENT = 0x10000, RESOURCE_STATE_BUILD_AS_READ = 0x20000, RESOURCE_STATE_BUILD_AS_WRITE = 0x40000, RESOURCE_STATE_RAY_TRACING = 0x80000, RESOURCE_STATE_MAX_BIT = RESOURCE_STATE_RAY_TRACING, RESOURCE_STATE_GENERIC_READ = RESOURCE_STATE_VERTEX_BUFFER | RESOURCE_STATE_CONSTANT_BUFFER | RESOURCE_STATE_INDEX_BUFFER | RESOURCE_STATE_SHADER_RESOURCE | RESOURCE_STATE_INDIRECT_ARGUMENT | RESOURCE_STATE_COPY_SOURCE }

Resource usage state.

enum STATE_TRANSITION_TYPE: Uint8 { STATE_TRANSITION_TYPE_IMMEDIATE = 0, STATE_TRANSITION_TYPE_BEGIN, STATE_TRANSITION_TYPE_END }

State transition barrier type.

enum INPUT_ELEMENT_FREQUENCY { INPUT_ELEMENT_FREQUENCY_UNDEFINED = 0, INPUT_ELEMENT_FREQUENCY_PER_VERTEX, INPUT_ELEMENT_FREQUENCY_PER_INSTANCE, INPUT_ELEMENT_FREQUENCY_NUM_FREQUENCIES }

Input frequency.

enum PIPELINE_RESOURCE_FLAGS: Uint8 { PIPELINE_RESOURCE_FLAG_UNKNOWN = 0x00, PIPELINE_RESOURCE_FLAG_NO_DYNAMIC_BUFFERS = 0x01, PIPELINE_RESOURCE_FLAG_COMBINED_SAMPLER = 0x02, PIPELINE_RESOURCE_FLAG_FORMATTED_BUFFER = 0x04, PIPELINE_RESOURCE_FLAG_RUNTIME_ARRAY = 0x08, PIPELINE_RESOURCE_FLAG_LAST = PIPELINE_RESOURCE_FLAG_RUNTIME_ARRAY }

Flags that define pipeline resource properties.

enum PIPELINE_TYPE: Uint8 { PIPELINE_TYPE_GRAPHICS, PIPELINE_TYPE_COMPUTE, PIPELINE_TYPE_MESH, PIPELINE_TYPE_RAY_TRACING, PIPELINE_TYPE_LAST = PIPELINE_TYPE_RAY_TRACING, PIPELINE_TYPE_INVALID = 0xFF }

Pipeline type.

enum PSO_CREATE_FLAGS: Uint32 { PSO_CREATE_FLAG_NONE = 0x00, PSO_CREATE_FLAG_IGNORE_MISSING_VARIABLES = 0x01, PSO_CREATE_FLAG_IGNORE_MISSING_IMMUTABLE_SAMPLERS = 0x02 }

Pipeline state creation flags.

enum FILL_MODE: Int8 { FILL_MODE_UNDEFINED = 0, FILL_MODE_WIREFRAME, FILL_MODE_SOLID, FILL_MODE_NUM_MODES }

Fill mode.

enum CULL_MODE: Int8 { CULL_MODE_UNDEFINED = 0, CULL_MODE_NONE, CULL_MODE_FRONT, CULL_MODE_BACK, CULL_MODE_NUM_MODES }

Cull mode.

enum ATTACHMENT_LOAD_OP: Uint8 { ATTACHMENT_LOAD_OP_LOAD = 0, ATTACHMENT_LOAD_OP_CLEAR, ATTACHMENT_LOAD_OP_DISCARD }

Render pass attachment load operation Vulkan counterpart: VkAttachmentLoadOp. D3D12 counterpart: D3D12_RENDER_PASS_BEGINNING_ACCESS_TYPE.

enum ATTACHMENT_STORE_OP: Uint8 { ATTACHMENT_STORE_OP_STORE = 0, ATTACHMENT_STORE_OP_DISCARD }

Render pass attachment store operation Vulkan counterpart: VkAttachmentStoreOp. D3D12 counterpart: D3D12_RENDER_PASS_ENDING_ACCESS_TYPE.

enum SHADER_SOURCE_LANGUAGE: Uint32 { SHADER_SOURCE_LANGUAGE_DEFAULT = 0, SHADER_SOURCE_LANGUAGE_HLSL, SHADER_SOURCE_LANGUAGE_GLSL, SHADER_SOURCE_LANGUAGE_MSL, SHADER_SOURCE_LANGUAGE_GLSL_VERBATIM }

Describes the shader source code language.

enum SHADER_COMPILER: Uint32 { SHADER_COMPILER_DEFAULT = 0, SHADER_COMPILER_GLSLANG, SHADER_COMPILER_DXC, SHADER_COMPILER_FXC, SHADER_COMPILER_LAST = SHADER_COMPILER_FXC }

Describes the shader compiler that will be used to compile the shader source code.

enum CREATE_SHADER_SOURCE_INPUT_STREAM_FLAGS: Uint32 { CREATE_SHADER_SOURCE_INPUT_STREAM_FLAG_NONE = 0x00, CREATE_SHADER_SOURCE_INPUT_STREAM_FLAG_SILENT = 0x01 }

Describes the flags that can be passed over to IShaderSourceInputStreamFactory::CreateInputStream2() function.

enum SHADER_COMPILE_FLAGS: Uint32 { SHADER_COMPILE_FLAG_NONE = 0x0, SHADER_COMPILE_FLAG_ENABLE_UNBOUNDED_ARRAYS = 0x01, SHADER_COMPILE_FLAG_LAST = SHADER_COMPILE_FLAG_ENABLE_UNBOUNDED_ARRAYS }

Shader compilation flags.

enum SHADER_RESOURCE_TYPE: Uint8 { SHADER_RESOURCE_TYPE_UNKNOWN = 0, SHADER_RESOURCE_TYPE_CONSTANT_BUFFER, SHADER_RESOURCE_TYPE_TEXTURE_SRV, SHADER_RESOURCE_TYPE_BUFFER_SRV, SHADER_RESOURCE_TYPE_TEXTURE_UAV, SHADER_RESOURCE_TYPE_BUFFER_UAV, SHADER_RESOURCE_TYPE_SAMPLER, SHADER_RESOURCE_TYPE_INPUT_ATTACHMENT, SHADER_RESOURCE_TYPE_ACCEL_STRUCT, SHADER_RESOURCE_TYPE_LAST = SHADER_RESOURCE_TYPE_ACCEL_STRUCT }

Describes shader resource type.

enum VERIFY_SBT_FLAGS: Uint32 { VERIFY_SBT_FLAG_SHADER_ONLY = 0x1, VERIFY_SBT_FLAG_SHADER_RECORD = 0x2, VERIFY_SBT_FLAG_TLAS = 0x4, VERIFY_SBT_FLAG_ALL = VERIFY_SBT_FLAG_SHADER_ONLY | VERIFY_SBT_FLAG_SHADER_RECORD | VERIFY_SBT_FLAG_TLAS }

Defines shader binding table validation flags, see IShaderBindingTable::Verify().

enum SHADER_RESOURCE_VARIABLE_TYPE: Uint8 { SHADER_RESOURCE_VARIABLE_TYPE_STATIC = 0, SHADER_RESOURCE_VARIABLE_TYPE_MUTABLE, SHADER_RESOURCE_VARIABLE_TYPE_DYNAMIC, SHADER_RESOURCE_VARIABLE_TYPE_NUM_TYPES }

Describes the type of the shader resource variable.

enum BIND_SHADER_RESOURCES_FLAGS: Uint32 { BIND_SHADER_RESOURCES_UPDATE_STATIC = (0x01 << SHADER_RESOURCE_VARIABLE_TYPE_STATIC), BIND_SHADER_RESOURCES_UPDATE_MUTABLE = (0x01 << SHADER_RESOURCE_VARIABLE_TYPE_MUTABLE), BIND_SHADER_RESOURCES_UPDATE_DYNAMIC = (0x01 << SHADER_RESOURCE_VARIABLE_TYPE_DYNAMIC), BIND_SHADER_RESOURCES_UPDATE_ALL = (BIND_SHADER_RESOURCES_UPDATE_STATIC | BIND_SHADER_RESOURCES_UPDATE_MUTABLE | BIND_SHADER_RESOURCES_UPDATE_DYNAMIC), BIND_SHADER_RESOURCES_KEEP_EXISTING = 0x08, BIND_SHADER_RESOURCES_VERIFY_ALL_RESOLVED = 0x10 }

Shader resource binding flags.

enum UAV_ACCESS_FLAG: Uint8 { UAV_ACCESS_UNSPECIFIED = 0x00, UAV_ACCESS_FLAG_READ = 0x01, UAV_ACCESS_FLAG_WRITE = 0x02, UAV_ACCESS_FLAG_READ_WRITE = UAV_ACCESS_FLAG_READ | UAV_ACCESS_FLAG_WRITE }

Describes allowed unordered access view mode.

enum TEXTURE_VIEW_FLAGS: Uint8 { TEXTURE_VIEW_FLAG_NONE = 0x00, TEXTURE_VIEW_FLAG_ALLOW_MIP_MAP_GENERATION = 0x01 }

Texture view flags.

enum HIT_GROUP_BINDING_MODE: Uint8 { HIT_GROUP_BINDING_MODE_PER_GEOMETRY = 0, HIT_GROUP_BINDING_MODE_PER_INSTANCE, HIT_GROUP_BINDING_MODE_PER_TLAS, HIT_GROUP_BINDING_MODE_USER_DEFINED, HIT_GROUP_BINDING_MODE_LAST = HIT_GROUP_BINDING_MODE_USER_DEFINED }

Defines hit group binding mode used by the top-level AS.

enum DEBUG_MESSAGE_SEVERITY { DEBUG_MESSAGE_SEVERITY_INFO = 0, DEBUG_MESSAGE_SEVERITY_WARNING, DEBUG_MESSAGE_SEVERITY_ERROR, DEBUG_MESSAGE_SEVERITY_FATAL_ERROR }

Describes debug message severity.

Typedefs

using D3D11ShaderResourceCounters = std::array<D3D11ResourceRangeCounters, D3D11_RESOURCE_RANGE_COUNT>

Resource counters for all shader stages and all resource types.

using Float32 = float

32-bit float

using Int64 = int64_t

64-bit signed integer

using Int32 = int32_t

32-bit signed integer

using Int16 = int16_t

16-bit signed integer

using Int8 = int8_t

8-bit signed integer

using Uint64 = uint64_t

64-bit unsigned integer

using Uint32 = uint32_t

32-bit unsigned integer

using Uint16 = uint16_t

16-bit unsigned integer

using Uint8 = uint8_t

8-bit unsigned integer

using Bool = bool

Boolean.

using String = std::basic_string<Char>

String variable.

using DebugMessageCallbackType = void(*)(enum DEBUG_MESSAGE_SEVERITY Severity, const Char*Message, const Char*Function, const Char*File, int Line)

Type of the debug messag callback function.

Functions

auto GetBoxNearestCorner(const float3& Direction, const BoundBox& Box) -> float3

Returns the nearest bounding box corner along the given direction.

auto GetBoxFarthestCorner(const float3& Direction, const BoundBox& Box) -> float3

Returns the farthest bounding box corner along the given direction.

auto IntersectRayBox3D(const float3& RayOrigin, const float3& RayDirection, float3 BoxMin, float3 BoxMax, float& EnterDist, float& ExitDist) -> bool

Intersects a ray with 3D box and computes distances to intersections.

auto IntersectRayAABB(const float3& RayOrigin, const float3& RayDirection, const BoundBox& AABB, float& EnterDist, float& ExitDist) -> bool

Intersects a ray with the axis-aligned bounding box and computes distances to intersections.

auto IntersectRayBox2D(const float2& RayOrigin, const float2& RayDirection, float2 BoxMin, float2 BoxMax, float& EnterDist, float& ExitDist) -> bool

Intersects a 2D ray with the 2D axis-aligned bounding box and computes distances to intersections.

auto IntersectRayTriangle(const float3& V0, const float3& V1, const float3& V2, const float3& RayOrigin, const float3& RayDirection, bool CullBackFace = false) -> float

Intersects a ray with the trianlge using Moller-Trumbore algorithm and returns the distance along the ray to the intesrsection point. If the intersection point is behind the ray origin, the distance will be negative. If there is no intersection, returns +FLT_MAX.

template<typename TCallback>

void TraceLineThroughGrid(float2 f2Start, float2 f2End, int2 i2GridSize, TCallback Callback)

Traces a 2D line through the square cell grid and enumerates all cells the line touches.

template<typename T, typename IntermediateType>

auto IsPointInsideTriangle(const Vector2<T>& V0, const Vector2<T>& V1, const Vector2<T>& V2, const Vector2<T>& Point, bool AllowEdges) -> bool

Tests if a point is inside triangle.

template<typename T, class TCallback>

void RasterizeTriangle(Vector2<T> V0, Vector2<T> V1, Vector2<T> V2, TCallback Callback)

Rasterizes a triangle and calls the callback function for every sample covered.

template<bool AllowTouch, typename T>

auto CheckBox2DBox2DOverlap(const Vector2<T>& Box0Min, const Vector2<T>& Box0Max, const Vector2<T>& Box1Min, const Vector2<T>& Box1Max) -> bool

Checks if two 2D-boxes overlap.

template<typename T>

auto ExtractLSB(T& bits) -> std::enable_if<std::is_integral<T>::value, T>::type

Returns the least-signficant bit and clears it in the input argument.

template<typename T>

auto ExtractLSB(T& bits) -> std::enable_if<std::is_enum<T>::value, T>::type

Returns the enum value representing the least-signficant bit and clears it in the input argument.

template<TEXTURE_ADDRESS_MODE AddressMode, bool IsNormalizedCoord>

auto GetLinearTexFilterSampleInfo(Uint32 Width, float u) -> LinearTexFilterSampleInfo

Returns linear texture filter sample info, see Diligent::LinearTexFilterSampleInfo.

template<typename SrcType, typename DstType, TEXTURE_ADDRESS_MODE AddressModeU, TEXTURE_ADDRESS_MODE AddressModeV, bool IsNormalizedCoord>

auto FilterTexture2DBilinear(Uint32 Width, Uint32 Height, const SrcType* pData, size_t Stride, float u, float v) -> DstType

Samples 2D texture using bilinear filter.

template<typename SrcType, typename DstType>

auto FilterTexture2DBilinearClamp(Uint32 Width, Uint32 Height, const SrcType* pData, size_t Stride, float u, float v) -> DstType

Specialization of FilterTexture2DBilinear function that uses CLAMP texture address mode and takes normalized texture coordinates.

template<typename SrcType, typename DstType>

auto FilterTexture2DBilinearClampUC(Uint32 Width, Uint32 Height, const SrcType* pData, size_t Stride, float u, float v) -> DstType

Specialization of FilterTexture2DBilinear function that uses CLAMP texture address mode and takes unnormalized texture coordinates.

auto GetRawAllocator() -> IMemoryAllocator&

Returns raw memory allocator.

auto CountFloatNumberChars(const char* str) -> size_t

Returns the number of chararcters at the beginning of the string that form a floating point number.

auto GetValueSize(VALUE_TYPE Val) -> Uint32

Returns the size of the specified value type.

auto GetValueTypeString(VALUE_TYPE Val) -> const Char*

Returns the string representing the specified value type.

auto GetTextureFormatAttribs(TEXTURE_FORMAT Format) -> const TextureFormatAttribs&

Returns invariant texture format attributes, see TextureFormatAttribs for details.

auto GetDefaultTextureViewFormat(TEXTURE_FORMAT TextureFormat, TEXTURE_VIEW_TYPE ViewType, Uint32 BindFlags) -> TEXTURE_FORMAT

Returns the default format for a specified texture view type.

auto GetDefaultTextureViewFormat(const TextureDesc& TexDesc, TEXTURE_VIEW_TYPE ViewType) -> TEXTURE_FORMAT

Returns the default format for a specified texture view type.

auto GetTexViewTypeLiteralName(TEXTURE_VIEW_TYPE ViewType) -> const Char*

Returns the literal name of a texture view type. For instance, for a shader resource view, "TEXTURE_VIEW_SHADER_RESOURCE" will be returned.

auto GetBufferViewTypeLiteralName(BUFFER_VIEW_TYPE ViewType) -> const Char*

Returns the literal name of a buffer view type. For instance, for an unordered access view, "BUFFER_VIEW_UNORDERED_ACCESS" will be returned.

auto GetShaderTypeLiteralName(SHADER_TYPE ShaderType) -> const Char*

Returns the literal name of a shader type. For instance, for a pixel shader, "SHADER_TYPE_PIXEL" will be returned.

auto GetShaderStagesString(SHADER_TYPE ShaderStages) -> String

auto GetShaderVariableTypeLiteralName(SHADER_RESOURCE_VARIABLE_TYPE VarType, bool bGetFullName = false) -> const Char*

Returns the literal name of a shader variable type. For instance, for SHADER_RESOURCE_VARIABLE_TYPE_STATIC, if bGetFullName == true, "SHADER_RESOURCE_VARIABLE_TYPE_STATIC" will be returned; if bGetFullName == false, "static" will be returned.

auto GetShaderResourceTypeLiteralName(SHADER_RESOURCE_TYPE ResourceType, bool bGetFullName = false) -> const Char*

Returns the literal name of a shader resource type. For instance, for SHADER_RESOURCE_TYPE_CONSTANT_BUFFER, if bGetFullName == true, "SHADER_RESOURCE_TYPE_CONSTANT_BUFFER" will be returned; if bGetFullName == false, "constant buffer" will be returned.

auto GetViewTypeLiteralName(TEXTURE_VIEW_TYPE TexViewType) -> const Char*

Overloaded function that returns the literal name of a texture view type. see GetTexViewTypeLiteralName().

auto GetViewTypeLiteralName(BUFFER_VIEW_TYPE BuffViewType) -> const Char*

Overloaded function that returns the literal name of a buffer view type. see GetBufferViewTypeLiteralName().

auto GetFilterTypeLiteralName(FILTER_TYPE FilterType, bool bGetFullName) -> const Char*

Returns the literal name of a filter type. For instance, for FILTER_TYPE_POINT, if bGetFullName == true, "FILTER_TYPE_POINT" will be returned; if bGetFullName == false, "point" will be returned.

auto GetTextureAddressModeLiteralName(TEXTURE_ADDRESS_MODE AddressMode, bool bGetFullName) -> const Char*

Returns the literal name of a texture address mode. For instance, for TEXTURE_ADDRESS_WRAP, if bGetFullName == true, "TEXTURE_ADDRESS_WRAP" will be returned; if bGetFullName == false, "wrap" will be returned.

auto GetComparisonFunctionLiteralName(COMPARISON_FUNCTION ComparisonFunc, bool bGetFullName) -> const Char*

Returns the literal name of a comparison function. For instance, for COMPARISON_FUNC_LESS, if bGetFullName == true, "COMPARISON_FUNC_LESS" will be returned; if bGetFullName == false, "less" will be returned.

auto GetStencilOpLiteralName(STENCIL_OP StencilOp) -> const Char*

Returns the literal name of a stencil operation.

auto GetBlendFactorLiteralName(BLEND_FACTOR BlendFactor) -> const Char*

Returns the literal name of a blend factor.

auto GetBlendOperationLiteralName(BLEND_OPERATION BlendOp) -> const Char*

Returns the literal name of a blend operation.

auto GetFillModeLiteralName(FILL_MODE FillMode) -> const Char*

Returns the literal name of a fill mode.

auto GetCullModeLiteralName(CULL_MODE CullMode) -> const Char*

Returns the literal name of a cull mode.

auto GetMapTypeString(MAP_TYPE MapType) -> const Char*

Returns the string containing the map type.

auto GetUsageString(USAGE Usage) -> const Char*

Returns the string containing the usage.

auto GetResourceDimString(RESOURCE_DIMENSION TexType) -> const Char*

Returns the string containing the texture type.

auto GetBindFlagString(Uint32 BindFlag) -> const Char*

Returns the string containing single bind flag.

auto GetBindFlagsString(Uint32 BindFlags, const char* Delimeter = "|") -> String

Returns the string containing the bind flags.

auto GetCPUAccessFlagsString(Uint32 CpuAccessFlags) -> String

Returns the string containing the CPU access flags.

auto GetTextureDescString(const TextureDesc& Desc) -> String

Returns the string containing the texture description.

auto GetBufferFormatString(const BufferFormat& Fmt) -> String

Returns the string containing the buffer format description.

auto GetBufferModeString(BUFFER_MODE Mode) -> const Char*

Returns the string containing the buffer mode description.

auto GetBufferDescString(const BufferDesc& Desc) -> String

Returns the string containing the buffer description.

auto GetResourceStateFlagString(RESOURCE_STATE State) -> const Char*

Returns the string containing the buffer mode description.

template<typename TObjectDescType>

auto GetObjectDescString(const TObjectDescType&) -> String

Helper template function that converts object description into a string.

template<>

auto GetObjectDescString(const TextureDesc& TexDesc) -> String

Template specialization for texture description.

template<>

auto GetObjectDescString(const BufferDesc& BuffDesc) -> String

Template specialization for buffer description.

auto GetStagingTextureLocationOffset(const TextureDesc& TexDesc, Uint32 ArraySlice, Uint32 MipLevel, Uint32 Alignment, Uint32 LocationX, Uint32 LocationY, Uint32 LocationZ) -> Uint32

Returns an offset from the beginning of the buffer backing a staging texture to the specified location within the given subresource.

auto GetStagingTextureSubresourceOffset(const TextureDesc& TexDesc, Uint32 ArraySlice, Uint32 MipLevel, Uint32 Alignment) -> Uint32

Returns an offset from the beginning of the buffer backing a staging texture to the given subresource. Texels within subresources are assumed to be tightly packed. There is no padding except between whole subresources.

void CopyTextureSubresource(const TextureSubResData& SrcSubres, Uint32 NumRows, Uint32 NumDepthSlices, Uint32 RowSize, void* pDstData, Uint32 DstRowStride, Uint32 DstDepthStride)

Copies texture subresource data on the CPU.

void ValidateBottomLevelASDesc(const BottomLevelASDesc& Desc) noexcept(…)

Validates bottom-level AS description and throws an exception in case of an error.

void CopyBLASGeometryDesc(const BottomLevelASDesc& SrcDesc, BottomLevelASDesc& DstDesc, FixedLinearAllocator& MemPool, const BLASNameToIndex* pSrcNameToIndex, BLASNameToIndex& DstNameToIndex) noexcept(…)

Copies bottom-level AS geometry description using MemPool to allocate required space.

void ValidateBufferDesc(const BufferDesc& Desc, const DeviceCaps& deviceCaps) noexcept(…)

Validates buffer description and throws an exception in case of an error.

void ValidateBufferInitData(const BufferDesc& Desc, const BufferData* pBuffData) noexcept(…)

Validates initial buffer data parameters and throws an exception in case of an error.

void ValidateAndCorrectBufferViewDesc(const BufferDesc& BuffDesc, BufferViewDesc& ViewDesc) noexcept(…)

Validates and corrects buffer view description; throws an exception in case of an error.

void CreateDefaultShaderSourceStreamFactory(const Char* SearchDirectories, IShaderSourceInputStreamFactory** ppShaderSourceStreamFactory)

Creates a default shader source stream factory.

void SetRawAllocator(IMemoryAllocator* pRawAllocator)

Sets raw memory allocator. This function must be called before any memory allocation/deallocation function is called.

void ValidatePipelineResourceSignatureDesc(const PipelineResourceSignatureDesc& Desc, const DeviceFeatures& Features) noexcept(…)

Validates pipeline resource signature description and throws an exception in case of an error.

auto FindImmutableSampler(const ImmutableSamplerDesc* ImtblSamplers, Uint32 NumImtblSamplers, SHADER_TYPE ShaderStages, const char* ResourceName, const char* SamplerSuffix) -> Uint32

Finds an immutable sampler for the resource name 'ResourceName' that is defined in shader stages 'ShaderStages'. If 'SamplerSuffix' is not null, it will be appended to the 'ResourceName'. Returns an index of the sampler in ImtblSamplers array, or InvalidImmutableSamplerIndex if there is no suitable sampler.

auto PipelineResourceSignaturesCompatible(const PipelineResourceSignatureDesc& Desc0, const PipelineResourceSignatureDesc& Desc1) -> bool noexcept

Returns true if two pipeline resource signature descriptions are compatible, and false otherwise.

auto CalculatePipelineResourceSignatureDescHash(const PipelineResourceSignatureDesc& Desc) -> size_t noexcept

Calculates hash of the pipeline resource signature description.

void ValidatePipelineResourceCompatibility(const PipelineResourceDesc& ResDesc, SHADER_RESOURCE_TYPE Type, PIPELINE_RESOURCE_FLAGS ResourceFlags, Uint32 ArraySize, const char* ShaderName, const char* SignatureName) noexcept(…)

Validates that pipeline resource description 'ResDesc' is compatible with the actual resource attributes and throws an exception in case of an error.

void CopyRTShaderGroupNames(std::unordered_map<HashMapStringKey, Uint32, HashMapStringKey::Hasher>& NameToGroupIndex, const RayTracingPipelineStateCreateInfo& CreateInfo, FixedLinearAllocator& MemPool) noexcept

Copies ray tracing shader group names and also initializes the mapping from the group name to its index.

auto FindPipelineResourceLayoutVariable(const PipelineResourceLayoutDesc& LayoutDesc, const char* Name, SHADER_TYPE ShaderStage, const char* CombinedSamplerSuffix) -> Uint32

Finds a pipeline resource layout variable with the name 'Name' in shader stage 'ShaderStage' in the list of variables of 'LayoutDesc'. If CombinedSamplerSuffix != null, the variable is treated as a combined sampler and the suffix is added to the names of variables from 'LayoutDesc' when comparing with 'Name'. If the variable is found, returns its index in LayoutDesc.Variables. Otherwise returns InvalidPipelineResourceLayoutVariableIndex.

void ValidateShaderBindingTableDesc(const ShaderBindingTableDesc& Desc, Uint32 ShaderGroupHandleSize, Uint32 MaxShaderRecordStride) noexcept(…)

Validates SBT description and throws an exception in case of an error.

void ValidateTextureDesc(const TextureDesc& TexDesc) noexcept(…)

Validates texture description and throws an exception in case of an error.

void ValidatedAndCorrectTextureViewDesc(const TextureDesc& TexDesc, TextureViewDesc& ViewDesc) noexcept(…)

Validates and corrects texture view description; throws an exception in case of an error.

void ValidateUpdateTextureParams(const TextureDesc& TexDesc, Uint32 MipLevel, Uint32 Slice, const Box& DstBox, const TextureSubResData& SubresData)

Validates update texture command paramters.

void ValidateCopyTextureParams(const CopyTextureAttribs& CopyAttribs)

Validates copy texture command paramters.

void ValidateMapTextureParams(const TextureDesc& TexDesc, Uint32 MipLevel, Uint32 ArraySlice, MAP_TYPE MapType, Uint32 MapFlags, const Box* pMapRegion)

Validates map texture command paramters.

void ValidateTopLevelASDesc(const TopLevelASDesc& Desc) noexcept(…)

Validates top-level AS description and throws an exception in case of an error.

auto PipelineResourcesCompatible(const PipelineResourceDesc& lhs, const PipelineResourceDesc& rhs) -> bool

Returns true if two pipeline resources are compatible.

void VerifyD3DResourceMerge(const PipelineStateDesc& PSODesc, const D3DShaderResourceAttribs& ExistingRes, const D3DShaderResourceAttribs& NewResAttribs) noexcept(…)

Verifies that two pipeline resources are compatible and throws an exception in case of an error.

void CreateBufferSuballocator(IRenderDevice* pDevice, const BufferSuballocatorCreateInfo& CreateInfo, IBufferSuballocator** ppBufferSuballocator)

Creates a new buffer suballocator.

void CreateDynamicTextureAtlas(IRenderDevice* pDevice, const DynamicTextureAtlasCreateInfo& CreateInfo, IDynamicTextureAtlas** ppAtlas)

Creates a new dynamic texture atlas.

auto GetShaderTypeMacros(SHADER_TYPE Type) -> const ShaderMacro*

Returns shader type definition macro(s), e.g., for a vertex shader:

void AppendShaderMacros(std::string& Source, const ShaderMacro* Macros)

Appends shader macro definitions to the end of the source string:

void AppendShaderTypeDefinitions(std::string& Source, SHADER_TYPE Type)

Appends the shader type definition macro(s), e.g., for a vertex shader:

auto ReadShaderSourceFile(const char* SourceCode, IShaderSourceInputStreamFactory* pShaderSourceStreamFactory, const char* FilePath, RefCntAutoPtr<IDataBlob>& pFileData, size_t& SourceCodeLen) -> const char* noexcept(…)

Reads shader source code from a file or uses the one from the shader create info.

void AppendShaderSourceCode(std::string& Source, const ShaderCreateInfo& ShaderCI) noexcept(…)

Appends shader source code to the source string.

void SetDebugMessageCallback(DebugMessageCallbackType DbgMessageCallback)

Sets the debug message callback function.

Variables

static Uint32 MAX_SHADERS_IN_PIPELINE constexpr

The maximum number of shader stages in a pipeline. (Vertex, Hull, Domain, Geometry, Pixel) or (Amplification, Mesh, Pixel), or (Compute) or (RayGen, Miss, ClosestHit, AnyHit, Intersection, Callable)

static const Uint32 TLAS_INSTANCE_OFFSET_AUTO

Can be used to calculate the TLASBuildInstanceData::ContributionToHitGroupIndex depending on instance count, geometry count in each instance (in TLASBuildInstanceData::pBLAS) and shader binding mode in BuildTLASAttribs::BindingMode.

static const Uint32 TLAS_INSTANCE_DATA_SIZE

Top-level AS instance size in bytes in GPU side. Used to calculate size of BuildTLASAttribs::pInstanceBuffer.

static const struct INTERFACE_ID IID_FileStream

IFileStream interface unique identifier.

static const INTERFACE_ID IID_Unknown

Unknown interface.

Enum documentation