Vulkan.Core10.CommandBuffer

Documentation

allocateCommandBuffers

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the command pool.

-> CommandBufferAllocateInfo

pAllocateInfo is a pointer to a CommandBufferAllocateInfo structure describing parameters of the allocation.

-> io ("commandBuffers" ::: Vector CommandBuffer)

vkAllocateCommandBuffers - Allocate command buffers from an existing command pool

Description

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

Note

Filling pCommandBuffers with NULL values on failure is an exception to the default error behavior that output parameters will have undefined contents.

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

VK_VERSION_1_0, CommandBuffer, CommandBufferAllocateInfo, Device

withCommandBuffers :: forall io r. MonadIO io => Device -> CommandBufferAllocateInfo -> (io (Vector CommandBuffer) -> (Vector CommandBuffer -> io ()) -> r) -> 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 last argument. To just extract the pair pass (,) as the last argument.

freeCommandBuffers

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the command pool.

-> CommandPool

commandPool is the command pool from which the command buffers were allocated.

-> ("commandBuffers" ::: Vector CommandBuffer)

pCommandBuffers is a pointer to an array of handles of command buffers to free.

-> io ()

vkFreeCommandBuffers - Free command buffers

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

VK_VERSION_1_0, CommandBuffer, CommandPool, Device

beginCommandBuffer

Arguments

:: forall a io. (Extendss CommandBufferBeginInfo a, PokeChain a, MonadIO io)

=> CommandBuffer

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

-> CommandBufferBeginInfo a

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

-> io ()

vkBeginCommandBuffer - Start recording a command buffer

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, then pBeginInfo->pInheritanceInfo->queryFlags 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

VK_VERSION_1_0, CommandBuffer, CommandBufferBeginInfo

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

This function will call the supplied action between calls to beginCommandBuffer and endCommandBuffer

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

endCommandBuffer

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer to complete recording.

-> io ()

vkEndCommandBuffer - Finish recording a command buffer

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

VK_VERSION_1_0, CommandBuffer

resetCommandBuffer

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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.

-> CommandBufferResetFlags

flags is a bitmask of CommandBufferResetFlagBits controlling the reset operation.

-> io ()

vkResetCommandBuffer - Reset a command buffer to the initial state

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

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_VERSION_1_0, CommandBuffer, CommandBufferResetFlags

data CommandBufferAllocateInfo

VkCommandBufferAllocateInfo - Structure specifying the allocation parameters for command buffer object

Valid Usage (Implicit)

See Also

VK_VERSION_1_0, CommandBufferLevel, CommandPool, StructureType, allocateCommandBuffers

Constructors

CommandBufferAllocateInfo

Fields

• commandPool :: CommandPool

  commandPool is the command pool from which the command buffers are allocated.

  commandPool must be a valid CommandPool handle

• level :: CommandBufferLevel

  level is a CommandBufferLevel value specifying the command buffer level.

  level must be a valid CommandBufferLevel value

• commandBufferCount :: Word32

  commandBufferCount is the number of command buffers to allocate from the pool.

Instances

Eq CommandBufferAllocateInfo

Defined in Vulkan.Core10.CommandBuffer

Methods

(==) :: CommandBufferAllocateInfo -> CommandBufferAllocateInfo -> Bool

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

Show CommandBufferAllocateInfo

Defined in Vulkan.Core10.CommandBuffer

Methods

showsPrec :: Int -> CommandBufferAllocateInfo -> ShowS

show :: CommandBufferAllocateInfo -> String

showList :: [CommandBufferAllocateInfo] -> ShowS

Storable CommandBufferAllocateInfo

Defined in 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 Vulkan.Core10.CommandBuffer

Methods

peekCStruct :: Ptr CommandBufferAllocateInfo -> IO CommandBufferAllocateInfo

ToCStruct CommandBufferAllocateInfo

Defined in 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 Vulkan.Core10.CommandBuffer

Methods

