| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Vulkan.Extensions.VK_EXT_conditional_rendering
Synopsis
- cmdBeginConditionalRenderingEXT :: forall io. MonadIO io => CommandBuffer -> ConditionalRenderingBeginInfoEXT -> io ()
- cmdUseConditionalRenderingEXT :: forall io r. MonadIO io => CommandBuffer -> ConditionalRenderingBeginInfoEXT -> io r -> io r
- cmdEndConditionalRenderingEXT :: forall io. MonadIO io => CommandBuffer -> io ()
- data ConditionalRenderingBeginInfoEXT = ConditionalRenderingBeginInfoEXT {}
- data CommandBufferInheritanceConditionalRenderingInfoEXT = CommandBufferInheritanceConditionalRenderingInfoEXT {}
- data PhysicalDeviceConditionalRenderingFeaturesEXT = PhysicalDeviceConditionalRenderingFeaturesEXT {}
- newtype ConditionalRenderingFlagBitsEXT where
- 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
Documentation
cmdBeginConditionalRenderingEXT Source #
Arguments
| :: forall io. MonadIO io | |
| => CommandBuffer |
|
| -> ConditionalRenderingBeginInfoEXT |
|
| -> io () |
vkCmdBeginConditionalRenderingEXT - Define the beginning of a conditional rendering block
Valid Usage
- Conditional rendering must not already be active
Valid Usage (Implicit)
commandBuffermust be a validCommandBufferhandle
pConditionalRenderingBeginmust be a valid pointer to a validConditionalRenderingBeginInfoEXTstructurecommandBuffermust be in the recording state- The
CommandPoolthatcommandBufferwas allocated from must support graphics, or compute operations
Host Synchronization
- Host access to
commandBuffermust be externally synchronized
- Host access to the
CommandPoolthatcommandBufferwas 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
cmdUseConditionalRenderingEXT :: forall io r. MonadIO io => CommandBuffer -> ConditionalRenderingBeginInfoEXT -> io r -> io r Source #
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.
cmdEndConditionalRenderingEXT Source #
Arguments
| :: forall io. MonadIO io | |
| => CommandBuffer |
|
| -> io () |
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)
commandBuffermust be a validCommandBufferhandle
commandBuffermust be in the recording state- The
CommandPoolthatcommandBufferwas allocated from must support graphics, or compute operations
Host Synchronization
- Host access to
commandBuffermust be externally synchronized
- Host access to the
CommandPoolthatcommandBufferwas 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
data ConditionalRenderingBeginInfoEXT Source #
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
bufferis non-sparse then it must be bound completely and contiguously to a singleDeviceMemoryobject
buffermust have been created with theBUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXTbit setoffsetmust be less than the size ofbufferby at least 32 bitsoffsetmust be a multiple of 4
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT
pNextmust beNULLbuffermust be a validBufferhandleflagsmust be a valid combination ofConditionalRenderingFlagBitsEXTvalues
See Also
Buffer, ConditionalRenderingFlagsEXT,
DeviceSize,
StructureType,
cmdBeginConditionalRenderingEXT
Constructors
| ConditionalRenderingBeginInfoEXT | |
Fields
| |
Instances
data CommandBufferInheritanceConditionalRenderingInfoEXT Source #
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,
conditionalRenderingEnablemust beFALSE
Valid Usage (Implicit)
See Also
Constructors
| CommandBufferInheritanceConditionalRenderingInfoEXT | |
Fields
| |
Instances
data PhysicalDeviceConditionalRenderingFeaturesEXT Source #
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
Constructors
| PhysicalDeviceConditionalRenderingFeaturesEXT | |
Fields
| |
Instances
newtype ConditionalRenderingFlagBitsEXT Source #
VkConditionalRenderingFlagBitsEXT - Specify the behavior of conditional rendering
See Also
Constructors
| ConditionalRenderingFlagBitsEXT Flags |
Bundled Patterns
| pattern CONDITIONAL_RENDERING_INVERTED_BIT_EXT :: ConditionalRenderingFlagBitsEXT |
|
Instances
pattern EXT_CONDITIONAL_RENDERING_SPEC_VERSION :: forall a. Integral a => a Source #
type EXT_CONDITIONAL_RENDERING_EXTENSION_NAME = "VK_EXT_conditional_rendering" Source #
pattern EXT_CONDITIONAL_RENDERING_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #