Insert a memory dependency for a Buffer

• Parameters

  buffer	The buffer affected by this barrier.
  oldState	Old state in a memory state transition.
  newState	New state in a memory state transition.

Insert a memory dependency

Parameters

image	The image affected by this barrier.
oldState	Old state in an image state transition.
newState	New state in an image state transition.
firstMipLevel	The first mip level to include is this barrier
levelCount	Number of mip level to include
firstArrayLayer	The first array layer to include is this barrier
layerCount	Number of array layers level to include

Insert a memory dependency

Parameters

renderTarget	The image affected by this barrier.
oldState	Old state in an image state transition.
newState	New state in an image state transition.
firstArrayLayer	The first array layer to include is this barrier
layerCount	Number of array layers level to include

Insert a memory dependency

Parameters

swapChain	The image affected by this barrier.
oldState	Old state in an image state transition.
newState	New state in an image state transition.

Insert a memory dependency

Parameters

images	The images affected by this barrier.
oldState	Old state in an image state transition.
newState	New state in an image state transition.
firstArrayLayer	The first array layer to include is this barrier
layerCount	Number of array layers level to include

Insert a memory dependency

Parameters

renderTargets	The images affected by this barrier.
oldState	Old state in an image state transition.
newState	New state in an image state transition.
firstArrayLayer	The first array layer to include is this barrier
layerCount	Number of array layers level to include

Start recording a command list

Begin a render pass

Binds a dynamic uniform descriptor set to a command list, after a pipeline have been bound

Parameters

descriptor	The descriptor set to bind
set	The set number of the descriptor set to be bound
offset	Values specifying dynamic offsets for the UNIFORM_DYNAMIC resource.

Bind descriptor set to a command list, after a pipeline have been bound

Parameters

descriptor	The descriptor set to bind
set	The set number of the descriptor set to be bound

Binds a dynamic uniform descriptor set to a command list, after a pipeline have been bound

Parameters

descriptor	The descriptor set to bind
set	The set number of the descriptor set to be bound
offset	Values specifying dynamic offsets for the UNIFORM_DYNAMIC resource.

Binds descriptor set to a command list, after a pipeline have been bound

Parameters

descriptor	The descriptor set to bind
set	The set number of the descriptor set to be bound

Bind descriptor sets to a command list, after a pipeline have been bound

Parameters

descriptors	The descriptor sets to bind
firstSet	The set number of the first descriptor set to be bound

Bind descriptor sets to a command list, before binding a pipeline

Parameters

pipelineType	The pipelines type to be bound after
pipelineResources	The pipelines layouts
descriptors	The descriptor sets to bind
firstSet	The set number of the first descriptor set to be bound

Binds an index buffer to a command list

Parameters

buffer	An index buffer
indexType	Value specifying the size of the indices
firstIndex	First index in the buffer

Binds an index buffer to a command list

Parameters

buffer	An index buffer
indexType	Value specifying the size of the indices
firstIndex	First index in the buffer

Binds a pipeline object to a command list

Binds a pipeline object to a command list

Bind a vertex buffer to a command list

Parameters

buffer	A vertex buffer
offset	Offset in bytes

Bind a vertex buffer to a command list

Parameters

buffer	A vertex buffer
offset	Offset in bytes

Binds vertex buffers to a command list

Parameters

buffers	Buffers to bind
offsets	Offsets for each buffer in bytes

Release staging buffers allocated by upload() calls. Must be called after the GPU has finished executing the command list. Omitting this call leaks GPU-visible upload memory.

Copy multiple regions of a buffer into another buffer

Copy data from a buffer into another buffer

Copy data from a buffer into a multi-level image. One sourceOffset offset in bytes for each level. If rowPitchAlignment is true (for Vulkan), the data in the buffer must have row-aligned data (cf. Image::IMAGE_ROW_PITCH_ALIGNMENT) for cross-API compatibility.

Copy data from a buffer into an image level. If rowPitchAlignment is true (for Vulkan), the data in the buffer must have row-aligned data (cf. Image::IMAGE_ROW_PITCH_ALIGNMENT) for cross-API compatibility.

Copy a level of an image into a buffer

Blit an image into the current swap chain image

Blit an image into the current swap chain image

Copy an image into another imagee

Copy an image into the current swap chain image

Copy an image into the current swap chain image

Copy data from a buffer into an image level. If rowPitchAlignment is true (for Vulkan), the data in the buffer must have row-aligned data (cf. Image::IMAGE_ROW_PITCH_ALIGNMENT) for cross-API compatibility.

Copy data from a buffer into a multi-level image. One sourceOffset offset in bytes for each level. If rowPitchAlignment is true (for Vulkan), the data in the buffer must have row-aligned data (cf. Image::IMAGE_ROW_PITCH_ALIGNMENT) for cross-API compatibility.

Copy data from a buffer into another buffer

Copy multiple regions of a buffer into another buffer

Copy an image into a buffer

Copy an image into another imagee

Copy an image into the current swap chain image

