Graphics.Vulkan.Core10.CommandBuffer

Documentation

allocateCommandBuffers :: forall io. MonadIO io => Device -> CommandBufferAllocateInfo -> io ("commandBuffers" ::: Vector CommandBuffer)

vkAllocateCommandBuffers - Allocate command buffers from an existing command pool

Parameters

• device is the logical device that owns the command pool.

• pAllocateInfo is a pointer to a CommandBufferAllocateInfo structure describing parameters of the allocation.
• pCommandBuffers is a pointer to an array of CommandBuffer handles in which the resulting command buffer objects are returned. The array must be at least the length specified by the commandBufferCount member of pAllocateInfo. Each allocated command buffer begins in the initial state.

Description

allocateCommandBuffers can be used to create multiple command buffers. If the creation of any of those command buffers fails, the implementation must destroy all successfully created command buffer objects from this command, set all entries of the pCommandBuffers array to NULL and return the error.

When command buffers are first allocated, they are in the initial state.

Valid Usage (Implicit)

• device must be a valid Device handle

• pAllocateInfo must be a valid pointer to a valid CommandBufferAllocateInfo structure
• pCommandBuffers must be a valid pointer to an array of pAllocateInfo->commandBufferCount CommandBuffer handles
• The value referenced by pAllocateInfo->commandBufferCount must be greater than 0

Host Synchronization

• Host access to pAllocateInfo->commandPool must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CommandBuffer, CommandBufferAllocateInfo, Device

withCommandBuffers :: forall io r. MonadIO io => (io (Vector CommandBuffer) -> (Vector CommandBuffer -> io ()) -> r) -> Device -> CommandBufferAllocateInfo -> r

A convenience wrapper to make a compatible pair of calls to allocateCommandBuffers and freeCommandBuffers

To ensure that freeCommandBuffers 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.

freeCommandBuffers :: forall io. MonadIO io => Device -> CommandPool -> ("commandBuffers" ::: Vector CommandBuffer) -> io ()

vkFreeCommandBuffers - Free command buffers

Parameters

• device is the logical device that owns the command pool.

• commandPool is the command pool from which the command buffers were allocated.
• commandBufferCount is the length of the pCommandBuffers array.
• pCommandBuffers is a pointer to an array of handles of command buffers to free.

Description

Any primary command buffer that is in the recording or executable state and has any element of pCommandBuffers recorded into it, becomes invalid.

Valid Usage

• All elements of pCommandBuffers must not be in the pending state

• pCommandBuffers must be a valid pointer to an array of commandBufferCount CommandBuffer handles, each element of which must either be a valid handle or NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• commandPool must be a valid CommandPool handle
• commandBufferCount must be greater than 0
• commandPool must have been created, allocated, or retrieved from device
• Each element of pCommandBuffers that is a valid handle must have been created, allocated, or retrieved from commandPool

Host Synchronization

• Host access to commandPool must be externally synchronized

• Host access to each member of pCommandBuffers must be externally synchronized

See Also

CommandBuffer, CommandPool, Device

beginCommandBuffer :: forall a io. (PokeChain a, MonadIO io) => CommandBuffer -> CommandBufferBeginInfo a -> io ()

vkBeginCommandBuffer - Start recording a command buffer

Parameters

• commandBuffer is the handle of the command buffer which is to be put in the recording state.

• pBeginInfo points to a CommandBufferBeginInfo structure defining additional information about how the command buffer begins recording.

Valid Usage

• commandBuffer must not be in the recording or pending state

• If commandBuffer was allocated from a CommandPool which did not have the COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT flag set, commandBuffer must be in the initial state
• If commandBuffer is a secondary command buffer, the pInheritanceInfo member of pBeginInfo must be a valid CommandBufferInheritanceInfo structure
• If commandBuffer is a secondary command buffer and either the occlusionQueryEnable member of the pInheritanceInfo member of pBeginInfo is FALSE, or the precise occlusion queries feature is not enabled, the queryFlags member of the pInheritanceInfo member pBeginInfo must not contain QUERY_CONTROL_PRECISE_BIT
• If commandBuffer is a primary command buffer, then pBeginInfo->flags must not set both the COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT and the COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT flags

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBeginInfo must be a valid pointer to a valid CommandBufferBeginInfo structure

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CommandBuffer, CommandBufferBeginInfo

useCommandBuffer :: forall a io r. (PokeChain a, MonadIO io) => (io () -> io () -> r) -> CommandBuffer -> CommandBufferBeginInfo a -> r

A convenience wrapper to make a compatible pair of calls to beginCommandBuffer and endCommandBuffer

To ensure that endCommandBuffer 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

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

vkEndCommandBuffer - Finish recording a command buffer

Parameters

• commandBuffer is the command buffer to complete recording.

Description

If there was an error during recording, the application will be notified by an unsuccessful return code returned by endCommandBuffer. If the application wishes to further use the command buffer, the command buffer must be reset. The command buffer must have been in the recording state, and is moved to the executable state.

Valid Usage

• commandBuffer must be in the recording state

• If commandBuffer is a primary command buffer, there must not be an active render pass instance
• All queries made active during the recording of commandBuffer must have been made inactive
• Conditional rendering must not be active
• If commandBuffer is a secondary command buffer, there must not be an outstanding cmdBeginDebugUtilsLabelEXT command recorded to commandBuffer that has not previously been ended by a call to cmdEndDebugUtilsLabelEXT
• If commandBuffer is a secondary command buffer, there must not be an outstanding cmdDebugMarkerBeginEXT command recorded to commandBuffer that has not previously been ended by a call to cmdDebugMarkerEndEXT

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CommandBuffer

resetCommandBuffer :: forall io. MonadIO io => CommandBuffer -> CommandBufferResetFlags -> io ()

vkResetCommandBuffer - Reset a command buffer to the initial state

Parameters

• commandBuffer is the command buffer to reset. The command buffer can be in any state other than pending, and is moved into the initial state.

• flags is a bitmask of CommandBufferResetFlagBits controlling the reset operation.

Description

Any primary command buffer that is in the recording or executable state and has commandBuffer recorded into it, becomes invalid.

Valid Usage

• commandBuffer must not be in the pending state

• commandBuffer must have been allocated from a pool that was created with the COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• flags must be a valid combination of CommandBufferResetFlagBits values

Host Synchronization

• Host access to commandBuffer must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CommandBuffer, CommandBufferResetFlags

data CommandBufferAllocateInfo

VkCommandBufferAllocateInfo - Structure specifying the allocation parameters for command buffer object

Valid Usage (Implicit)

See Also

CommandBufferLevel, CommandPool, StructureType, allocateCommandBuffers

Constructors

CommandBufferAllocateInfo

Fields

• commandPool :: CommandPool

  commandPool must be a valid CommandPool handle

• level :: CommandBufferLevel

  level must be a valid CommandBufferLevel value

• commandBufferCount :: Word32

  commandBufferCount must be greater than 0

Instances

Show CommandBufferAllocateInfo

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

showsPrec :: Int -> CommandBufferAllocateInfo -> ShowS

show :: CommandBufferAllocateInfo -> String

showList :: [CommandBufferAllocateInfo] -> ShowS

Storable CommandBufferAllocateInfo

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

sizeOf :: CommandBufferAllocateInfo -> Int

alignment :: CommandBufferAllocateInfo -> Int

peekElemOff :: Ptr CommandBufferAllocateInfo -> Int -> IO CommandBufferAllocateInfo

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

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

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

peek :: Ptr CommandBufferAllocateInfo -> IO CommandBufferAllocateInfo

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

FromCStruct CommandBufferAllocateInfo

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

peekCStruct :: Ptr CommandBufferAllocateInfo -> IO CommandBufferAllocateInfo

ToCStruct CommandBufferAllocateInfo

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

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

pokeCStruct :: Ptr CommandBufferAllocateInfo -> CommandBufferAllocateInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CommandBufferAllocateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CommandBufferAllocateInfo

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

zero :: CommandBufferAllocateInfo

data CommandBufferInheritanceInfo (es :: [Type])

VkCommandBufferInheritanceInfo - Structure specifying command buffer inheritance info

Valid Usage

• If the inherited queries feature is not enabled, occlusionQueryEnable must be FALSE

• If the inherited queries feature is enabled, queryFlags must be a valid combination of QueryControlFlagBits values
• If the inherited queries feature is not enabled, queryFlags must be 0
• If the pipeline statistics queries feature is enabled, pipelineStatistics must be a valid combination of QueryPipelineStatisticFlagBits values
• If the pipeline statistics queries feature is not enabled, pipelineStatistics must be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of CommandBufferInheritanceConditionalRenderingInfoEXT or CommandBufferInheritanceRenderPassTransformInfoQCOM
• The sType value of each struct in the pNext chain must be unique
• Both of framebuffer, and renderPass that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

Bool32, CommandBufferBeginInfo, Framebuffer, QueryControlFlags, QueryPipelineStatisticFlags, RenderPass, StructureType

Constructors

CommandBufferInheritanceInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to an extension-specific structure.

• renderPass :: RenderPass

  renderPass is a RenderPass object defining which render passes the CommandBuffer will be compatible with and can be executed within. If the CommandBuffer will not be executed within a render pass instance, renderPass is ignored.

• subpass :: Word32

  subpass is the index of the subpass within the render pass instance that the CommandBuffer will be executed within. If the CommandBuffer will not be executed within a render pass instance, subpass is ignored.

• framebuffer :: Framebuffer

  framebuffer optionally refers to the Framebuffer object that the CommandBuffer will be rendering to if it is executed within a render pass instance. It can be NULL_HANDLE if the framebuffer is not known, or if the CommandBuffer will not be executed within a render pass instance.

  Note

  Specifying the exact framebuffer that the secondary command buffer will be executed with may result in better performance at command buffer execution time.