zero :: CommandBufferAllocateInfo

data CommandBufferInheritanceInfo (es :: [Type])

VkCommandBufferInheritanceInfo - Structure specifying command buffer inheritance information

Description

If the CommandBuffer will not be executed within a render pass instance, or if the render pass instance was begun with cmdBeginRenderingKHR, renderPass, subpass, and framebuffer are ignored.

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 AttachmentSampleCountInfoAMD, CommandBufferInheritanceConditionalRenderingInfoEXT, CommandBufferInheritanceRenderPassTransformInfoQCOM, CommandBufferInheritanceRenderingInfoKHR, CommandBufferInheritanceViewportScissorInfoNV, or MultiviewPerViewAttributesInfoNVX
• 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

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

Constructors

CommandBufferInheritanceInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• renderPass :: RenderPass

  renderPass is a RenderPass object defining which render passes the CommandBuffer will be compatible with and can be executed within.

• subpass :: Word32

  subpass is the index of the subpass within the render pass instance that the CommandBuffer will be executed within.

• framebuffer :: Framebuffer

  framebuffer can refer 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.

  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 Vulkan.Core10.CommandBuffer

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). CommandBufferInheritanceInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). CommandBufferInheritanceInfo ds -> Chain es -> CommandBufferInheritanceInfo es

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

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

Defined in Vulkan.Core10.CommandBuffer

Methods

showsPrec :: Int -> CommandBufferInheritanceInfo es -> ShowS

show :: CommandBufferInheritanceInfo es -> String

showList :: [CommandBufferInheritanceInfo es] -> ShowS

(Extendss CommandBufferInheritanceInfo es, PeekChain es) => FromCStruct (CommandBufferInheritanceInfo es)

Defined in Vulkan.Core10.CommandBuffer

Methods

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

(Extendss CommandBufferInheritanceInfo es, PokeChain es) => ToCStruct (CommandBufferInheritanceInfo es)

Defined in 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 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 framebuffer member of pInheritanceInfo must be either NULL_HANDLE, or a valid Framebuffer that is compatible with the renderPass member of pInheritanceInfo

• If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT and the renderPass member of pInheritanceInfo is not NULL_HANDLE, renderPass must be a valid RenderPass
• If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT and the renderPass member of pInheritanceInfo is not NULL_HANDLE, 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 and the renderPass member of pInheritanceInfo is NULL_HANDLE, the pNext chain of pInheritanceInfo must include a CommandBufferInheritanceRenderingInfoKHR structure
• If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the renderPass member of pInheritanceInfo is NULL_HANDLE, and the pNext chain of pInheritanceInfo includes a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, the colorAttachmentCount member of that structure must be equal to the value of CommandBufferInheritanceRenderingInfoKHR::colorAttachmentCount

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

VK_VERSION_1_0, CommandBufferInheritanceInfo, CommandBufferUsageFlags, StructureType, beginCommandBuffer

Constructors

CommandBufferBeginInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this 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 Vulkan.Core10.CommandBuffer

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). CommandBufferBeginInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). CommandBufferBeginInfo ds -> Chain es -> CommandBufferBeginInfo es

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

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

Defined in Vulkan.Core10.CommandBuffer

Methods

showsPrec :: Int -> CommandBufferBeginInfo es -> ShowS

show :: CommandBufferBeginInfo es -> String

showList :: [CommandBufferBeginInfo es] -> ShowS

(Extendss CommandBufferBeginInfo es, PeekChain es) => FromCStruct (CommandBufferBeginInfo es)

Defined in Vulkan.Core10.CommandBuffer

Methods

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

(Extendss CommandBufferBeginInfo es, PokeChain es) => ToCStruct (CommandBufferBeginInfo es)

Defined in 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 Vulkan.Core10.CommandBuffer

Methods

zero :: CommandBufferBeginInfo es

data CommandBuffer

VkCommandBuffer - Opaque handle to a command buffer object

See Also

VK_VERSION_1_0, CommandBufferSubmitInfoKHR, SubmitInfo, allocateCommandBuffers, beginCommandBuffer, cmdBeginConditionalRenderingEXT, cmdBeginDebugUtilsLabelEXT, cmdBeginQuery, cmdBeginQueryIndexedEXT, cmdBeginRenderPass, cmdBeginRenderPass2, cmdBeginRenderPass2KHR, cmdBeginRenderingKHR, cmdBeginTransformFeedbackEXT, vkCmdBeginVideoCodingKHR, cmdBindDescriptorSets, cmdBindIndexBuffer, cmdBindInvocationMaskHUAWEI, cmdBindPipeline, cmdBindPipelineShaderGroupNV, cmdBindShadingRateImageNV, cmdBindTransformFeedbackBuffersEXT, cmdBindVertexBuffers, cmdBindVertexBuffers2EXT, cmdBlitImage, cmdBlitImage2KHR, cmdBuildAccelerationStructureNV, cmdBuildAccelerationStructuresIndirectKHR, cmdBuildAccelerationStructuresKHR, cmdClearAttachments, cmdClearColorImage, cmdClearDepthStencilImage, vkCmdControlVideoCodingKHR, cmdCopyAccelerationStructureKHR, cmdCopyAccelerationStructureNV, cmdCopyAccelerationStructureToMemoryKHR, cmdCopyBuffer, cmdCopyBuffer2KHR, cmdCopyBufferToImage, cmdCopyBufferToImage2KHR, cmdCopyImage, cmdCopyImage2KHR, cmdCopyImageToBuffer, cmdCopyImageToBuffer2KHR, cmdCopyMemoryToAccelerationStructureKHR, cmdCopyQueryPoolResults, cmdCuLaunchKernelNVX, cmdDebugMarkerBeginEXT, cmdDebugMarkerEndEXT, cmdDebugMarkerInsertEXT, vkCmdDecodeVideoKHR, cmdDispatch, cmdDispatchBase, cmdDispatchBaseKHR, cmdDispatchIndirect, cmdDraw, cmdDrawIndexed, cmdDrawIndexedIndirect, cmdDrawIndexedIndirectCount, cmdDrawIndexedIndirectCountAMD, cmdDrawIndexedIndirectCountKHR, cmdDrawIndirect, cmdDrawIndirectByteCountEXT, cmdDrawIndirectCount, cmdDrawIndirectCountAMD, cmdDrawIndirectCountKHR, cmdDrawMeshTasksIndirectCountNV, cmdDrawMeshTasksIndirectNV, cmdDrawMeshTasksNV, cmdDrawMultiEXT, cmdDrawMultiIndexedEXT, vkCmdEncodeVideoKHR, cmdEndConditionalRenderingEXT, cmdEndDebugUtilsLabelEXT, cmdEndQuery, cmdEndQueryIndexedEXT, cmdEndRenderPass, cmdEndRenderPass2, cmdEndRenderPass2KHR, cmdEndRenderingKHR, cmdEndTransformFeedbackEXT, vkCmdEndVideoCodingKHR, cmdExecuteCommands, cmdExecuteGeneratedCommandsNV, cmdFillBuffer, cmdInsertDebugUtilsLabelEXT, cmdNextSubpass, cmdNextSubpass2, cmdNextSubpass2KHR, cmdPipelineBarrier, cmdPipelineBarrier2KHR, cmdPreprocessGeneratedCommandsNV, cmdPushConstants, cmdPushDescriptorSetKHR, cmdPushDescriptorSetWithTemplateKHR, cmdResetEvent, cmdResetEvent2KHR, cmdResetQueryPool, cmdResolveImage, cmdResolveImage2KHR, cmdSetBlendConstants, cmdSetCheckpointNV, cmdSetCoarseSampleOrderNV, cmdSetColorWriteEnableEXT, cmdSetCullModeEXT, cmdSetDepthBias, cmdSetDepthBiasEnableEXT, cmdSetDepthBounds, cmdSetDepthBoundsTestEnableEXT, cmdSetDepthCompareOpEXT, cmdSetDepthTestEnableEXT, cmdSetDepthWriteEnableEXT, cmdSetDeviceMask, cmdSetDeviceMaskKHR, cmdSetDiscardRectangleEXT, cmdSetEvent, cmdSetEvent2KHR, cmdSetExclusiveScissorNV, cmdSetFragmentShadingRateEnumNV, cmdSetFragmentShadingRateKHR, cmdSetFrontFaceEXT, cmdSetLineStippleEXT, cmdSetLineWidth, cmdSetLogicOpEXT, cmdSetPatchControlPointsEXT, cmdSetPerformanceMarkerINTEL, cmdSetPerformanceOverrideINTEL, cmdSetPerformanceStreamMarkerINTEL, cmdSetPrimitiveRestartEnableEXT, cmdSetPrimitiveTopologyEXT, cmdSetRasterizerDiscardEnableEXT, cmdSetRayTracingPipelineStackSizeKHR, cmdSetSampleLocationsEXT, cmdSetScissor, cmdSetScissorWithCountEXT, cmdSetStencilCompareMask, cmdSetStencilOpEXT, cmdSetStencilReference, cmdSetStencilTestEnableEXT, cmdSetStencilWriteMask, cmdSetVertexInputEXT, cmdSetViewport, cmdSetViewportShadingRatePaletteNV, cmdSetViewportWScalingNV, cmdSetViewportWithCountEXT, cmdSubpassShadingHUAWEI, cmdTraceRaysIndirectKHR, cmdTraceRaysKHR, cmdTraceRaysNV, cmdUpdateBuffer, cmdWaitEvents, cmdWaitEvents2KHR, cmdWriteAccelerationStructuresPropertiesKHR, cmdWriteAccelerationStructuresPropertiesNV, cmdWriteBufferMarker2AMD, cmdWriteBufferMarkerAMD, cmdWriteTimestamp, cmdWriteTimestamp2KHR, endCommandBuffer, freeCommandBuffers, resetCommandBuffer

