Kanzi 4.0.0-beta2
kanzi::gfx::DebugInformation Class Referenceabstract

Interface to access Kanzi graphics debug information, such as object names. More...

#include <kanzi/gfx/validation.hpp>

Public Member Functions

virtual string getName (const BlendStateHandleGuard &handle) const =0
 Gets The name of a blend state graphics object as specified in the creation information.
 
virtual string getName (const BufferHandleGuard &handle) const =0
 Gets The name of a buffer graphics object as specified in the creation information.
 
virtual string getName (const CommandBufferHandleGuard &handle) const =0
 Gets The name of a command buffer graphics object as specified in the creation information.
 
virtual string getName (const ComputePipelineHandleGuard &handle) const =0
 Gets The name of a compute pipeline graphics object as specified in the creation information.
 
virtual string getName (const ComputeResourceSetHandleGuard &handle) const =0
 Gets The name of a compute resource set graphics object as specified in the creation information.
 
virtual string getName (const DepthStencilStateHandleGuard &handle) const =0
 Gets The name of a depth stencil state graphics object as specified in the creation information.
 
virtual string getName (const FrameBufferHandleGuard &handle) const =0
 Gets The name of a frame buffer graphics object as specified in the creation information.
 
virtual string getName (const GpuFenceHandleGuard &handle) const =0
 Gets The name of a GPU fence graphics object as specified in the creation information.
 
virtual string getName (const ImageHandleGuard &handle) const =0
 Gets The name of a image graphics object as specified in the creation information.
 
virtual string getName (const RasterStateHandleGuard &handle) const =0
 Gets The name of a raster state graphics object as specified in the creation information.
 
virtual string getName (const RenderPassHandleGuard &handle) const =0
 Gets The name of a render pass graphics object as specified in the creation information.
 
virtual string getName (const RenderPipelineHandleGuard &handle) const =0
 Gets The name of a render pipeline graphics object as specified in the creation information.
 
virtual string getName (const RenderResourceSetHandleGuard &handle) const =0
 Gets The name of a render resource set graphics object as specified in the creation information.
 
virtual string getName (const SamplerHandleGuard &handle) const =0
 Gets The name of a sampler graphics object as specified in the creation information.
 
virtual string getName (const ShaderHandleGuard &handle) const =0
 Gets The name of a shader graphics object as specified in the creation information.
 
virtual string getName (const VertexInputStateHandleGuard &handle) const =0
 Gets The name of a vertex input state graphics object as specified in the creation information.
 

Detailed Description

Interface to access Kanzi graphics debug information, such as object names.

Since
Kanzi 4.0.0

Member Function Documentation

◆ getName() [1/16]

virtual string kanzi::gfx::DebugInformation::getName ( const BufferHandleGuard & handle) const
pure virtual

Gets The name of a buffer graphics object as specified in the creation information.

Parameters
handleThe buffer graphics object handle.
Returns
The buffer graphics object name.

◆ getName() [2/16]

virtual string kanzi::gfx::DebugInformation::getName ( const ImageHandleGuard & handle) const
pure virtual

Gets The name of a image graphics object as specified in the creation information.

Parameters
handleThe image graphics object handle.
Returns
The image graphics object name.

◆ getName() [3/16]

virtual string kanzi::gfx::DebugInformation::getName ( const FrameBufferHandleGuard & handle) const
pure virtual

Gets The name of a frame buffer graphics object as specified in the creation information.

Parameters
handleThe frame buffer graphics object handle.
Returns
The frame buffer graphics object name.

◆ getName() [4/16]

virtual string kanzi::gfx::DebugInformation::getName ( const VertexInputStateHandleGuard & handle) const
pure virtual

Gets The name of a vertex input state graphics object as specified in the creation information.

Parameters
handleThe vertex input state graphics object handle.
Returns
The vertex input state graphics object name.

◆ getName() [5/16]

virtual string kanzi::gfx::DebugInformation::getName ( const DepthStencilStateHandleGuard & handle) const
pure virtual

Gets The name of a depth stencil state graphics object as specified in the creation information.

Parameters
handleThe depth stencil state graphics object handle.
Returns
The depth stencil state graphics object name.

◆ getName() [6/16]

virtual string kanzi::gfx::DebugInformation::getName ( const BlendStateHandleGuard & handle) const
pure virtual

Gets The name of a blend state graphics object as specified in the creation information.

Parameters
handleThe blend state graphics object handle.
Returns
The blend state graphics object name.

◆ getName() [7/16]

virtual string kanzi::gfx::DebugInformation::getName ( const RasterStateHandleGuard & handle) const
pure virtual

Gets The name of a raster state graphics object as specified in the creation information.

Parameters
handleThe raster state graphics object handle.
Returns
The raster state graphics object name.

◆ getName() [8/16]

virtual string kanzi::gfx::DebugInformation::getName ( const RenderResourceSetHandleGuard & handle) const
pure virtual

Gets The name of a render resource set graphics object as specified in the creation information.

Parameters
handleThe render resource set graphics object handle.
Returns
The render resource set graphics object name.

◆ getName() [9/16]

virtual string kanzi::gfx::DebugInformation::getName ( const ComputeResourceSetHandleGuard & handle) const
pure virtual

Gets The name of a compute resource set graphics object as specified in the creation information.

Parameters
handleThe compute resource set graphics object handle.
Returns
The compute resource set graphics object name.

◆ getName() [10/16]

virtual string kanzi::gfx::DebugInformation::getName ( const SamplerHandleGuard & handle) const
pure virtual

Gets The name of a sampler graphics object as specified in the creation information.

Parameters
handleThe sampler graphics object handle.
Returns
The sampler graphics object name.

◆ getName() [11/16]

virtual string kanzi::gfx::DebugInformation::getName ( const ShaderHandleGuard & handle) const
pure virtual

Gets The name of a shader graphics object as specified in the creation information.

Parameters
handleThe shader graphics object handle.
Returns
The shader graphics object name.

◆ getName() [12/16]

virtual string kanzi::gfx::DebugInformation::getName ( const ComputePipelineHandleGuard & handle) const
pure virtual

Gets The name of a compute pipeline graphics object as specified in the creation information.

Parameters
handleThe compute pipeline graphics object handle.
Returns
The compute pipeline graphics object name.

◆ getName() [13/16]

virtual string kanzi::gfx::DebugInformation::getName ( const RenderPipelineHandleGuard & handle) const
pure virtual

Gets The name of a render pipeline graphics object as specified in the creation information.

Parameters
handleThe render pipeline graphics object handle.
Returns
The render pipeline graphics object name.

◆ getName() [14/16]

virtual string kanzi::gfx::DebugInformation::getName ( const RenderPassHandleGuard & handle) const
pure virtual

Gets The name of a render pass graphics object as specified in the creation information.

Parameters
handleThe render pass graphics object handle.
Returns
The render pass graphics object name.

◆ getName() [15/16]

virtual string kanzi::gfx::DebugInformation::getName ( const CommandBufferHandleGuard & handle) const
pure virtual

Gets The name of a command buffer graphics object as specified in the creation information.

Parameters
handleThe command buffer graphics object handle.
Returns
The command buffer graphics object name.

◆ getName() [16/16]

virtual string kanzi::gfx::DebugInformation::getName ( const GpuFenceHandleGuard & handle) const
pure virtual

Gets The name of a GPU fence graphics object as specified in the creation information.

Parameters
handleThe GPU fence graphics object handle.
Returns
The GOU fence graphics object name.

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