Skip to content

Commit

Permalink
[Docs] Updated documentation for CommandBuffer::Execute() (fixes Luka…
Browse files Browse the repository at this point in the history
…sBanana#114).

Added remarks to the documentation that secondary command buffers submitted via CommandBuffer::Execute() will invalidate their primary command buffers when they are updated via Begin()/End().
  • Loading branch information
LukasBanana committed May 26, 2024
1 parent b93d773 commit d742804
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion include/LLGL/CommandBuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
\brief Executes the specified deferred command buffer.
\param[in] deferredCommandBuffer Specifies the deferred command buffer which is meant to be executed.
This command buffer must have been created with the CommandBufferFlags::Secondary flag.
\remarks This function can only be used by primary command buffers, i.e. command buffers that have not been created with the flag CommandBufferFlags::Secondary.
\remarks This function can only be used by primary command buffers, i.e. command buffers that have \e not been created with the flag CommandBufferFlags::Secondary.
\remarks Once this command buffer is submitted for execution to one or more primary command buffers,
it <b>must not</b> be updated unless all of such primary command buffers are also updated before their next submission to the command queue.
\see CommandBufferFlags
\todo Incomplete for: D3D12, Vulkan, Metal.
*/
Expand Down

0 comments on commit d742804

Please sign in to comment.