Constructors

CommandBuffer

Fields

• commandBufferHandle :: Ptr CommandBuffer_T
• deviceCmds :: DeviceCmds

Instances

Eq CommandBuffer

Defined in Vulkan.Core10.Handles

Methods

(==) :: CommandBuffer -> CommandBuffer -> Bool

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

Show CommandBuffer

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> CommandBuffer -> ShowS

show :: CommandBuffer -> String

showList :: [CommandBuffer] -> ShowS

Zero CommandBuffer

Defined in Vulkan.Core10.Handles

Methods

zero :: CommandBuffer

HasObjectType CommandBuffer

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: CommandBuffer -> (ObjectType, Word64)

IsHandle CommandBuffer

Defined in Vulkan.Core10.Handles

newtype CommandBufferLevel

VkCommandBufferLevel - Enumerant specifying a command buffer level

See Also

VK_VERSION_1_0, CommandBufferAllocateInfo

Constructors

CommandBufferLevel Int32

Bundled Patterns

pattern COMMAND_BUFFER_LEVEL_PRIMARY :: CommandBufferLevel

COMMAND_BUFFER_LEVEL_PRIMARY specifies a primary command buffer.

pattern COMMAND_BUFFER_LEVEL_SECONDARY :: CommandBufferLevel

COMMAND_BUFFER_LEVEL_SECONDARY specifies a secondary command buffer.

Instances

Eq CommandBufferLevel

Defined in Vulkan.Core10.Enums.CommandBufferLevel

Methods

(==) :: CommandBufferLevel -> CommandBufferLevel -> Bool

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

Ord CommandBufferLevel

Defined in Vulkan.Core10.Enums.CommandBufferLevel

Methods

compare :: CommandBufferLevel -> CommandBufferLevel -> Ordering

(<) :: CommandBufferLevel -> CommandBufferLevel -> Bool

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

(>) :: CommandBufferLevel -> CommandBufferLevel -> Bool

(>=) :: CommandBufferLevel -> CommandBufferLevel -> Bool

max :: CommandBufferLevel -> CommandBufferLevel -> CommandBufferLevel

min :: CommandBufferLevel -> CommandBufferLevel -> CommandBufferLevel

Read CommandBufferLevel

Defined in Vulkan.Core10.Enums.CommandBufferLevel

Methods

readsPrec :: Int -> ReadS CommandBufferLevel

readList :: ReadS [CommandBufferLevel]

readPrec :: ReadPrec CommandBufferLevel

readListPrec :: ReadPrec [CommandBufferLevel]

Show CommandBufferLevel

Defined in Vulkan.Core10.Enums.CommandBufferLevel

Methods

showsPrec :: Int -> CommandBufferLevel -> ShowS

show :: CommandBufferLevel -> String

showList :: [CommandBufferLevel] -> ShowS

Storable CommandBufferLevel

Defined in Vulkan.Core10.Enums.CommandBufferLevel

Methods

sizeOf :: CommandBufferLevel -> Int

alignment :: CommandBufferLevel -> Int

peekElemOff :: Ptr CommandBufferLevel -> Int -> IO CommandBufferLevel

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

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

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

peek :: Ptr CommandBufferLevel -> IO CommandBufferLevel

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

Zero CommandBufferLevel

Defined in Vulkan.Core10.Enums.CommandBufferLevel

Methods

zero :: CommandBufferLevel

newtype QueryControlFlagBits

VkQueryControlFlagBits - Bitmask specifying constraints on a query

See Also

VK_VERSION_1_0, QueryControlFlags

Constructors

QueryControlFlagBits Flags

Bundled Patterns

pattern QUERY_CONTROL_PRECISE_BIT :: QueryControlFlagBits

QUERY_CONTROL_PRECISE_BIT specifies the precision of occlusion queries.

Instances

Eq QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

(==) :: QueryControlFlagBits -> QueryControlFlagBits -> Bool

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

Ord QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

compare :: QueryControlFlagBits -> QueryControlFlagBits -> Ordering

(<) :: QueryControlFlagBits -> QueryControlFlagBits -> Bool

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

(>) :: QueryControlFlagBits -> QueryControlFlagBits -> Bool

(>=) :: QueryControlFlagBits -> QueryControlFlagBits -> Bool

max :: QueryControlFlagBits -> QueryControlFlagBits -> QueryControlFlagBits

min :: QueryControlFlagBits -> QueryControlFlagBits -> QueryControlFlagBits

Read QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

readsPrec :: Int -> ReadS QueryControlFlagBits

readList :: ReadS [QueryControlFlagBits]

readPrec :: ReadPrec QueryControlFlagBits

readListPrec :: ReadPrec [QueryControlFlagBits]

Show QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

showsPrec :: Int -> QueryControlFlagBits -> ShowS

show :: QueryControlFlagBits -> String

showList :: [QueryControlFlagBits] -> ShowS

Storable QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

sizeOf :: QueryControlFlagBits -> Int

alignment :: QueryControlFlagBits -> Int

peekElemOff :: Ptr QueryControlFlagBits -> Int -> IO QueryControlFlagBits

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

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

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

peek :: Ptr QueryControlFlagBits -> IO QueryControlFlagBits

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

Bits QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

(.&.) :: QueryControlFlagBits -> QueryControlFlagBits -> QueryControlFlagBits

(.|.) :: QueryControlFlagBits -> QueryControlFlagBits -> QueryControlFlagBits

xor :: QueryControlFlagBits -> QueryControlFlagBits -> QueryControlFlagBits

complement :: QueryControlFlagBits -> QueryControlFlagBits

shift :: QueryControlFlagBits -> Int -> QueryControlFlagBits

rotate :: QueryControlFlagBits -> Int -> QueryControlFlagBits

zeroBits :: QueryControlFlagBits

bit :: Int -> QueryControlFlagBits

setBit :: QueryControlFlagBits -> Int -> QueryControlFlagBits

clearBit :: QueryControlFlagBits -> Int -> QueryControlFlagBits

complementBit :: QueryControlFlagBits -> Int -> QueryControlFlagBits

testBit :: QueryControlFlagBits -> Int -> Bool

bitSizeMaybe :: QueryControlFlagBits -> Maybe Int

bitSize :: QueryControlFlagBits -> Int

isSigned :: QueryControlFlagBits -> Bool

shiftL :: QueryControlFlagBits -> Int -> QueryControlFlagBits

unsafeShiftL :: QueryControlFlagBits -> Int -> QueryControlFlagBits

shiftR :: QueryControlFlagBits -> Int -> QueryControlFlagBits

unsafeShiftR :: QueryControlFlagBits -> Int -> QueryControlFlagBits

rotateL :: QueryControlFlagBits -> Int -> QueryControlFlagBits

rotateR :: QueryControlFlagBits -> Int -> QueryControlFlagBits

popCount :: QueryControlFlagBits -> Int

FiniteBits QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

finiteBitSize :: QueryControlFlagBits -> Int

countLeadingZeros :: QueryControlFlagBits -> Int

countTrailingZeros :: QueryControlFlagBits -> Int

Zero QueryControlFlagBits

Defined in Vulkan.Core10.Enums.QueryControlFlagBits

Methods

zero :: QueryControlFlagBits

type QueryControlFlags = QueryControlFlagBits

newtype CommandBufferUsageFlagBits

VkCommandBufferUsageFlagBits - Bitmask specifying usage behavior for command buffer

See Also

VK_VERSION_1_0, CommandBufferUsageFlags

Constructors

CommandBufferUsageFlagBits Flags

Bundled Patterns

pattern COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT :: CommandBufferUsageFlagBits

COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT specifies that each recording of the command buffer will only be submitted once, and the command buffer will be reset and recorded again between each submission.

pattern COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT :: CommandBufferUsageFlagBits

COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT specifies that a secondary command buffer is considered to be entirely inside a render pass. If this is a primary command buffer, then this bit is ignored.

pattern COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT :: CommandBufferUsageFlagBits

COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT specifies that a command buffer can be resubmitted to a queue while it is in the /pending state/, and recorded into multiple primary command buffers.

Instances

Eq CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

(==) :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> Bool

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

Ord CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

compare :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> Ordering

(<) :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> Bool

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

(>) :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> Bool

(>=) :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> Bool

max :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits

min :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits

Read CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

readsPrec :: Int -> ReadS CommandBufferUsageFlagBits

readList :: ReadS [CommandBufferUsageFlagBits]

readPrec :: ReadPrec CommandBufferUsageFlagBits

readListPrec :: ReadPrec [CommandBufferUsageFlagBits]

Show CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

showsPrec :: Int -> CommandBufferUsageFlagBits -> ShowS

show :: CommandBufferUsageFlagBits -> String

showList :: [CommandBufferUsageFlagBits] -> ShowS

Storable CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

sizeOf :: CommandBufferUsageFlagBits -> Int

alignment :: CommandBufferUsageFlagBits -> Int

peekElemOff :: Ptr CommandBufferUsageFlagBits -> Int -> IO CommandBufferUsageFlagBits

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

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

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

peek :: Ptr CommandBufferUsageFlagBits -> IO CommandBufferUsageFlagBits

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

Bits CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

(.&.) :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits

(.|.) :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits

xor :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits

complement :: CommandBufferUsageFlagBits -> CommandBufferUsageFlagBits

shift :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

rotate :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

zeroBits :: CommandBufferUsageFlagBits

