Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Documentation

cmdBeginConditionalRenderingEXT :: forall io. MonadIO io => CommandBuffer -> ConditionalRenderingBeginInfoEXT -> io ()

vkCmdBeginConditionalRenderingEXT - Define the beginning of a conditional rendering block

Parameters

• commandBuffer is the command buffer into which this command will be recorded.

• pConditionalRenderingBegin is a pointer to a ConditionalRenderingBeginInfoEXT structure specifying parameters of conditional rendering.

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 graphics, or compute operations

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

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
Primary Secondary	Both	Graphics Compute

See Also

CommandBuffer, ConditionalRenderingBeginInfoEXT

cmdWithConditionalRenderingEXT :: forall io r. MonadIO io => (io () -> io () -> r) -> CommandBuffer -> ConditionalRenderingBeginInfoEXT -> r

A convenience wrapper to make a compatible pair of calls to cmdBeginConditionalRenderingEXT and cmdEndConditionalRenderingEXT

To ensure that cmdEndConditionalRenderingEXT is always called: pass bracket_ (or the allocate function from your favourite resource management library) as the first argument. To just extract the pair pass '(,)' as the first argument.

Note that there is no inner resource

cmdEndConditionalRenderingEXT :: forall io. MonadIO io => CommandBuffer -> io ()

vkCmdEndConditionalRenderingEXT - Define the end of a conditional rendering block

Parameters

• commandBuffer is the command buffer into which this command will be recorded.

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 graphics, or compute operations

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

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
Primary Secondary	Both	Graphics Compute

See Also

CommandBuffer

data ConditionalRenderingBeginInfoEXT

VkConditionalRenderingBeginInfoEXT - Structure specifying conditional rendering begin info

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 bit 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

Buffer, ConditionalRenderingFlagsEXT, DeviceSize, StructureType, cmdBeginConditionalRenderingEXT

Constructors

ConditionalRenderingBeginInfoEXT

Fields

• buffer :: Buffer

  buffer is a buffer containing the predicate for conditional rendering.

• offset :: DeviceSize

  offset is the byte offset into buffer where the predicate is located.

• flags :: ConditionalRenderingFlagsEXT

  flags is a bitmask of ConditionalRenderingFlagsEXT specifying the behavior of conditional rendering.

Instances

Show ConditionalRenderingBeginInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

showsPrec :: Int -> ConditionalRenderingBeginInfoEXT -> ShowS

show :: ConditionalRenderingBeginInfoEXT -> String

showList :: [ConditionalRenderingBeginInfoEXT] -> ShowS

Storable ConditionalRenderingBeginInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

sizeOf :: ConditionalRenderingBeginInfoEXT -> Int

alignment :: ConditionalRenderingBeginInfoEXT -> Int

peekElemOff :: Ptr ConditionalRenderingBeginInfoEXT -> Int -> IO ConditionalRenderingBeginInfoEXT

pokeElemOff :: Ptr ConditionalRenderingBeginInfoEXT -> Int -> ConditionalRenderingBeginInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ConditionalRenderingBeginInfoEXT

pokeByteOff :: Ptr b -> Int -> ConditionalRenderingBeginInfoEXT -> IO ()

peek :: Ptr ConditionalRenderingBeginInfoEXT -> IO ConditionalRenderingBeginInfoEXT

poke :: Ptr ConditionalRenderingBeginInfoEXT -> ConditionalRenderingBeginInfoEXT -> IO ()

FromCStruct ConditionalRenderingBeginInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

peekCStruct :: Ptr ConditionalRenderingBeginInfoEXT -> IO ConditionalRenderingBeginInfoEXT

ToCStruct ConditionalRenderingBeginInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

withCStruct :: ConditionalRenderingBeginInfoEXT -> (Ptr ConditionalRenderingBeginInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ConditionalRenderingBeginInfoEXT -> ConditionalRenderingBeginInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ConditionalRenderingBeginInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ConditionalRenderingBeginInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ConditionalRenderingBeginInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

zero :: ConditionalRenderingBeginInfoEXT

data CommandBufferInheritanceConditionalRenderingInfoEXT

VkCommandBufferInheritanceConditionalRenderingInfoEXT - Structure specifying command buffer inheritance info

Description

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

Valid Usage

• If the inherited conditional rendering feature is not enabled, conditionalRenderingEnable must be FALSE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_CONDITIONAL_RENDERING_INFO_EXT

See Also

Bool32, StructureType

Constructors

CommandBufferInheritanceConditionalRenderingInfoEXT

Fields

• conditionalRenderingEnable :: Bool

  conditionalRenderingEnable specifies whether the command buffer can be executed while conditional rendering is active in the primary command buffer. If this is TRUE, then this command buffer can be executed whether the primary command buffer has active conditional rendering or not. If this is FALSE, then the primary command buffer must not have conditional rendering active.

Instances

Show CommandBufferInheritanceConditionalRenderingInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

showsPrec :: Int -> CommandBufferInheritanceConditionalRenderingInfoEXT -> ShowS

show :: CommandBufferInheritanceConditionalRenderingInfoEXT -> String

showList :: [CommandBufferInheritanceConditionalRenderingInfoEXT] -> ShowS

Storable CommandBufferInheritanceConditionalRenderingInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

sizeOf :: CommandBufferInheritanceConditionalRenderingInfoEXT -> Int

alignment :: CommandBufferInheritanceConditionalRenderingInfoEXT -> Int

peekElemOff :: Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> Int -> IO CommandBufferInheritanceConditionalRenderingInfoEXT

pokeElemOff :: Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> Int -> CommandBufferInheritanceConditionalRenderingInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO CommandBufferInheritanceConditionalRenderingInfoEXT

pokeByteOff :: Ptr b -> Int -> CommandBufferInheritanceConditionalRenderingInfoEXT -> IO ()

peek :: Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> IO CommandBufferInheritanceConditionalRenderingInfoEXT

poke :: Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> CommandBufferInheritanceConditionalRenderingInfoEXT -> IO ()

FromCStruct CommandBufferInheritanceConditionalRenderingInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

peekCStruct :: Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> IO CommandBufferInheritanceConditionalRenderingInfoEXT

ToCStruct CommandBufferInheritanceConditionalRenderingInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

withCStruct :: CommandBufferInheritanceConditionalRenderingInfoEXT -> (Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> CommandBufferInheritanceConditionalRenderingInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr CommandBufferInheritanceConditionalRenderingInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CommandBufferInheritanceConditionalRenderingInfoEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

zero :: CommandBufferInheritanceConditionalRenderingInfoEXT

data PhysicalDeviceConditionalRenderingFeaturesEXT

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

Description

If the PhysicalDeviceConditionalRenderingFeaturesEXT structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating the implementation-dependent behavior. PhysicalDeviceConditionalRenderingFeaturesEXT can also be included in pNext chain of DeviceCreateInfo to enable the features.

Valid Usage (Implicit)

See Also

Bool32, StructureType

Constructors

PhysicalDeviceConditionalRenderingFeaturesEXT

Fields

• conditionalRendering :: Bool

  conditionalRendering specifies whether conditional rendering is supported.

• inheritedConditionalRendering :: Bool

  inheritedConditionalRendering specifies whether a secondary command buffer can be executed while conditional rendering is active in the primary command buffer.

Instances

Show PhysicalDeviceConditionalRenderingFeaturesEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

showsPrec :: Int -> PhysicalDeviceConditionalRenderingFeaturesEXT -> ShowS

show :: PhysicalDeviceConditionalRenderingFeaturesEXT -> String

showList :: [PhysicalDeviceConditionalRenderingFeaturesEXT] -> ShowS

Storable PhysicalDeviceConditionalRenderingFeaturesEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

sizeOf :: PhysicalDeviceConditionalRenderingFeaturesEXT -> Int

alignment :: PhysicalDeviceConditionalRenderingFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> Int -> IO PhysicalDeviceConditionalRenderingFeaturesEXT

pokeElemOff :: Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> Int -> PhysicalDeviceConditionalRenderingFeaturesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceConditionalRenderingFeaturesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceConditionalRenderingFeaturesEXT -> IO ()

peek :: Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> IO PhysicalDeviceConditionalRenderingFeaturesEXT

poke :: Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> PhysicalDeviceConditionalRenderingFeaturesEXT -> IO ()

FromCStruct PhysicalDeviceConditionalRenderingFeaturesEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

peekCStruct :: Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> IO PhysicalDeviceConditionalRenderingFeaturesEXT

ToCStruct PhysicalDeviceConditionalRenderingFeaturesEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

withCStruct :: PhysicalDeviceConditionalRenderingFeaturesEXT -> (Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> PhysicalDeviceConditionalRenderingFeaturesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceConditionalRenderingFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceConditionalRenderingFeaturesEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

zero :: PhysicalDeviceConditionalRenderingFeaturesEXT

newtype ConditionalRenderingFlagBitsEXT

VkConditionalRenderingFlagBitsEXT - Specify the behavior of conditional rendering

See Also

ConditionalRenderingFlagsEXT

Constructors

ConditionalRenderingFlagBitsEXT Flags

Bundled Patterns

pattern CONDITIONAL_RENDERING_INVERTED_BIT_EXT :: ConditionalRenderingFlagBitsEXT

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.

Instances

Eq ConditionalRenderingFlagBitsEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

(==) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> Bool

(/=) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> Bool

Ord ConditionalRenderingFlagBitsEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

compare :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> Ordering

(<) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> Bool

(<=) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> Bool

(>) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> Bool

(>=) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> Bool

max :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT

min :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT

Read ConditionalRenderingFlagBitsEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

readsPrec :: Int -> ReadS ConditionalRenderingFlagBitsEXT

readList :: ReadS [ConditionalRenderingFlagBitsEXT]

readPrec :: ReadPrec ConditionalRenderingFlagBitsEXT

readListPrec :: ReadPrec [ConditionalRenderingFlagBitsEXT]

Show ConditionalRenderingFlagBitsEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

showsPrec :: Int -> ConditionalRenderingFlagBitsEXT -> ShowS

show :: ConditionalRenderingFlagBitsEXT -> String

showList :: [ConditionalRenderingFlagBitsEXT] -> ShowS

Storable ConditionalRenderingFlagBitsEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

sizeOf :: ConditionalRenderingFlagBitsEXT -> Int

alignment :: ConditionalRenderingFlagBitsEXT -> Int

peekElemOff :: Ptr ConditionalRenderingFlagBitsEXT -> Int -> IO ConditionalRenderingFlagBitsEXT

pokeElemOff :: Ptr ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ConditionalRenderingFlagBitsEXT

pokeByteOff :: Ptr b -> Int -> ConditionalRenderingFlagBitsEXT -> IO ()

peek :: Ptr ConditionalRenderingFlagBitsEXT -> IO ConditionalRenderingFlagBitsEXT

poke :: Ptr ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> IO ()

Bits ConditionalRenderingFlagBitsEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

(.&.) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT

(.|.) :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT

xor :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT

complement :: ConditionalRenderingFlagBitsEXT -> ConditionalRenderingFlagBitsEXT

shift :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

rotate :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

zeroBits :: ConditionalRenderingFlagBitsEXT

bit :: Int -> ConditionalRenderingFlagBitsEXT

setBit :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

clearBit :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

complementBit :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

testBit :: ConditionalRenderingFlagBitsEXT -> Int -> Bool

bitSizeMaybe :: ConditionalRenderingFlagBitsEXT -> Maybe Int

bitSize :: ConditionalRenderingFlagBitsEXT -> Int

isSigned :: ConditionalRenderingFlagBitsEXT -> Bool

shiftL :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

unsafeShiftL :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

shiftR :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

unsafeShiftR :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

rotateL :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

rotateR :: ConditionalRenderingFlagBitsEXT -> Int -> ConditionalRenderingFlagBitsEXT

popCount :: ConditionalRenderingFlagBitsEXT -> Int

Zero ConditionalRenderingFlagBitsEXT

Defined in Graphics.Vulkan.Extensions.VK_EXT_conditional_rendering

Methods

zero :: ConditionalRenderingFlagBitsEXT

type ConditionalRenderingFlagsEXT = ConditionalRenderingFlagBitsEXT

type EXT_CONDITIONAL_RENDERING_SPEC_VERSION = 2

pattern EXT_CONDITIONAL_RENDERING_SPEC_VERSION :: forall a. Integral a => a

type EXT_CONDITIONAL_RENDERING_EXTENSION_NAME = "VK_EXT_conditional_rendering"

pattern EXT_CONDITIONAL_RENDERING_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a