LiteFX::Rendering::IRenderPass::begin

Begins the render pass by recording into the external primary command buffer provided by commandBuffer.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, dllexport]] void begin(
    IFrameBuffer const& frameBuffer,
    ICommandBuffer const& commandBuffer) const;

Description

With this overload, the render pass does not submit commandBuffer. Ending it with end only records commands and returns 0. If the render pass has a present target, submit commandBuffer and call ISwapChain::present with the returned fence afterwards. The command buffer must be a recording primary command buffer that was created from commandQueue.

Note that pipeline and binding state is not preserved across the render pass boundaries!

Exceptions

Name	Thrown on
InvalidArgumentException	Thrown, if commandBuffer is not a recording primary command buffer of the render pass queue.

Parameters

Name	Description
frameBuffer	The frame buffer to obtain input attachments and render targets from.
commandBuffer	The primary command buffer to record the render pass into.