Vulkan.Core10.CommandPool

Documentation

createCommandPool

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that creates the command pool.

-> CommandPoolCreateInfo

pCreateInfo is a pointer to a CommandPoolCreateInfo structure specifying the state of the command pool object.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io CommandPool

vkCreateCommandPool - Create a new command pool object

Valid Usage

• pCreateInfo->queueFamilyIndex must be the index of a queue family available in the logical device device

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid CommandPoolCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pCommandPool must be a valid pointer to a CommandPool handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, CommandPool, CommandPoolCreateInfo, Device

withCommandPool :: forall io r. MonadIO io => Device -> CommandPoolCreateInfo -> Maybe AllocationCallbacks -> (io CommandPool -> (CommandPool -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createCommandPool and destroyCommandPool

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

destroyCommandPool

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the command pool.

-> CommandPool

commandPool is the handle of the command pool to destroy.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io ()

vkDestroyCommandPool - Destroy a command pool object

Description

When a pool is destroyed, all command buffers allocated from the pool are freed.

Any primary command buffer allocated from another CommandPool that is in the recording or executable state and has a secondary command buffer allocated from commandPool recorded into it, becomes invalid.

Valid Usage

• All CommandBuffer objects allocated from commandPool must not be in the pending state

• If AllocationCallbacks were provided when commandPool was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when commandPool was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If commandPool is not NULL_HANDLE, commandPool must be a valid CommandPool handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If commandPool is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to commandPool must be externally synchronized

See Also

AllocationCallbacks, CommandPool, Device

resetCommandPool

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the command pool.

-> CommandPool

commandPool is the command pool to reset.

-> CommandPoolResetFlags

flags is a bitmask of CommandPoolResetFlagBits controlling the reset operation.

-> io ()

vkResetCommandPool - Reset a command pool

Description

Resetting a command pool recycles all of the resources from all of the command buffers allocated from the command pool back to the command pool. All command buffers that have been allocated from the command pool are put in the initial state.

Any primary command buffer allocated from another CommandPool that is in the recording or executable state and has a secondary command buffer allocated from commandPool recorded into it, becomes invalid.

Valid Usage

• All CommandBuffer objects allocated from commandPool must not be in the pending state

Valid Usage (Implicit)

• device must be a valid Device handle

• commandPool must be a valid CommandPool handle
• flags must be a valid combination of CommandPoolResetFlagBits values
• commandPool must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to commandPool must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CommandPool, CommandPoolResetFlags, Device

data CommandPoolCreateInfo

VkCommandPoolCreateInfo - Structure specifying parameters of a newly created command pool

Valid Usage

• If the protected memory feature is not enabled, the COMMAND_POOL_CREATE_PROTECTED_BIT bit of flags must not be set

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO

• pNext must be NULL
• flags must be a valid combination of CommandPoolCreateFlagBits values

See Also

CommandPoolCreateFlags, StructureType, createCommandPool

Constructors

CommandPoolCreateInfo

Fields

• flags :: CommandPoolCreateFlags

  flags is a bitmask of CommandPoolCreateFlagBits indicating usage behavior for the pool and command buffers allocated from it.

• queueFamilyIndex :: Word32

  queueFamilyIndex designates a queue family as described in section Queue Family Properties. All command buffers allocated from this command pool must be submitted on queues from the same queue family.

Instances

Eq CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

Methods

(==) :: CommandPoolCreateInfo -> CommandPoolCreateInfo -> Bool

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

Show CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

Methods

showsPrec :: Int -> CommandPoolCreateInfo -> ShowS

show :: CommandPoolCreateInfo -> String

showList :: [CommandPoolCreateInfo] -> ShowS

Generic CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

Associated Types

type Rep CommandPoolCreateInfo :: Type -> Type

Methods

from :: CommandPoolCreateInfo -> Rep CommandPoolCreateInfo x

to :: Rep CommandPoolCreateInfo x -> CommandPoolCreateInfo

Storable CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

Methods

sizeOf :: CommandPoolCreateInfo -> Int

alignment :: CommandPoolCreateInfo -> Int

peekElemOff :: Ptr CommandPoolCreateInfo -> Int -> IO CommandPoolCreateInfo

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

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

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

peek :: Ptr CommandPoolCreateInfo -> IO CommandPoolCreateInfo

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

FromCStruct CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

Methods

peekCStruct :: Ptr CommandPoolCreateInfo -> IO CommandPoolCreateInfo

ToCStruct CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

Methods

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

pokeCStruct :: Ptr CommandPoolCreateInfo -> CommandPoolCreateInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CommandPoolCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

Methods

zero :: CommandPoolCreateInfo

type Rep CommandPoolCreateInfo

Defined in Vulkan.Core10.CommandPool

type Rep CommandPoolCreateInfo = D1 ('MetaData "CommandPoolCreateInfo" "Vulkan.Core10.CommandPool" "vulkan-3.4-inplace" 'False) (C1 ('MetaCons "CommandPoolCreateInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommandPoolCreateFlags) :*: S1 ('MetaSel ('Just "queueFamilyIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))

newtype CommandPool

VkCommandPool - Opaque handle to a command pool object

See Also

CommandBufferAllocateInfo, createCommandPool, destroyCommandPool, freeCommandBuffers, resetCommandPool, trimCommandPool, trimCommandPoolKHR

Constructors

CommandPool Word64

Instances

Eq CommandPool

Defined in Vulkan.Core10.Handles

Methods

(==) :: CommandPool -> CommandPool -> Bool

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

Ord CommandPool

Defined in Vulkan.Core10.Handles

Methods

compare :: CommandPool -> CommandPool -> Ordering

(<) :: CommandPool -> CommandPool -> Bool

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

(>) :: CommandPool -> CommandPool -> Bool

(>=) :: CommandPool -> CommandPool -> Bool

max :: CommandPool -> CommandPool -> CommandPool

min :: CommandPool -> CommandPool -> CommandPool

Show CommandPool

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> CommandPool -> ShowS

show :: CommandPool -> String

showList :: [CommandPool] -> ShowS

Storable CommandPool

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: CommandPool -> Int

alignment :: CommandPool -> Int

peekElemOff :: Ptr CommandPool -> Int -> IO CommandPool

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

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

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

peek :: Ptr CommandPool -> IO CommandPool

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

Zero CommandPool

Defined in Vulkan.Core10.Handles

Methods

zero :: CommandPool

HasObjectType CommandPool

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: CommandPool -> (ObjectType, Word64)

IsHandle CommandPool

Defined in Vulkan.Core10.Handles

newtype CommandPoolCreateFlagBits

VkCommandPoolCreateFlagBits - Bitmask specifying usage behavior for a command pool

See Also

CommandPoolCreateFlags

Constructors

CommandPoolCreateFlagBits Flags

Bundled Patterns

pattern COMMAND_POOL_CREATE_TRANSIENT_BIT :: CommandPoolCreateFlagBits

COMMAND_POOL_CREATE_TRANSIENT_BIT specifies that command buffers allocated from the pool will be short-lived, meaning that they will be reset or freed in a relatively short timeframe. This flag may be used by the implementation to control memory allocation behavior within the pool.

pattern COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT :: CommandPoolCreateFlagBits

COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT allows any command buffer allocated from a pool to be individually reset to the initial state; either by calling resetCommandBuffer, or via the implicit reset when calling beginCommandBuffer. If this flag is not set on a pool, then resetCommandBuffer must not be called for any command buffer allocated from that pool.

pattern COMMAND_POOL_CREATE_PROTECTED_BIT :: CommandPoolCreateFlagBits

COMMAND_POOL_CREATE_PROTECTED_BIT specifies that command buffers allocated from the pool are protected command buffers.

Instances

Eq CommandPoolCreateFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolCreateFlagBits

Methods

(==) :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> Bool

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

Ord CommandPoolCreateFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolCreateFlagBits

Methods

compare :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> Ordering

(<) :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> Bool

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

(>) :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> Bool

(>=) :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> Bool

max :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits

min :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits

Read CommandPoolCreateFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolCreateFlagBits

Methods

readsPrec :: Int -> ReadS CommandPoolCreateFlagBits

readList :: ReadS [CommandPoolCreateFlagBits]

readPrec :: ReadPrec CommandPoolCreateFlagBits

readListPrec :: ReadPrec [CommandPoolCreateFlagBits]

Show CommandPoolCreateFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolCreateFlagBits

Methods

showsPrec :: Int -> CommandPoolCreateFlagBits -> ShowS

show :: CommandPoolCreateFlagBits -> String

showList :: [CommandPoolCreateFlagBits] -> ShowS

Storable CommandPoolCreateFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolCreateFlagBits

Methods

sizeOf :: CommandPoolCreateFlagBits -> Int

alignment :: CommandPoolCreateFlagBits -> Int

peekElemOff :: Ptr CommandPoolCreateFlagBits -> Int -> IO CommandPoolCreateFlagBits

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

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

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

peek :: Ptr CommandPoolCreateFlagBits -> IO CommandPoolCreateFlagBits

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

Bits CommandPoolCreateFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolCreateFlagBits

Methods

(.&.) :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits

(.|.) :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits

xor :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits

complement :: CommandPoolCreateFlagBits -> CommandPoolCreateFlagBits

shift :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

rotate :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

zeroBits :: CommandPoolCreateFlagBits

bit :: Int -> CommandPoolCreateFlagBits

setBit :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

clearBit :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

complementBit :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

testBit :: CommandPoolCreateFlagBits -> Int -> Bool

bitSizeMaybe :: CommandPoolCreateFlagBits -> Maybe Int

bitSize :: CommandPoolCreateFlagBits -> Int

isSigned :: CommandPoolCreateFlagBits -> Bool

shiftL :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

unsafeShiftL :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

shiftR :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

unsafeShiftR :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

rotateL :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

rotateR :: CommandPoolCreateFlagBits -> Int -> CommandPoolCreateFlagBits

popCount :: CommandPoolCreateFlagBits -> Int

Zero CommandPoolCreateFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolCreateFlagBits

Methods

zero :: CommandPoolCreateFlagBits

type CommandPoolCreateFlags = CommandPoolCreateFlagBits

newtype CommandPoolResetFlagBits

VkCommandPoolResetFlagBits - Bitmask controlling behavior of a command pool reset

See Also

CommandPoolResetFlags

Constructors

CommandPoolResetFlagBits Flags

Bundled Patterns

pattern COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT :: CommandPoolResetFlagBits

COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT specifies that resetting a command pool recycles all of the resources from the command pool back to the system.

Instances

Eq CommandPoolResetFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolResetFlagBits

Methods

(==) :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> Bool

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

Ord CommandPoolResetFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolResetFlagBits

Methods

compare :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> Ordering

(<) :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> Bool

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

(>) :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> Bool

(>=) :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> Bool

max :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> CommandPoolResetFlagBits

min :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> CommandPoolResetFlagBits

Read CommandPoolResetFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolResetFlagBits

Methods

readsPrec :: Int -> ReadS CommandPoolResetFlagBits

readList :: ReadS [CommandPoolResetFlagBits]

readPrec :: ReadPrec CommandPoolResetFlagBits

readListPrec :: ReadPrec [CommandPoolResetFlagBits]

Show CommandPoolResetFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolResetFlagBits

Methods

showsPrec :: Int -> CommandPoolResetFlagBits -> ShowS

show :: CommandPoolResetFlagBits -> String

showList :: [CommandPoolResetFlagBits] -> ShowS

Storable CommandPoolResetFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolResetFlagBits

Methods

sizeOf :: CommandPoolResetFlagBits -> Int

alignment :: CommandPoolResetFlagBits -> Int

peekElemOff :: Ptr CommandPoolResetFlagBits -> Int -> IO CommandPoolResetFlagBits

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

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

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

peek :: Ptr CommandPoolResetFlagBits -> IO CommandPoolResetFlagBits

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

Bits CommandPoolResetFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolResetFlagBits

Methods

(.&.) :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> CommandPoolResetFlagBits

(.|.) :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> CommandPoolResetFlagBits

xor :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits -> CommandPoolResetFlagBits

complement :: CommandPoolResetFlagBits -> CommandPoolResetFlagBits

shift :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

rotate :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

zeroBits :: CommandPoolResetFlagBits

bit :: Int -> CommandPoolResetFlagBits

setBit :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

clearBit :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

complementBit :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

testBit :: CommandPoolResetFlagBits -> Int -> Bool

bitSizeMaybe :: CommandPoolResetFlagBits -> Maybe Int

bitSize :: CommandPoolResetFlagBits -> Int

isSigned :: CommandPoolResetFlagBits -> Bool

shiftL :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

unsafeShiftL :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

shiftR :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

unsafeShiftR :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

rotateL :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

rotateR :: CommandPoolResetFlagBits -> Int -> CommandPoolResetFlagBits

popCount :: CommandPoolResetFlagBits -> Int

Zero CommandPoolResetFlagBits

Defined in Vulkan.Core10.Enums.CommandPoolResetFlagBits

Methods

zero :: CommandPoolResetFlagBits

type CommandPoolResetFlags = CommandPoolResetFlagBits