bit :: Int -> CommandBufferUsageFlagBits

setBit :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

clearBit :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

complementBit :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

testBit :: CommandBufferUsageFlagBits -> Int -> Bool

bitSizeMaybe :: CommandBufferUsageFlagBits -> Maybe Int

bitSize :: CommandBufferUsageFlagBits -> Int

isSigned :: CommandBufferUsageFlagBits -> Bool

shiftL :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

unsafeShiftL :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

shiftR :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

unsafeShiftR :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

rotateL :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

rotateR :: CommandBufferUsageFlagBits -> Int -> CommandBufferUsageFlagBits

popCount :: CommandBufferUsageFlagBits -> Int

FiniteBits CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

finiteBitSize :: CommandBufferUsageFlagBits -> Int

countLeadingZeros :: CommandBufferUsageFlagBits -> Int

countTrailingZeros :: CommandBufferUsageFlagBits -> Int

Zero CommandBufferUsageFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferUsageFlagBits

Methods

zero :: CommandBufferUsageFlagBits

type CommandBufferUsageFlags = CommandBufferUsageFlagBits

newtype CommandBufferResetFlagBits

VkCommandBufferResetFlagBits - Bitmask controlling behavior of a command buffer reset

See Also

VK_VERSION_1_0, CommandBufferResetFlags

Constructors

CommandBufferResetFlagBits Flags

Bundled Patterns

pattern COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT :: CommandBufferResetFlagBits

COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT specifies that most or all memory resources currently owned by the command buffer should be returned to the parent command pool. If this flag is not set, then the command buffer may hold onto memory resources and reuse them when recording commands. commandBuffer is moved to the initial state.

Instances

Eq CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

(==) :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool

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

Ord CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

compare :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Ordering

(<) :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool

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

(>) :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool

(>=) :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool

max :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits

min :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits

Read CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

readsPrec :: Int -> ReadS CommandBufferResetFlagBits

readList :: ReadS [CommandBufferResetFlagBits]

readPrec :: ReadPrec CommandBufferResetFlagBits

readListPrec :: ReadPrec [CommandBufferResetFlagBits]

Show CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

showsPrec :: Int -> CommandBufferResetFlagBits -> ShowS

show :: CommandBufferResetFlagBits -> String

showList :: [CommandBufferResetFlagBits] -> ShowS

Storable CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

sizeOf :: CommandBufferResetFlagBits -> Int

alignment :: CommandBufferResetFlagBits -> Int

peekElemOff :: Ptr CommandBufferResetFlagBits -> Int -> IO CommandBufferResetFlagBits

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

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

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

peek :: Ptr CommandBufferResetFlagBits -> IO CommandBufferResetFlagBits

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

Bits CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

(.&.) :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits

(.|.) :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits

xor :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits

complement :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits

shift :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

rotate :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

zeroBits :: CommandBufferResetFlagBits

bit :: Int -> CommandBufferResetFlagBits

setBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

clearBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

complementBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

testBit :: CommandBufferResetFlagBits -> Int -> Bool

bitSizeMaybe :: CommandBufferResetFlagBits -> Maybe Int

bitSize :: CommandBufferResetFlagBits -> Int

isSigned :: CommandBufferResetFlagBits -> Bool

shiftL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

unsafeShiftL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

shiftR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

unsafeShiftR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

rotateL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

rotateR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits

popCount :: CommandBufferResetFlagBits -> Int

FiniteBits CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

finiteBitSize :: CommandBufferResetFlagBits -> Int

countLeadingZeros :: CommandBufferResetFlagBits -> Int

countTrailingZeros :: CommandBufferResetFlagBits -> Int

Zero CommandBufferResetFlagBits

Defined in Vulkan.Core10.Enums.CommandBufferResetFlagBits

Methods

zero :: CommandBufferResetFlagBits

type CommandBufferResetFlags = CommandBufferResetFlagBits