class CommandList

book_4_sparkGenerated
code_blocksInput

Description

The CommandList class in the Sandbox.Rendering namespace is a sealed class used for managing rendering commands in the s&box game engine. It provides a variety of methods to manipulate rendering operations, such as drawing models, setting shader parameters, and managing render targets.

Members

Instance Members

Member Name Summary
Reset Resets the command list to its initial state.
Blit Performs a blit operation using the specified material.
DrawQuad Draws a quad with the specified rectangle, material, and color.
DrawScreenQuad Draws a full-screen quad using the specified material and color.
Set Sets a shader parameter using a string token and a value. Supports multiple overloads for different data types.
SetCombo Sets a shader combo using a string token and a value. Supports generic overloads.
SetConstantBuffer Sets a constant buffer using a string token and data.
GrabFrameTexture Takes a copy of the framebuffer and returns a handle to it.
InsertList Inserts another command list to be executed.
DrawModel Draws a single model at the given transform immediately.
DrawModelInstanced Draws multiple instances of a model using GPU instancing.
DrawModelInstancedIndirect Draws multiple instances of a model using GPU instancing with indirect draw arguments.
GetRenderTarget Gets a screen size render target.
ReleaseRenderTarget Releases a render target, returning it to the pool.
SetGlobal Sets a global shader parameter using a string token and a value.
DispatchCompute Dispatches a compute shader with specified dimensions.

Properties

Property Name Summary
DebugName Gets or sets the debug name of the command list.
Enabled Gets or sets a value indicating whether the command list is enabled.
Flags Gets or sets the flags associated with the command list.
ViewportSize A handle to the viewport size.