ICommandList
public interface ICommandList
Encodes a sequence of commands which will be sent to GPU to render.
Methods
| Method | Description |
|---|---|
| bindDescriptorSet(IDescriptorSet descriptorSet) | Bind the descriptor set to current pipeline |
| bindIndexBuffer(IIndexBuffer indexBuffer) | Bind the index buffer for rendering |
| bindPipeline(IPipeline pipeline) | Bind the pipeline instance for rendering |
| bindVertexBuffer(IVertexBuffer vertexBuffer) | Bind the vertex buffer for rendering |
| draw() | Draw without index buffer |
| draw(int start, int count) | Draw without index buffer |
| drawIndex() | Issue an indexed draw into a command list |
| drawIndex(int start, int count) | Issue an indexed draw into a command list |
| pushConstants(int stage, byte[] data) | Push the constant to the pipeline |
| pushConstants(int stage, byte[] data, int size) | Push the constant to the pipeline |
bindDescriptorSet(IDescriptorSet descriptorSet)
public abstract void bindDescriptorSet(IDescriptorSet descriptorSet)
Bind the descriptor set to current pipeline
Parameters:
| Parameter | Type | Description |
|---|---|---|
| descriptorSet | IDescriptorSet |
bindIndexBuffer(IIndexBuffer indexBuffer)
public abstract void bindIndexBuffer(IIndexBuffer indexBuffer)
Bind the index buffer for rendering
Parameters:
| Parameter | Type | Description |
|---|---|---|
| indexBuffer | IIndexBuffer |
bindPipeline(IPipeline pipeline)
public abstract void bindPipeline(IPipeline pipeline)
Bind the pipeline instance for rendering
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pipeline | IPipeline |
bindVertexBuffer(IVertexBuffer vertexBuffer)
public abstract void bindVertexBuffer(IVertexBuffer vertexBuffer)
Bind the vertex buffer for rendering
Parameters:
| Parameter | Type | Description |
|---|---|---|
| vertexBuffer | IVertexBuffer |
draw()
public abstract void draw()
Draw without index buffer
draw(int start, int count)
public abstract void draw(int start, int count)
Draw without index buffer
Parameters:
| Parameter | Type | Description |
|---|---|---|
| start | int | |
| count | int |
drawIndex()
public abstract void drawIndex()
Issue an indexed draw into a command list
drawIndex(int start, int count)
public abstract void drawIndex(int start, int count)
Issue an indexed draw into a command list
Parameters:
| Parameter | Type | Description |
|---|---|---|
| start | int | The first index to draw |
| count | int | The count of indices to draw |
pushConstants(int stage, byte[] data)
public abstract void pushConstants(int stage, byte[] data)
Push the constant to the pipeline
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stage | int | Which shader stage will consume the constant data |
| data | byte[] | The data that will be sent to the shader |
pushConstants(int stage, byte[] data, int size)
public abstract void pushConstants(int stage, byte[] data, int size)
Push the constant to the pipeline
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stage | int | Which shader stage will consume the constant data |
| data | byte[] | The data that will be sent to the shader |
| size | int | Bytes to write to the pipeline |