The CommandList class in the Sandbox.Rendering namespace is a core component for managing rendering commands in s&box. It provides a comprehensive set of methods to manipulate rendering states, draw models, and manage resources efficiently. This class is sealed, meaning it cannot be inherited.
| Member Name | Summary |
|---|---|
| Reset | Resets the command list to its initial state. |
| Blit | Copies a source texture to a destination using a specified material. |
| DrawQuad | Draws a quad with a specified material, rectangle, and color. |
| DrawScreenQuad | Draws a full-screen quad using a specified material and color. |
| Set | Sets a shader parameter using a token and a value. |
| SetCombo | Sets a shader combo using a token and a value. |
| SetConstantBuffer | Sets a constant buffer for a shader using a token and data. |
| SetGlobal | Sets a global shader parameter using a token and a value. |
| GrabFrameTexture | Grabs the current frame texture for use in rendering. |
| GrabDepthTexture | Grabs the current depth texture for use in rendering. |
| InsertList | Inserts another command list into the current one. |
| DrawModel | Draws a model with a specified transform and render attributes. |
| DrawModelInstanced | Draws a model with instancing using multiple transforms. |
| DrawModelInstancedIndirect | Draws a model with instancing using an indirect buffer. |
| Draw | Draws primitives from a vertex buffer using a material and attributes. |
| DrawIndexed | Draws indexed primitives from a vertex and index buffer using a material and attributes. |
| DrawInstancedIndirect | Draws instanced primitives using an indirect buffer. |
| DrawIndexedInstancedIndirect | Draws indexed instanced primitives using an indirect buffer. |
| GetRenderTarget | Retrieves a render target handle with specified parameters. |
| ReleaseRenderTarget | Releases a previously acquired render target handle. |
| SetRenderTarget | Sets the current render target to a specified handle. |
| DispatchCompute | Dispatches a compute shader with specified thread counts. |
| DispatchComputeIndirect | Dispatches a compute shader using an indirect buffer. |
| TransferRenderTarget | Transfers a render target to another command list. |
| Clear | Clears the current render target with specified options. |
| ResourceBarrierTransition | Transitions a resource to a different state. |
| 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. |