Vulkan.Extensions.VK_EXT_conditional_rendering

vkCmdBeginConditionalRenderingEXT - Define the beginning of a conditional rendering block

Valid Usage

• Conditional rendering must not already be active

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pConditionalRenderingBegin must be a valid pointer to a valid ConditionalRenderingBeginInfoEXT structure

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT operations

• This command must not be called between suspended render pass instances

• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdBeginConditionalRenderingEXT is not affected by conditional rendering

See Also

VK_EXT_conditional_rendering, CommandBuffer, ConditionalRenderingBeginInfoEXT

This function will call the supplied action between calls to cmdBeginConditionalRenderingEXT and cmdEndConditionalRenderingEXT

Note that cmdEndConditionalRenderingEXT is *not* called if an exception is thrown by the inner action.

vkCmdEndConditionalRenderingEXT - Define the end of a conditional rendering block

Description

Once ended, conditional rendering becomes inactive.

Valid Usage

• Conditional rendering must be active

• If conditional rendering was made active outside of a render pass instance, it must not be ended inside a render pass instance

• If conditional rendering was made active within a subpass it must be ended in the same subpass

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT operations

• This command must not be called between suspended render pass instances

• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdEndConditionalRenderingEXT is not affected by conditional rendering

See Also

VK_EXT_conditional_rendering, CommandBuffer

VkConditionalRenderingBeginInfoEXT - Structure specifying conditional rendering begin information

Description

If the 32-bit value at offset in buffer memory is zero, then the rendering commands are discarded, otherwise they are executed as normal. If the value of the predicate in buffer memory changes while conditional rendering is active, the rendering commands may be discarded in an implementation-dependent way. Some implementations may latch the value of the predicate upon beginning conditional rendering while others may read it before every rendering command.

Valid Usage

• If buffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object

• buffer must have been created with the BUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXT usage flag set

• offset must be less than the size of buffer by at least 32 bits

• offset must be a multiple of 4

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT

• pNext must be NULL

• buffer must be a valid Buffer handle

• flags must be a valid combination of ConditionalRenderingFlagBitsEXT values

See Also

VK_EXT_conditional_rendering, Buffer, ConditionalRenderingFlagsEXT, DeviceSize, StructureType, cmdBeginConditionalRenderingEXT

VkCommandBufferInheritanceConditionalRenderingInfoEXT - Structure specifying command buffer inheritance information

Description

If this structure is not present, the behavior is as if conditionalRenderingEnable is FALSE.

Valid Usage

• If the inheritedConditionalRendering feature is not enabled, conditionalRenderingEnable must be FALSE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_CONDITIONAL_RENDERING_INFO_EXT

Structure Chaining

Extends the structure

• CommandBufferInheritanceInfo

See Also

VK_EXT_conditional_rendering, Bool32, StructureType

VkPhysicalDeviceConditionalRenderingFeaturesEXT - Structure describing if a secondary command buffer can be executed if conditional rendering is active in the primary command buffer

Members

This structure describes the following features:

Description

If the PhysicalDeviceConditionalRenderingFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceConditionalRenderingFeaturesEXT, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_EXT_conditional_rendering, Bool32, StructureType

VkConditionalRenderingFlagBitsEXT - Specify the behavior of conditional rendering

Description

• CONDITIONAL_RENDERING_INVERTED_BIT_EXT specifies the condition used to determine whether to discard rendering commands or not. That is, if the 32-bit predicate read from buffer memory at offset is zero, the rendering commands are not discarded, and if non zero, then they are discarded.

See Also

VK_EXT_conditional_rendering, ConditionalRenderingFlagsEXT