• occlusionQueryEnable :: Bool

  occlusionQueryEnable specifies whether the command buffer can be executed while an occlusion query is active in the primary command buffer. If this is TRUE, then this command buffer can be executed whether the primary command buffer has an occlusion query active or not. If this is FALSE, then the primary command buffer must not have an occlusion query active.

• queryFlags :: QueryControlFlags

  queryFlags specifies the query flags that can be used by an active occlusion query in the primary command buffer when this secondary command buffer is executed. If this value includes the QUERY_CONTROL_PRECISE_BIT bit, then the active query can return boolean results or actual sample counts. If this bit is not set, then the active query must not use the QUERY_CONTROL_PRECISE_BIT bit.

• pipelineStatistics :: QueryPipelineStatisticFlags

  pipelineStatistics is a bitmask of QueryPipelineStatisticFlagBits specifying the set of pipeline statistics that can be counted by an active query in the primary command buffer when this secondary command buffer is executed. If this value includes a given bit, then this command buffer can be executed whether the primary command buffer has a pipeline statistics query active that includes this bit or not. If this value excludes a given bit, then the active pipeline statistics query must not be from a query pool that counts that statistic.

Instances

Extensible CommandBufferInheritanceInfo

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

extensibleType :: StructureType

getNext :: CommandBufferInheritanceInfo es -> Chain es

setNext :: CommandBufferInheritanceInfo ds -> Chain es -> CommandBufferInheritanceInfo es

extends :: Typeable e => proxy e -> (Extends CommandBufferInheritanceInfo e -> b) -> Maybe b

Show (Chain es) => Show (CommandBufferInheritanceInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

showsPrec :: Int -> CommandBufferInheritanceInfo es -> ShowS

show :: CommandBufferInheritanceInfo es -> String

showList :: [CommandBufferInheritanceInfo es] -> ShowS

PeekChain es => FromCStruct (CommandBufferInheritanceInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

peekCStruct :: Ptr (CommandBufferInheritanceInfo es) -> IO (CommandBufferInheritanceInfo es)

PokeChain es => ToCStruct (CommandBufferInheritanceInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

withCStruct :: CommandBufferInheritanceInfo es -> (Ptr (CommandBufferInheritanceInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (CommandBufferInheritanceInfo es) -> CommandBufferInheritanceInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (CommandBufferInheritanceInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (CommandBufferInheritanceInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ([] :: [Type]) => Zero (CommandBufferInheritanceInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

zero :: CommandBufferInheritanceInfo es

data CommandBufferBeginInfo (es :: [Type])

VkCommandBufferBeginInfo - Structure specifying a command buffer begin operation

Valid Usage

• If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the renderPass member of pInheritanceInfo must be a valid RenderPass

• If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the subpass member of pInheritanceInfo must be a valid subpass index within the renderPass member of pInheritanceInfo
• If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the framebuffer member of pInheritanceInfo must be either NULL_HANDLE, or a valid Framebuffer that is compatible with the renderPass member of pInheritanceInfo

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO

• pNext must be NULL or a pointer to a valid instance of DeviceGroupCommandBufferBeginInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of CommandBufferUsageFlagBits values

See Also

CommandBufferInheritanceInfo, CommandBufferUsageFlags, StructureType, beginCommandBuffer

Constructors

CommandBufferBeginInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to an extension-specific structure.

• flags :: CommandBufferUsageFlags

  flags is a bitmask of CommandBufferUsageFlagBits specifying usage behavior for the command buffer.

• inheritanceInfo :: Maybe (SomeStruct CommandBufferInheritanceInfo)

  pInheritanceInfo is a pointer to a CommandBufferInheritanceInfo structure, used if commandBuffer is a secondary command buffer. If this is a primary command buffer, then this value is ignored.

Instances

Extensible CommandBufferBeginInfo

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

extensibleType :: StructureType

getNext :: CommandBufferBeginInfo es -> Chain es

setNext :: CommandBufferBeginInfo ds -> Chain es -> CommandBufferBeginInfo es

extends :: Typeable e => proxy e -> (Extends CommandBufferBeginInfo e -> b) -> Maybe b

Show (Chain es) => Show (CommandBufferBeginInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

showsPrec :: Int -> CommandBufferBeginInfo es -> ShowS

show :: CommandBufferBeginInfo es -> String

showList :: [CommandBufferBeginInfo es] -> ShowS

PeekChain es => FromCStruct (CommandBufferBeginInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

peekCStruct :: Ptr (CommandBufferBeginInfo es) -> IO (CommandBufferBeginInfo es)

PokeChain es => ToCStruct (CommandBufferBeginInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

withCStruct :: CommandBufferBeginInfo es -> (Ptr (CommandBufferBeginInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (CommandBufferBeginInfo es) -> CommandBufferBeginInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (CommandBufferBeginInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (CommandBufferBeginInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ([] :: [Type]) => Zero (CommandBufferBeginInfo es)

Defined in Graphics.Vulkan.Core10.CommandBuffer

Methods

zero :: CommandBufferBeginInfo es