Vulkan.Core10.Buffer

Documentation

createBuffer

Arguments

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

=> Device

device is the logical device that creates the buffer object.

-> BufferCreateInfo a

pCreateInfo is a pointer to a BufferCreateInfo structure containing parameters affecting creation of the buffer.

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

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

-> io Buffer

vkCreateBuffer - Create a new buffer object

Valid Usage

• If the flags member of pCreateInfo includes BUFFER_CREATE_SPARSE_BINDING_BIT, creating this Buffer must not cause the total required sparse memory for all currently valid sparse resources on the device to exceed PhysicalDeviceLimits::sparseAddressSpaceSize

• If using the Buffer for an import operation from a BufferCollectionFUCHSIA where a BufferCollectionBufferCreateInfoFUCHSIA has been chained to pNext, pCreateInfo must match the BufferConstraintsInfoFUCHSIA::createInfo used when setting the constraints on the buffer collection with setBufferCollectionBufferConstraintsFUCHSIA

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid BufferCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pBuffer must be a valid pointer to a Buffer handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

See Also

VK_VERSION_1_0, AllocationCallbacks, Buffer, BufferCreateInfo, Device

withBuffer :: forall a io r. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Device -> BufferCreateInfo a -> Maybe AllocationCallbacks -> (io Buffer -> (Buffer -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createBuffer and destroyBuffer

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

destroyBuffer

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the buffer.

-> Buffer

buffer is the buffer to destroy.

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

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

-> io ()

vkDestroyBuffer - Destroy a buffer object

Valid Usage

• All submitted commands that refer to buffer, either directly or via a BufferView, must have completed execution

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

Valid Usage (Implicit)

• device must be a valid Device handle

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

Host Synchronization

• Host access to buffer must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, Buffer, Device

data BufferCreateInfo (es :: [Type])

VkBufferCreateInfo - Structure specifying the parameters of a newly created buffer object

Valid Usage

• size must be greater than 0

• If sharingMode is SHARING_MODE_CONCURRENT, pQueueFamilyIndices must be a valid pointer to an array of queueFamilyIndexCount uint32_t values
• If sharingMode is SHARING_MODE_CONCURRENT, queueFamilyIndexCount must be greater than 1
• If sharingMode is SHARING_MODE_CONCURRENT, each element of pQueueFamilyIndices must be unique and must be less than pQueueFamilyPropertyCount returned by either getPhysicalDeviceQueueFamilyProperties or getPhysicalDeviceQueueFamilyProperties2 for the physicalDevice that was used to create device
• If the sparseBinding feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_BINDING_BIT
• If the sparseResidencyBuffer feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_RESIDENCY_BIT
• If the sparseResidencyAliased feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_ALIASED_BIT
• If flags contains BUFFER_CREATE_SPARSE_RESIDENCY_BIT or BUFFER_CREATE_SPARSE_ALIASED_BIT, it must also contain BUFFER_CREATE_SPARSE_BINDING_BIT
• If the pNext chain includes a ExternalMemoryBufferCreateInfo structure, its handleTypes member must only contain bits that are also in ExternalBufferProperties::externalMemoryProperties.compatibleHandleTypes, as returned by getPhysicalDeviceExternalBufferProperties with pExternalBufferInfo->handleType equal to any one of the handle types specified in ExternalMemoryBufferCreateInfo::handleTypes
• If the protectedMemory feature is not enabled, flags must not contain BUFFER_CREATE_PROTECTED_BIT
• If any of the bits BUFFER_CREATE_SPARSE_BINDING_BIT, BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or BUFFER_CREATE_SPARSE_ALIASED_BIT are set, BUFFER_CREATE_PROTECTED_BIT must not also be set
• If the pNext chain includes a DedicatedAllocationBufferCreateInfoNV structure, and the dedicatedAllocation member of the chained structure is TRUE, then flags must not include BUFFER_CREATE_SPARSE_BINDING_BIT, BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or BUFFER_CREATE_SPARSE_ALIASED_BIT
• If BufferDeviceAddressCreateInfoEXT::deviceAddress is not zero, flags must include BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT
• If BufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress is not zero, flags must include BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT
• If flags includes BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT, the bufferDeviceAddressCaptureReplay or bufferDeviceAddressCaptureReplayEXT feature must be enabled
• If usage includes VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR or VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR, then the pNext chain must include a VkVideoProfileListInfoKHR structure with profileCount greater than 0 and pProfiles including at least one VkVideoProfileInfoKHR structure with a videoCodecOperation member specifying a decode operation
• If usage includes VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR or VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR, then the pNext chain must include a VkVideoProfileListInfoKHR structure with profileCount greater than 0 and pProfiles including at least one VkVideoProfileInfoKHR structure with a videoCodecOperation member specifying an encode operation
• size must be less than or equal to PhysicalDeviceMaintenance4Properties::maxBufferSize
• If usage includes BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT, creating this Buffer must not cause the total required space for all currently valid buffers using this flag on the device to exceed VkPhysicalDeviceDescriptorBufferPropertiesEXT::samplerDescriptorBufferAddressSpaceSize or VkPhysicalDeviceDescriptorBufferPropertiesEXT::descriptorBufferAddressSpaceSize
• If usage includes BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT, creating this Buffer must not cause the total required space for all currently valid buffers using this flag on the device to exceed VkPhysicalDeviceDescriptorBufferPropertiesEXT::resourceDescriptorBufferAddressSpaceSize or VkPhysicalDeviceDescriptorBufferPropertiesEXT::descriptorBufferAddressSpaceSize
• If flags includes BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT, the descriptorBufferCaptureReplay feature must be enabled
• If the pNext chain includes a OpaqueCaptureDescriptorDataCreateInfoEXT structure, flags must contain BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT
• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, the descriptorBufferPushDescriptors feature must be enabled
• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT ::bufferlessPushDescriptors must be FALSE
• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, usage must contain at least one of BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT or BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_CREATE_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 BufferCollectionBufferCreateInfoFUCHSIA, BufferDeviceAddressCreateInfoEXT, BufferOpaqueCaptureAddressCreateInfo, DedicatedAllocationBufferCreateInfoNV, ExternalMemoryBufferCreateInfo, OpaqueCaptureDescriptorDataCreateInfoEXT, or VkVideoProfileListInfoKHR
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of BufferCreateFlagBits values
• usage must be a valid combination of BufferUsageFlagBits values
• usage must not be 0
• sharingMode must be a valid SharingMode value

See Also

VK_VERSION_1_0, BufferConstraintsInfoFUCHSIA, BufferCreateFlags, BufferUsageFlags, DeviceBufferMemoryRequirements, DeviceSize, SharingMode, StructureType, createBuffer

Constructors

BufferCreateInfo

Fields

• next :: Chain es

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

• flags :: BufferCreateFlags

  flags is a bitmask of BufferCreateFlagBits specifying additional parameters of the buffer.

• size :: DeviceSize

  size is the size in bytes of the buffer to be created.

• usage :: BufferUsageFlags

  usage is a bitmask of BufferUsageFlagBits specifying allowed usages of the buffer.

• sharingMode :: SharingMode

  sharingMode is a SharingMode value specifying the sharing mode of the buffer when it will be accessed by multiple queue families.

• queueFamilyIndices :: Vector Word32

  pQueueFamilyIndices is a pointer to an array of queue families that will access this buffer. It is ignored if sharingMode is not SHARING_MODE_CONCURRENT.

Instances

Extensible BufferCreateInfo

Defined in Vulkan.Core10.Buffer

Methods

extensibleTypeName :: String

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

setNext :: forall (ds :: [Type]) (es :: [TYPE LiftedRep]). BufferCreateInfo ds -> Chain es -> BufferCreateInfo es

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

Show (Chain es) => Show (BufferCreateInfo es)

Defined in Vulkan.Core10.Buffer

Methods

showsPrec :: Int -> BufferCreateInfo es -> ShowS

show :: BufferCreateInfo es -> String

showList :: [BufferCreateInfo es] -> ShowS

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

Defined in Vulkan.Core10.Buffer

Methods

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

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

Defined in Vulkan.Core10.Buffer

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (BufferCreateInfo es)

Defined in Vulkan.Core10.Buffer

Methods

zero :: BufferCreateInfo es

newtype Buffer

VkBuffer - Opaque handle to a buffer object

See Also

VK_VERSION_1_0, AccelerationStructureCreateInfoKHR, BindBufferMemoryInfo, BufferCaptureDescriptorDataInfoEXT, BufferDeviceAddressInfo, BufferMemoryBarrier, BufferMemoryBarrier2, BufferMemoryRequirementsInfo2, BufferViewCreateInfo, ConditionalRenderingBeginInfoEXT, CopyBufferInfo2, CopyBufferToImageInfo2, CopyImageToBufferInfo2, DedicatedAllocationMemoryAllocateInfoNV, DescriptorBufferBindingPushDescriptorBufferHandleEXT, DescriptorBufferInfo, GeneratedCommandsInfoNV, GeometryAABBNV, GeometryTrianglesNV, IndirectCommandsStreamNV, MemoryDedicatedAllocateInfo, MicromapCreateInfoEXT, SparseBufferMemoryBindInfo, VkVideoDecodeInfoKHR, VkVideoEncodeInfoKHR, bindBufferMemory, cmdBeginTransformFeedbackEXT, cmdBindIndexBuffer, cmdBindTransformFeedbackBuffersEXT, cmdBindVertexBuffers, cmdBindVertexBuffers2, cmdBindVertexBuffers2EXT, cmdBuildAccelerationStructureNV, cmdCopyBuffer, cmdCopyBufferToImage, cmdCopyImageToBuffer, cmdCopyQueryPoolResults, cmdDispatchIndirect, cmdDrawClusterIndirectHUAWEI, cmdDrawIndexedIndirect, cmdDrawIndexedIndirectCount, cmdDrawIndexedIndirectCountAMD, cmdDrawIndexedIndirectCountKHR, cmdDrawIndirect, cmdDrawIndirectByteCountEXT, cmdDrawIndirectCount, cmdDrawIndirectCountAMD, cmdDrawIndirectCountKHR, cmdDrawMeshTasksIndirectCountEXT, cmdDrawMeshTasksIndirectCountNV, cmdDrawMeshTasksIndirectEXT, cmdDrawMeshTasksIndirectNV, cmdEndTransformFeedbackEXT, cmdFillBuffer, cmdTraceRaysNV, cmdUpdateBuffer, cmdWriteBufferMarker2AMD, cmdWriteBufferMarkerAMD, createBuffer, destroyBuffer, getBufferMemoryRequirements

Constructors

Buffer Word64

Instances

Storable Buffer

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: Buffer -> Int

alignment :: Buffer -> Int

peekElemOff :: Ptr Buffer -> Int -> IO Buffer

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

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

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

peek :: Ptr Buffer -> IO Buffer

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

Show Buffer

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> Buffer -> ShowS

show :: Buffer -> String

showList :: [Buffer] -> ShowS

Eq Buffer

Defined in Vulkan.Core10.Handles

Methods

(==) :: Buffer -> Buffer -> Bool

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

Ord Buffer

Defined in Vulkan.Core10.Handles

Methods

compare :: Buffer -> Buffer -> Ordering

(<) :: Buffer -> Buffer -> Bool

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

(>) :: Buffer -> Buffer -> Bool

(>=) :: Buffer -> Buffer -> Bool

max :: Buffer -> Buffer -> Buffer

min :: Buffer -> Buffer -> Buffer

HasObjectType Buffer

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: Buffer -> (ObjectType, Word64)

IsHandle Buffer

Defined in Vulkan.Core10.Handles

Zero Buffer

Defined in Vulkan.Core10.Handles

Methods

zero :: Buffer

newtype SharingMode

VkSharingMode - Buffer and image sharing modes

Description

Note

SHARING_MODE_CONCURRENT may result in lower performance access to the buffer or image than SHARING_MODE_EXCLUSIVE.

Ranges of buffers and image subresources of image objects created using SHARING_MODE_EXCLUSIVE must only be accessed by queues in the queue family that has ownership of the resource. Upon creation, such resources are not owned by any queue family; ownership is implicitly acquired upon first use within a queue. Once a resource using SHARING_MODE_EXCLUSIVE is owned by some queue family, the application must perform a queue family ownership transfer to make the memory contents of a range or image subresource accessible to a different queue family.

Note

Images still require a layout transition from IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED before being used on the first queue.

A queue family can take ownership of an image subresource or buffer range of a resource created with SHARING_MODE_EXCLUSIVE, without an ownership transfer, in the same way as for a resource that was just created; however, taking ownership in this way has the effect that the contents of the image subresource or buffer range are undefined.

Ranges of buffers and image subresources of image objects created using SHARING_MODE_CONCURRENT must only be accessed by queues from the queue families specified through the queueFamilyIndexCount and pQueueFamilyIndices members of the corresponding create info structures.

See Also

VK_VERSION_1_0, BufferCreateInfo, ImageCreateInfo, PhysicalDeviceImageDrmFormatModifierInfoEXT, SwapchainCreateInfoKHR

Constructors

SharingMode Int32

Bundled Patterns

pattern SHARING_MODE_EXCLUSIVE :: SharingMode

SHARING_MODE_EXCLUSIVE specifies that access to any range or image subresource of the object will be exclusive to a single queue family at a time.

pattern SHARING_MODE_CONCURRENT :: SharingMode

SHARING_MODE_CONCURRENT specifies that concurrent access to any range or image subresource of the object from multiple queue families is supported.

Instances

Storable SharingMode

Defined in Vulkan.Core10.Enums.SharingMode

Methods

sizeOf :: SharingMode -> Int

alignment :: SharingMode -> Int

peekElemOff :: Ptr SharingMode -> Int -> IO SharingMode

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

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

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

peek :: Ptr SharingMode -> IO SharingMode

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

Read SharingMode

Defined in Vulkan.Core10.Enums.SharingMode

Methods

readsPrec :: Int -> ReadS SharingMode

readList :: ReadS [SharingMode]

readPrec :: ReadPrec SharingMode

readListPrec :: ReadPrec [SharingMode]

Show SharingMode

Defined in Vulkan.Core10.Enums.SharingMode

Methods

showsPrec :: Int -> SharingMode -> ShowS

show :: SharingMode -> String

showList :: [SharingMode] -> ShowS

Eq SharingMode

Defined in Vulkan.Core10.Enums.SharingMode

Methods

(==) :: SharingMode -> SharingMode -> Bool

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

Ord SharingMode

Defined in Vulkan.Core10.Enums.SharingMode

Methods

compare :: SharingMode -> SharingMode -> Ordering

(<) :: SharingMode -> SharingMode -> Bool

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

(>) :: SharingMode -> SharingMode -> Bool

(>=) :: SharingMode -> SharingMode -> Bool

max :: SharingMode -> SharingMode -> SharingMode

min :: SharingMode -> SharingMode -> SharingMode

Zero SharingMode

Defined in Vulkan.Core10.Enums.SharingMode

Methods

zero :: SharingMode

newtype BufferUsageFlagBits

VkBufferUsageFlagBits - Bitmask specifying allowed usage of a buffer

See Also

VK_VERSION_1_0, BufferUsageFlags

Constructors

BufferUsageFlagBits Flags

Bundled Patterns

pattern BUFFER_USAGE_TRANSFER_SRC_BIT :: BufferUsageFlagBits

BUFFER_USAGE_TRANSFER_SRC_BIT specifies that the buffer can be used as the source of a transfer command (see the definition of https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#synchronization-pipeline-stages-transfer).

pattern BUFFER_USAGE_TRANSFER_DST_BIT :: BufferUsageFlagBits

BUFFER_USAGE_TRANSFER_DST_BIT specifies that the buffer can be used as the destination of a transfer command.

pattern BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT :: BufferUsageFlagBits

BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT specifies that the buffer can be used to create a BufferView suitable for occupying a DescriptorSet slot of type DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER.

pattern BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT :: BufferUsageFlagBits

BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT specifies that the buffer can be used to create a BufferView suitable for occupying a DescriptorSet slot of type DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER.

pattern BUFFER_USAGE_UNIFORM_BUFFER_BIT :: BufferUsageFlagBits

BUFFER_USAGE_UNIFORM_BUFFER_BIT specifies that the buffer can be used in a DescriptorBufferInfo suitable for occupying a DescriptorSet slot either of type DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC.

pattern BUFFER_USAGE_STORAGE_BUFFER_BIT :: BufferUsageFlagBits

BUFFER_USAGE_STORAGE_BUFFER_BIT specifies that the buffer can be used in a DescriptorBufferInfo suitable for occupying a DescriptorSet slot either of type DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC.

pattern BUFFER_USAGE_INDEX_BUFFER_BIT :: BufferUsageFlagBits

BUFFER_USAGE_INDEX_BUFFER_BIT specifies that the buffer is suitable for passing as the buffer parameter to cmdBindIndexBuffer.

pattern BUFFER_USAGE_VERTEX_BUFFER_BIT :: BufferUsageFlagBits

BUFFER_USAGE_VERTEX_BUFFER_BIT specifies that the buffer is suitable for passing as an element of the pBuffers array to cmdBindVertexBuffers.

pattern BUFFER_USAGE_INDIRECT_BUFFER_BIT :: BufferUsageFlagBits

BUFFER_USAGE_INDIRECT_BUFFER_BIT specifies that the buffer is suitable for passing as the buffer parameter to cmdDrawIndirect, cmdDrawIndexedIndirect, cmdDrawMeshTasksIndirectNV, cmdDrawMeshTasksIndirectCountNV, cmdDrawMeshTasksIndirectEXT, cmdDrawMeshTasksIndirectCountEXT, cmdDrawClusterIndirectHUAWEI, or cmdDispatchIndirect. It is also suitable for passing as the buffer member of IndirectCommandsStreamNV, or sequencesCountBuffer or sequencesIndexBuffer or preprocessedBuffer member of GeneratedCommandsInfoNV

pattern BUFFER_USAGE_MICROMAP_STORAGE_BIT_EXT :: BufferUsageFlagBits

pattern BUFFER_USAGE_MICROMAP_BUILD_INPUT_READ_ONLY_BIT_EXT :: BufferUsageFlagBits

pattern BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT :: BufferUsageFlagBits

BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT specifies that the buffer, when bound, can be used by the implementation to support push descriptors when using descriptor buffers.

pattern BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT :: BufferUsageFlagBits

BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT specifies that the buffer is suitable to contain resource descriptors when bound as a descriptor buffer.

pattern BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT :: BufferUsageFlagBits

BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT specifies that the buffer is suitable to contain sampler and combined image sampler descriptors when bound as a descriptor buffer. Buffers containing combined image sampler descriptors must also specify BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT.

pattern BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR :: BufferUsageFlagBits

BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR specifies that the buffer is suitable for use as a Shader Binding Table.

pattern BUFFER_USAGE_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR :: BufferUsageFlagBits

BUFFER_USAGE_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR specifies that the buffer is suitable for storage space for a AccelerationStructureKHR.

pattern BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR :: BufferUsageFlagBits

BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR specifies that the buffer is suitable for use as a read-only input to an acceleration structure build.

pattern BUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXT :: BufferUsageFlagBits

BUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXT specifies that the buffer is suitable for passing as the buffer parameter to cmdBeginConditionalRenderingEXT.

pattern BUFFER_USAGE_TRANSFORM_FEEDBACK_COUNTER_BUFFER_BIT_EXT :: BufferUsageFlagBits

BUFFER_USAGE_TRANSFORM_FEEDBACK_COUNTER_BUFFER_BIT_EXT specifies that the buffer is suitable for using as a counter buffer with cmdBeginTransformFeedbackEXT and cmdEndTransformFeedbackEXT.

pattern BUFFER_USAGE_TRANSFORM_FEEDBACK_BUFFER_BIT_EXT :: BufferUsageFlagBits

BUFFER_USAGE_TRANSFORM_FEEDBACK_BUFFER_BIT_EXT specifies that the buffer is suitable for using for binding as a transform feedback buffer with cmdBindTransformFeedbackBuffersEXT.

pattern BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT :: BufferUsageFlagBits

BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT specifies that the buffer can be used to retrieve a buffer device address via getBufferDeviceAddress and use that address to access the buffer’s memory from a shader.

Instances

Storable BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

sizeOf :: BufferUsageFlagBits -> Int

alignment :: BufferUsageFlagBits -> Int

peekElemOff :: Ptr BufferUsageFlagBits -> Int -> IO BufferUsageFlagBits

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

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

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

peek :: Ptr BufferUsageFlagBits -> IO BufferUsageFlagBits

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

Bits BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

(.&.) :: BufferUsageFlagBits -> BufferUsageFlagBits -> BufferUsageFlagBits

(.|.) :: BufferUsageFlagBits -> BufferUsageFlagBits -> BufferUsageFlagBits

xor :: BufferUsageFlagBits -> BufferUsageFlagBits -> BufferUsageFlagBits

complement :: BufferUsageFlagBits -> BufferUsageFlagBits

shift :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

rotate :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

zeroBits :: BufferUsageFlagBits

bit :: Int -> BufferUsageFlagBits

setBit :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

clearBit :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

complementBit :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

testBit :: BufferUsageFlagBits -> Int -> Bool

bitSizeMaybe :: BufferUsageFlagBits -> Maybe Int

bitSize :: BufferUsageFlagBits -> Int

isSigned :: BufferUsageFlagBits -> Bool

shiftL :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

unsafeShiftL :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

shiftR :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

unsafeShiftR :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

rotateL :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

rotateR :: BufferUsageFlagBits -> Int -> BufferUsageFlagBits

popCount :: BufferUsageFlagBits -> Int

FiniteBits BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

finiteBitSize :: BufferUsageFlagBits -> Int

countLeadingZeros :: BufferUsageFlagBits -> Int

countTrailingZeros :: BufferUsageFlagBits -> Int

Read BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

readsPrec :: Int -> ReadS BufferUsageFlagBits

readList :: ReadS [BufferUsageFlagBits]

readPrec :: ReadPrec BufferUsageFlagBits

readListPrec :: ReadPrec [BufferUsageFlagBits]

Show BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

showsPrec :: Int -> BufferUsageFlagBits -> ShowS

show :: BufferUsageFlagBits -> String

showList :: [BufferUsageFlagBits] -> ShowS

Eq BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

(==) :: BufferUsageFlagBits -> BufferUsageFlagBits -> Bool

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

Ord BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

compare :: BufferUsageFlagBits -> BufferUsageFlagBits -> Ordering

(<) :: BufferUsageFlagBits -> BufferUsageFlagBits -> Bool

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

(>) :: BufferUsageFlagBits -> BufferUsageFlagBits -> Bool

(>=) :: BufferUsageFlagBits -> BufferUsageFlagBits -> Bool

max :: BufferUsageFlagBits -> BufferUsageFlagBits -> BufferUsageFlagBits

min :: BufferUsageFlagBits -> BufferUsageFlagBits -> BufferUsageFlagBits

Zero BufferUsageFlagBits

Defined in Vulkan.Core10.Enums.BufferUsageFlagBits

Methods

zero :: BufferUsageFlagBits

type BufferUsageFlags = BufferUsageFlagBits

newtype BufferCreateFlagBits

VkBufferCreateFlagBits - Bitmask specifying additional parameters of a buffer

Description

See Sparse Resource Features and Physical Device Features for details of the sparse memory features supported on a device.

See Also

VK_VERSION_1_0, BufferCreateFlags

Constructors

BufferCreateFlagBits Flags

Bundled Patterns

pattern BUFFER_CREATE_SPARSE_BINDING_BIT :: BufferCreateFlagBits

BUFFER_CREATE_SPARSE_BINDING_BIT specifies that the buffer will be backed using sparse memory binding.

pattern BUFFER_CREATE_SPARSE_RESIDENCY_BIT :: BufferCreateFlagBits

BUFFER_CREATE_SPARSE_RESIDENCY_BIT specifies that the buffer can be partially backed using sparse memory binding. Buffers created with this flag must also be created with the BUFFER_CREATE_SPARSE_BINDING_BIT flag.

pattern BUFFER_CREATE_SPARSE_ALIASED_BIT :: BufferCreateFlagBits

BUFFER_CREATE_SPARSE_ALIASED_BIT specifies that the buffer will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another buffer (or another portion of the same buffer). Buffers created with this flag must also be created with the BUFFER_CREATE_SPARSE_BINDING_BIT flag.

pattern BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT :: BufferCreateFlagBits

BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT specifies that the buffer can be used with descriptor buffers when capturing and replaying (e.g. for trace capture and replay), see OpaqueCaptureDescriptorDataCreateInfoEXT for more detail.

pattern BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT :: BufferCreateFlagBits

BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT specifies that the buffer’s address can be saved and reused on a subsequent run (e.g. for trace capture and replay), see BufferOpaqueCaptureAddressCreateInfo for more detail.

pattern BUFFER_CREATE_PROTECTED_BIT :: BufferCreateFlagBits

BUFFER_CREATE_PROTECTED_BIT specifies that the buffer is a protected buffer.

Instances

Storable BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

sizeOf :: BufferCreateFlagBits -> Int

alignment :: BufferCreateFlagBits -> Int

peekElemOff :: Ptr BufferCreateFlagBits -> Int -> IO BufferCreateFlagBits

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

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

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

peek :: Ptr BufferCreateFlagBits -> IO BufferCreateFlagBits

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

Bits BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

(.&.) :: BufferCreateFlagBits -> BufferCreateFlagBits -> BufferCreateFlagBits

(.|.) :: BufferCreateFlagBits -> BufferCreateFlagBits -> BufferCreateFlagBits

xor :: BufferCreateFlagBits -> BufferCreateFlagBits -> BufferCreateFlagBits

complement :: BufferCreateFlagBits -> BufferCreateFlagBits

shift :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

rotate :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

zeroBits :: BufferCreateFlagBits

bit :: Int -> BufferCreateFlagBits

setBit :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

clearBit :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

complementBit :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

testBit :: BufferCreateFlagBits -> Int -> Bool

bitSizeMaybe :: BufferCreateFlagBits -> Maybe Int

bitSize :: BufferCreateFlagBits -> Int

isSigned :: BufferCreateFlagBits -> Bool

shiftL :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

unsafeShiftL :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

shiftR :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

unsafeShiftR :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

rotateL :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

rotateR :: BufferCreateFlagBits -> Int -> BufferCreateFlagBits

popCount :: BufferCreateFlagBits -> Int

FiniteBits BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

finiteBitSize :: BufferCreateFlagBits -> Int

countLeadingZeros :: BufferCreateFlagBits -> Int

countTrailingZeros :: BufferCreateFlagBits -> Int

Read BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

readsPrec :: Int -> ReadS BufferCreateFlagBits

readList :: ReadS [BufferCreateFlagBits]

readPrec :: ReadPrec BufferCreateFlagBits

readListPrec :: ReadPrec [BufferCreateFlagBits]

Show BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

showsPrec :: Int -> BufferCreateFlagBits -> ShowS

show :: BufferCreateFlagBits -> String

showList :: [BufferCreateFlagBits] -> ShowS

Eq BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

(==) :: BufferCreateFlagBits -> BufferCreateFlagBits -> Bool

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

Ord BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

compare :: BufferCreateFlagBits -> BufferCreateFlagBits -> Ordering

(<) :: BufferCreateFlagBits -> BufferCreateFlagBits -> Bool

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

(>) :: BufferCreateFlagBits -> BufferCreateFlagBits -> Bool

(>=) :: BufferCreateFlagBits -> BufferCreateFlagBits -> Bool

max :: BufferCreateFlagBits -> BufferCreateFlagBits -> BufferCreateFlagBits

min :: BufferCreateFlagBits -> BufferCreateFlagBits -> BufferCreateFlagBits

Zero BufferCreateFlagBits

Defined in Vulkan.Core10.Enums.BufferCreateFlagBits

Methods

zero :: BufferCreateFlagBits

type BufferCreateFlags = BufferCreateFlagBits