Commands

Collaboration diagram for Commands:

Classes
class	kanzi::gfx::BaseCommand
	The base class for all graphics commands. More...
struct	kanzi::gfx::BeginComputePipelineCommand
	Begins a compute pipeline in the command stream. More...
struct	kanzi::gfx::BeginRenderPassCommand
	Begins a render pass in the command stream. More...
struct	kanzi::gfx::BeginRenderPipelineCommand
	Begins a render pipeline in the command stream. More...
struct	kanzi::gfx::BindComputeResourceSetCommand
	Binds the resource sets within the current render pipeline. More...
struct	kanzi::gfx::BindRenderResourceSetCommand
	Binds the resource sets within the current render pipeline. More...
struct	kanzi::gfx::BindVertexInputCommand
	Binds the vertex buffer bindings within the current render pipeline. More...
struct	kanzi::gfx::ClearCommand
	Clears viewport. More...
struct	kanzi::gfx::ConstantDataCommand
	Sets current constant data in a render pipeline. More...
struct	kanzi::gfx::CopyBufferCommand
	Copies a region of a source buffer to a destination buffer. More...
struct	kanzi::gfx::CopyBufferToImageCommand
	Copies a source buffer to a destination image. More...
struct	kanzi::gfx::CopyImageCommand
	Copies a subresource of a source image to a destination image. More...
struct	kanzi::gfx::CopyImageToBufferCommand
	Copies a source image to a destination buffer. More...
struct	kanzi::gfx::CopySurfaceToBufferCommand
	Copies an on-screen surface to a destination buffer. More...
struct	kanzi::gfx::DispatchCommand
	Dispatches a compute operation in a compute pipeline. More...
struct	kanzi::gfx::DispatchIndirectCommand
	Dispatches an indirect compute operation in a compute pipeline. More...
struct	kanzi::gfx::DrawCommand
	Issues a draw command in a render pipeline. More...
struct	kanzi::gfx::DrawIndirectCommand
	Issues an indirect draw command in a render pipeline. More...
struct	kanzi::gfx::EndComputePipelineCommand
	Ends a compute pipeline in the command stream. More...
struct	kanzi::gfx::EndRenderPassCommand
	Ends a render pass in the command stream. More...
struct	kanzi::gfx::EndRenderPipelineCommand
	Ends a render pipeline in the command stream. More...
struct	kanzi::gfx::GenerateMipmapsCommand
	Generates mipmaps for an image. More...
struct	kanzi::gfx::PresentCommand
	Presents the surface frame buffer. More...
struct	kanzi::gfx::ResolveMultisampleImageCommand
	Resolves a multisampled image. More...
struct	kanzi::gfx::SetLineWidthCommand
	Sets the line width for current render pipeline. More...
struct	kanzi::gfx::SetScissorCommand
	Sets the scissor coordinates. More...
struct	kanzi::gfx::SetUniformOffsetCommand
	Sets a Uniform Offset that will take effect with the next BindRenderResourceSetCommand or BindRenderResourceSetCommand. More...
struct	kanzi::gfx::SetViewportCommand
	Sets the viewport coordinates. More...
struct	kanzi::gfx::SignalGpuFenceCommand
	Signals a GPU fence. More...
struct	kanzi::gfx::SubroutineCommand
	Causes the command processing to transfer execution to the subroutine command buffer. More...
struct	kanzi::gfx::VertexBufferBinding
	Describes a Vertex Buffer Binding. More...

Enumerations
enum struct	kanzi::gfx::CommandType : uint8_t {   kanzi::gfx::CommandType::CopyBuffer , kanzi::gfx::CommandType::CopyBufferToImage , kanzi::gfx::CommandType::CopyImage , kanzi::gfx::CommandType::CopyImageToBuffer ,   kanzi::gfx::CommandType::CopySurfaceToBuffer , kanzi::gfx::CommandType::BeginRenderPass , kanzi::gfx::CommandType::EndRenderPass , kanzi::gfx::CommandType::BeginRenderPipeline ,   kanzi::gfx::CommandType::EndRenderPipeline , kanzi::gfx::CommandType::Draw , kanzi::gfx::CommandType::DrawIndirect , kanzi::gfx::CommandType::BeginComputePipeline ,   kanzi::gfx::CommandType::EndComputePipeline , kanzi::gfx::CommandType::Dispatch , kanzi::gfx::CommandType::DispatchIndirect , kanzi::gfx::CommandType::ConstantData ,   kanzi::gfx::CommandType::Present , kanzi::gfx::CommandType::Subroutine , kanzi::gfx::CommandType::SignalGpuFence , kanzi::gfx::CommandType::ResolveMultisampleImage ,   kanzi::gfx::CommandType::GenerateMipmaps , kanzi::gfx::CommandType::SetViewport , kanzi::gfx::CommandType::SetScissor , kanzi::gfx::CommandType::Clear ,   kanzi::gfx::CommandType::SetLineWidth , kanzi::gfx::CommandType::BindVertexInput , kanzi::gfx::CommandType::SetUniformOffset , kanzi::gfx::CommandType::BindRenderResourceSet ,   kanzi::gfx::CommandType::BindComputeResourceSet }
	Specifies the types of graphics commands. More...

Detailed Description

The graphics commands are used to record work for the graphics backend to process asychronously.

Enumeration Type Documentation

CommandType

enum struct kanzi::gfx::CommandType : uint8_t

strong

Specifies the types of graphics commands.

Since

Kanzi 4.0.0

Enumerator
CopyBuffer	Copy Buffer to Buffer Command.
CopyBufferToImage	Copy Buffer to Image Command.
CopyImage	Copy Image to Image Command.
CopyImageToBuffer	Copy Image to Buffer Command.
CopySurfaceToBuffer	Copy Surface to Buffer Command.
BeginRenderPass	Begin Render Pass Command.
EndRenderPass	End Render Pass Command.
BeginRenderPipeline	Begin Render Pipeline Command.
EndRenderPipeline	End Render Pipeline Command.
Draw	Draw Command.
DrawIndirect	Draw Indirect Command.
BeginComputePipeline	Begin Compute Pipeline Command.
EndComputePipeline	End Compute Pipeline Command.
Dispatch	Dispatch Compute Command.
DispatchIndirect	Dispatch Indirect Compute Command.
ConstantData	Constant Data Command.
Present	Present Surface Command.
Subroutine	Run Subroutine Command.
SignalGpuFence	Signal Gpu Fence Command.
ResolveMultisampleImage	Resolve Multi-sample Image Command.
GenerateMipmaps	Generate Mipmaps Command.
SetViewport	Set viewport coordinates. The viewport coordinates are set also by the BeginRenderPass command.
SetScissor	Set scissor coordinates. The scissor coordinates are set also by the BeginRenderPass command.
Clear	Clear viewport.
SetLineWidth	Set line width command.
BindVertexInput	Bind Vertex Input Command.
SetUniformOffset	Set Uniform Buffer Offset Command.
BindRenderResourceSet	Bind Render ResourceSet Command.
BindComputeResourceSet	Bind Compute ResourceSet Command.