summaryrefslogtreecommitdiffstats
path: root/Graphics/GraphicsEngine
diff options
context:
space:
mode:
authorassiduous <assiduous@diligentgraphics.com>2020-08-17 03:23:57 +0000
committerassiduous <assiduous@diligentgraphics.com>2020-08-17 03:23:57 +0000
commit4bafe5ebc8568afdbf81173dc9bb0b960b4d3019 (patch)
treef8d0f2280f0e9f62fbfc0717b6c0ccbb37a3629f /Graphics/GraphicsEngine
parentVk backend: using VK_LAYER_KHRONOS_validation on all platforms (diff)
downloadDiligentCore-4bafe5ebc8568afdbf81173dc9bb0b960b4d3019.tar.gz
DiligentCore-4bafe5ebc8568afdbf81173dc9bb0b960b4d3019.zip
Updated description of indirect draw/dispatch commands to specify the arguments order
Diffstat (limited to 'Graphics/GraphicsEngine')
-rw-r--r--Graphics/GraphicsEngine/interface/DeviceContext.h17
1 files changed, 16 insertions, 1 deletions
diff --git a/Graphics/GraphicsEngine/interface/DeviceContext.h b/Graphics/GraphicsEngine/interface/DeviceContext.h
index eb77ba8e..84a0a4a4 100644
--- a/Graphics/GraphicsEngine/interface/DeviceContext.h
+++ b/Graphics/GraphicsEngine/interface/DeviceContext.h
@@ -951,6 +951,11 @@ DILIGENT_BEGIN_INTERFACE(IDeviceContext, IObject)
/// \param [in] Attribs - Structure describing the command attributes, see Diligent::DrawIndirectAttribs for details.
/// \param [in] pAttribsBuffer - Pointer to the buffer, from which indirect draw attributes will be read.
+ /// The buffer must contain the following arguments at the specified offset:
+ /// Uint32 NumVertices;
+ /// Uint32 NumInstances;
+ /// Uint32 StartVertexLocation;
+ /// Uint32 FirstInstanceLocation;
///
/// \remarks If IndirectAttribsBufferStateTransitionMode member is Diligent::RESOURCE_STATE_TRANSITION_MODE_TRANSITION,
/// the method may transition the state of the indirect draw arguments buffer. This is not a thread safe operation,
@@ -971,6 +976,12 @@ DILIGENT_BEGIN_INTERFACE(IDeviceContext, IObject)
/// \param [in] Attribs - Structure describing the command attributes, see Diligent::DrawIndexedIndirectAttribs for details.
/// \param [in] pAttribsBuffer - Pointer to the buffer, from which indirect draw attributes will be read.
+ /// The buffer must contain the following arguments at the specified offset:
+ /// Uint32 NumIndices;
+ /// Uint32 NumInstances;
+ /// Uint32 FirstIndexLocation;
+ /// Uint32 BaseVertex;
+ /// Uint32 FirstInstanceLocation
///
/// \remarks If IndirectAttribsBufferStateTransitionMode member is Diligent::RESOURCE_STATE_TRANSITION_MODE_TRANSITION,
/// the method may transition the state of the indirect draw arguments buffer. This is not a thread safe operation,
@@ -997,7 +1008,11 @@ DILIGENT_BEGIN_INTERFACE(IDeviceContext, IObject)
/// Executes an indirect dispatch compute command.
/// \param [in] Attribs - The command attributes, see Diligent::DispatchComputeIndirectAttribs for details.
- /// \param [in] pAttribsBuffer - Pointer to the buffer containing indirect dispatch arguments.
+ /// \param [in] pAttribsBuffer - Pointer to the buffer containing indirect dispatch attributes.
+ /// The buffer must contain the following arguments at the specified offset:
+ /// Uint32 ThreadGroupCountX;
+ /// Uint32 ThreadGroupCountY;
+ /// Uint32 ThreadGroupCountZ;
///
/// \remarks If IndirectAttribsBufferStateTransitionMode member is Diligent::RESOURCE_STATE_TRANSITION_MODE_TRANSITION,
/// the method may transition the state of indirect dispatch arguments buffer. This is not a thread safe operation,