Copy an image into the current swap chain image

Dispatch compute work items

Parameters

x	The number of local workgroups to dispatch in the X dimension.
y	The number of local workgroups to dispatch in the Y dimension.
z	The number of local workgroups to dispatch in the Z dimension.

Draw primitives

Parameters

vertexCountPerInstance	The number of vertices per instance to draw
instanceCount	The number of instances
firstVertex	The index of the first vertex to draw
firstInstance	The index of the first instance to draw.

Draw primitives with indexed vertices

Parameters

indexCountPerInstance	The number of vertices per instance to draw
instanceCount	The number of instances
firstIndex	The base index within the index buffer.
firstVertex	The value added to the vertex index before indexing into the vertex buffer.
firstInstance	The index of the first instance to draw.

Draw primitives with indirect parameters and indexed vertices

Parameters

buffer	The buffer containing draw parameters.
offset	The byte offset into the buffer where parameters begin.
maxDrawCount	The maximum number of draws that will be executed. The actual number of executed draw calls is the minimum of the count specified in countBuffer and maxDrawCount
stride	The byte stride between successive sets of draw parameters.
firstCommandOffset	Offset in bytes of the first command

Draw primitives with indirect parameters and indexed vertices

Parameters

buffer	The buffer containing draw parameters.
offset	The byte offset into the buffer where parameters begin.
maxDrawCount	The maximum number of draws that will be executed. The actual number of executed draw calls is the minimum of the count specified in countBuffer and maxDrawCount
stride	The byte stride between successive sets of draw parameters.
firstCommandOffset	Offset in bytes of the first command

Draw primitives with indirect parameters and indexed vertices

Parameters

buffer	The buffer containing draw parameters.
offset	The byte offset into the buffer where parameters begin.
countBuffer	The buffer containing the draw count.
countOffset	The byte offset into countBuffer where the draw count begins.
maxDrawCount	The maximum number of draws that will be executed. The actual number of executed draw calls is the minimum of the count specified in countBuffer and maxDrawCount
stride	The byte stride between successive sets of draw parameters.
firstCommandOffset	Offset in bytes of the first command

Draw primitives with indirect parameters and indexed vertices

Parameters

buffer	The buffer containing draw parameters.
offset	The byte offset into the buffer where parameters begin.
countBuffer	The buffer containing the draw count.
countOffset	The byte offset into countBuffer where the draw count begins.
maxDrawCount	The maximum number of draws that will be executed. The actual number of executed draw calls is the minimum of the count specified in countBuffer and maxDrawCount
stride	The byte stride between successive sets of draw parameters.
firstCommandOffset	Offset in bytes of the first command

Draw primitives with indirect parameters

Parameters

buffer	The buffer containing draw parameters.
offset	The byte offset into the buffer where parameters begin.
drawCount	The number of draws to execute, and can be zero.
stride	The byte stride between successive sets of draw parameters.
firstCommandOffset	Offset in bytes of the first command

Draw primitives with indirect parameters

Parameters

buffer	The buffer containing draw parameters.
offset	The byte offset into the buffer where parameters begin.
drawCount	The number of draws to execute, and can be zero.
stride	The byte stride between successive sets of draw parameters.
firstCommandOffset	Offset in bytes of the first command

Stop recording a command list

End a render pass

Update the values of push constants

Parameters

pipelineResources	The pipeline layout used to program the push constant updates.
pushConstants	The push constant description
data	The new push constant values.

Copies a contiguous range of timestamp slots from a query pool into its internal host-visible readback buffer so the CPU can read the results.

Parameters

queryPool	The pool to resolve.
firstQuery	Index of the first slot to resolve.
queryCount	Number of consecutive slots to resolve.

Note

This command must be recorded in the same command list (and after) all writeTimestamp() calls for the resolved range.

Sets the scissors for a command list

Parameters

rect	An array of Extent structures specifying viewport parameters.

Sets the scissors for a command list

Parameters

rects

An array of Rect structures specifying viewport parameters.

Set the reference value for stencil tests and operations

Sets the viewport for a command list

Parameters

viewport

An array of Extent structures specifying viewport parameters.

Sets the viewports for a command list

Parameters

viewports

An array of Viewport structures specifying viewport parameters

Uploads data into a buffer using a temporary (staging) buffer.

Upload data into an image using a temporary (staging) buffer.

Uploads data into a buffer using a temporary (staging) buffer.

Upload data into an image using a temporary (staging) buffer.

Uploads data into buffers using temporary (staging) buffers.

Uploads data into images using temporary (staging) buffers.

Upload images into an image array

Upload images into an image array

Records a GPU timestamp into a query pool slot at the top-of-pipe stage.

Parameters

queryPool	The pool to write into.
queryIndex	Slot index within the pool (must be < pool capacity).

Note

Always call resolveQueryPool() after all writeTimestamp() calls in the same command list, before the list is submitted.

Size in bytes for each IndexType value (UINT16 → 2, UINT32 → 4)