handles.hpp File Reference

#include <kanzi/gfx/gfx_api.hpp>
#include <kanzi/core/cpp/cstdint.hpp>
#include <kanzi/core/cpp/limits.hpp>
#include <kanzi/core/cpp/utility.hpp>

Classes
struct	kanzi::gfx::DefaultHandleGuardT
	Helper struct to construct a default handle of any type. More...
class	kanzi::gfx::HandleGuard< T_Handle >
	The HandleGuard class provides a reference counted reference to a graphics handle. More...
struct	kanzi::gfx::InvalidHandleGuardT
	Helper struct to construct an invalid handle of any type. More...

Namespaces
namespace	kanzi
namespace	kanzi::gfx

Macros
#define	KZ_DEBUG_HANDLE_CALLSTACKS

Typedefs
using	kanzi::gfx::BlendStateHandleGuard
	Reference counted blend state handle.
using	kanzi::gfx::BufferHandleGuard
	Reference counted buffer handle.
using	kanzi::gfx::CommandBufferHandleGuard
	Reference counted command buffer handle.
using	kanzi::gfx::ComputePipelineHandleGuard
	Reference counted compute pipeline handle.
using	kanzi::gfx::ComputeResourceSetHandleGuard
	Reference counted compute resource set handle.
using	kanzi::gfx::DepthStencilStateHandleGuard
	Reference counted depth stencil state handle.
using	kanzi::gfx::FrameBufferHandleGuard
	Reference counted frame buffer handle.
using	kanzi::gfx::GpuFenceHandleGuard
	Reference counted GPU fence handle.
using	kanzi::gfx::ImageHandleGuard
	Reference counted image handle.
using	kanzi::gfx::RasterStateHandleGuard
	Reference counted raster state handle.
using	kanzi::gfx::RenderPassHandleGuard
	Reference counted render pass handle.
using	kanzi::gfx::RenderPipelineHandleGuard
	Reference counted render pipeline handle.
using	kanzi::gfx::RenderResourceSetHandleGuard
	Reference counted render resource set handle.
using	kanzi::gfx::SamplerHandleGuard
	Reference counted sampler handle.
using	kanzi::gfx::ShaderHandleGuard
	Reference counted shader handle.
using	kanzi::gfx::VertexInputStateHandleGuard
	Reference counted vertex input state handle.

Enumerations
enum class	kanzi::gfx::BlendStateHandle : uint16_t { kanzi::gfx::BlendStateHandle::Default , kanzi::gfx::BlendStateHandle::Invalid }
	Raw handle for blend state objects. More...
enum class	kanzi::gfx::BufferHandle : uint16_t { kanzi::gfx::BufferHandle::Default , kanzi::gfx::BufferHandle::Invalid }
	Raw handle for buffer objects. More...
enum class	kanzi::gfx::CommandBufferHandle : uint16_t { kanzi::gfx::CommandBufferHandle::Default , kanzi::gfx::CommandBufferHandle::Invalid }
	Raw handle for command buffer objects. More...
enum class	kanzi::gfx::ComputePipelineHandle : uint16_t { kanzi::gfx::ComputePipelineHandle::Default , kanzi::gfx::ComputePipelineHandle::Invalid }
	Raw handle for compute pipeline objects. More...
enum class	kanzi::gfx::ComputeResourceSetHandle : uint16_t { kanzi::gfx::ComputeResourceSetHandle::Default , kanzi::gfx::ComputeResourceSetHandle::Invalid }
	Raw handle for compute resource set objects. More...
enum class	kanzi::gfx::DepthStencilStateHandle : uint16_t { kanzi::gfx::DepthStencilStateHandle::Default , kanzi::gfx::DepthStencilStateHandle::Invalid }
	Raw handle for depth stencil state objects. More...
enum class	kanzi::gfx::FrameBufferHandle : uint16_t { kanzi::gfx::FrameBufferHandle::Default , kanzi::gfx::FrameBufferHandle::Invalid }
	Raw handle for frame buffer objects. More...
enum class	kanzi::gfx::GpuFenceHandle : uint16_t { kanzi::gfx::GpuFenceHandle::Default , kanzi::gfx::GpuFenceHandle::Invalid }
	Raw handle for GPU fence objects. More...
enum class	kanzi::gfx::ImageHandle : uint16_t { kanzi::gfx::ImageHandle::Default , kanzi::gfx::ImageHandle::Invalid }
	Raw handle for image objects. More...
enum class	kanzi::gfx::RasterStateHandle : uint16_t { kanzi::gfx::RasterStateHandle::Default , kanzi::gfx::RasterStateHandle::Invalid }
	Raw handle for raster state objects. More...
enum class	kanzi::gfx::RenderPassHandle : uint16_t { kanzi::gfx::RenderPassHandle::Default , kanzi::gfx::RenderPassHandle::Invalid }
	Raw handle for render pass objects. More...
enum class	kanzi::gfx::RenderPipelineHandle : uint16_t { kanzi::gfx::RenderPipelineHandle::Default , kanzi::gfx::RenderPipelineHandle::Invalid }
	Raw handle for render pipeline objects. More...
enum class	kanzi::gfx::RenderResourceSetHandle : uint16_t { kanzi::gfx::RenderResourceSetHandle::Default , kanzi::gfx::RenderResourceSetHandle::Invalid }
	Raw handle for render resource set objects. More...
enum class	kanzi::gfx::SamplerHandle : uint16_t { kanzi::gfx::SamplerHandle::Default , kanzi::gfx::SamplerHandle::Invalid }
	Raw handle for sampler objects. More...
enum class	kanzi::gfx::ShaderHandle : uint16_t { kanzi::gfx::ShaderHandle::Default , kanzi::gfx::ShaderHandle::Invalid }
	Raw handle for shader objects. More...
enum class	kanzi::gfx::VertexInputStateHandle : uint16_t { kanzi::gfx::VertexInputStateHandle::Default , kanzi::gfx::VertexInputStateHandle::Invalid }
	Raw handle for vertex input state objects. More...

Functions
template<typename T_Handle >
bool	kanzi::gfx::operator!= (const HandleGuard< T_Handle > &lhs, const HandleGuard< T_Handle > &rhs)
	Handle non-equality operator.
template<typename T_Handle >
bool	kanzi::gfx::operator!= (const HandleGuard< T_Handle > &lhs, const T_Handle &rhs)
	Handle non-equality operator.
template<typename T_Handle >
bool	kanzi::gfx::operator== (const HandleGuard< T_Handle > &lhs, const HandleGuard< T_Handle > &rhs)
	Handle equality operator.
template<typename T_Handle >
bool	kanzi::gfx::operator== (const HandleGuard< T_Handle > &lhs, const T_Handle &rhs)
	Handle equality operator.

Variables
struct kanzi::gfx::DefaultHandleGuardT	kanzi::gfx::DefaultHandleGuard
struct kanzi::gfx::InvalidHandleGuardT	kanzi::gfx::InvalidHandleGuard

Macro Definition Documentation

KZ_DEBUG_HANDLE_CALLSTACKS

#define KZ_DEBUG_HANDLE_CALLSTACKS