Graphics.Vulkan.Core11.Promoted_from_VK_KHR_bind_memory2

Documentation

pattern VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO :: VkStructureType

pattern VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO :: VkStructureType

pattern VK_IMAGE_CREATE_ALIAS_BIT :: VkImageCreateFlagBits

vkBindBufferMemory2 :: ("device" ::: VkDevice) -> ("bindInfoCount" ::: Word32) -> ("pBindInfos" ::: Ptr VkBindBufferMemoryInfo) -> IO VkResult

vkBindBufferMemory2 - Bind device memory to buffer objects

Parameters

• device is the logical device that owns the buffers and memory.

• bindInfoCount is the number of elements in pBindInfos.
• pBindInfos is a pointer to an array of structures of type VkBindBufferMemoryInfo, describing buffers and memory to bind.

Description

On some implementations, it may be more efficient to batch memory bindings into a single command.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• pBindInfos must be a valid pointer to an array of bindInfoCount valid VkBindBufferMemoryInfo structures
• bindInfoCount must be greater than 0

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkBindBufferMemoryInfo, VkDevice

vkBindImageMemory2 :: ("device" ::: VkDevice) -> ("bindInfoCount" ::: Word32) -> ("pBindInfos" ::: Ptr VkBindImageMemoryInfo) -> IO VkResult

vkBindImageMemory2 - Bind device memory to image objects

Parameters

• device is the logical device that owns the images and memory.

• bindInfoCount is the number of elements in pBindInfos.
• pBindInfos is a pointer to an array of structures of type VkBindImageMemoryInfo, describing images and memory to bind.

Description

On some implementations, it may be more efficient to batch memory bindings into a single command.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• pBindInfos must be a valid pointer to an array of bindInfoCount valid VkBindImageMemoryInfo structures
• bindInfoCount must be greater than 0

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkBindImageMemoryInfo, VkDevice

data VkBindBufferMemoryInfo

VkBindBufferMemoryInfo - Structure specifying how to bind a buffer to memory

Description

Valid Usage

• buffer must not already be backed by a memory object

• buffer must not have been created with any sparse memory binding flags
• memoryOffset must be less than the size of memory
• If buffer was created with the VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, memoryOffset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
• If buffer was created with the VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, memoryOffset must be a multiple of VkPhysicalDeviceLimits::minUniformBufferOffsetAlignment
• If buffer was created with the VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, memoryOffset must be a multiple of VkPhysicalDeviceLimits::minStorageBufferOffsetAlignment
• memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the VkMemoryRequirements structure returned from a call to vkGetBufferMemoryRequirements with buffer
• memoryOffset must be an integer multiple of the alignment member of the VkMemoryRequirements structure returned from a call to vkGetBufferMemoryRequirements with buffer
• The size member of the VkMemoryRequirements structure returned from a call to vkGetBufferMemoryRequirements with buffer must be less than or equal to the size of memory minus memoryOffset
• If buffer requires a dedicated allocation(as reported by vkGetBufferMemoryRequirements2 in VkMemoryDedicatedRequirements::requiresDedicatedAllocation for buffer), memory must have been created with VkMemoryDedicatedAllocateInfo::buffer equal to buffer and memoryOffset must be zero
• If the VkMemoryAllocateInfo provided when memory was allocated included an instance of VkMemoryDedicatedAllocateInfo in its pNext chain, and VkMemoryDedicatedAllocateInfo::buffer was not VK_NULL_HANDLE, then buffer must equal VkMemoryDedicatedAllocateInfo::buffer and memoryOffset must be zero.
• If buffer was created with VkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocation equal to VK_TRUE, memory must have been created with VkDedicatedAllocationMemoryAllocateInfoNV::buffer equal to buffer and memoryOffset must be zero
• If the pNext chain includes VkBindBufferMemoryDeviceGroupInfo, all instances of memory specified by VkBindBufferMemoryDeviceGroupInfo::pDeviceIndices must have been allocated

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO

• pNext must be NULL or a pointer to a valid instance of VkBindBufferMemoryDeviceGroupInfo
• buffer must be a valid VkBuffer handle
• memory must be a valid VkDeviceMemory handle
• Both of buffer, and memory must have been created, allocated, or retrieved from the same VkDevice

See Also

VkBuffer, VkDeviceMemory, VkDeviceSize, VkStructureType, vkBindBufferMemory2, vkBindBufferMemory2KHR

Constructors

VkBindBufferMemoryInfo

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkBuffer :: VkBuffer

  buffer is the buffer to be attached to memory.

• vkMemory :: VkDeviceMemory

  memory is a VkDeviceMemory object describing the device memory to attach.

• vkMemoryOffset :: VkDeviceSize

  memoryOffset is the start offset of the region of memory which is to be bound to the buffer. The number of bytes returned in the VkMemoryRequirements::size member in memory, starting from memoryOffset bytes, will be bound to the specified buffer.

Instances

Eq VkBindBufferMemoryInfo

Methods

(==) :: VkBindBufferMemoryInfo -> VkBindBufferMemoryInfo -> Bool

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

Show VkBindBufferMemoryInfo

Methods

showsPrec :: Int -> VkBindBufferMemoryInfo -> ShowS

show :: VkBindBufferMemoryInfo -> String

showList :: [VkBindBufferMemoryInfo] -> ShowS

Storable VkBindBufferMemoryInfo

Methods

sizeOf :: VkBindBufferMemoryInfo -> Int

alignment :: VkBindBufferMemoryInfo -> Int

peekElemOff :: Ptr VkBindBufferMemoryInfo -> Int -> IO VkBindBufferMemoryInfo

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

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

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

peek :: Ptr VkBindBufferMemoryInfo -> IO VkBindBufferMemoryInfo

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

data VkBindImageMemoryInfo

VkBindImageMemoryInfo - Structure specifying how to bind an image to memory

Description

Valid Usage

• image must not already be backed by a memory object

• image must not have been created with any sparse memory binding flags
• memoryOffset must be less than the size of memory
• If the pNext chain does not include an instance of the VkBindImagePlaneMemoryInfo structure, memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the VkMemoryRequirements structure returned from a call to vkGetImageMemoryRequirements2 with image
• If the pNext chain does not include an instance of the VkBindImagePlaneMemoryInfo structure, memoryOffset must be an integer multiple of the alignment member of the VkMemoryRequirements structure returned from a call to vkGetImageMemoryRequirements2 with image
• If the pNext chain does not include an instance of the VkBindImagePlaneMemoryInfo structure, the difference of the size of memory and memoryOffset must be greater than or equal to the size member of the VkMemoryRequirements structure returned from a call to vkGetImageMemoryRequirements2 with the same image
• If the pNext chain includes an instance of the VkBindImagePlaneMemoryInfo structure, image must have been created with the VK_IMAGE_CREATE_DISJOINT_BIT bit set.
• If the pNext chain includes an instance of the VkBindImagePlaneMemoryInfo structure, memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the VkMemoryRequirements structure returned from a call to vkGetImageMemoryRequirements2 with image and the correct planeAspect for this plane in the VkImagePlaneMemoryRequirementsInfo structure attached to the VkImageMemoryRequirementsInfo2’s pNext chain
• If the pNext chain includes an instance of the VkBindImagePlaneMemoryInfo structure, memoryOffset must be an integer multiple of the alignment member of the VkMemoryRequirements structure returned from a call to vkGetImageMemoryRequirements2 with image and the correct planeAspect for this plane in the VkImagePlaneMemoryRequirementsInfo structure attached to the VkImageMemoryRequirementsInfo2’s pNext chain
• If the pNext chain includes an instance of the VkBindImagePlaneMemoryInfo structure, the difference of the size of memory and memoryOffset must be greater than or equal to the size member of the VkMemoryRequirements structure returned from a call to vkGetImageMemoryRequirements2 with the same image and the correct planeAspect for this plane in the VkImagePlaneMemoryRequirementsInfo structure attached to the VkImageMemoryRequirementsInfo2’s pNext chain
• If image requires a dedicated allocation (as reported by vkGetImageMemoryRequirements2 in VkMemoryDedicatedRequirements::requiresDedicatedAllocation for image), memory must have been created with VkMemoryDedicatedAllocateInfo::image equal to image and memoryOffset must be zero
• If the VkMemoryAllocateInfo provided when memory was allocated included an instance of VkMemoryDedicatedAllocateInfo in its pNext chain, and VkMemoryDedicatedAllocateInfo::image was not VK_NULL_HANDLE, then image must equal VkMemoryDedicatedAllocateInfo::image and memoryOffset must be zero.
• If image was created with VkDedicatedAllocationImageCreateInfoNV::dedicatedAllocation equal to VK_TRUE, memory must have been created with VkDedicatedAllocationMemoryAllocateInfoNV::image equal to image and memoryOffset must be zero
• If the pNext chain includes VkBindImageMemoryDeviceGroupInfo, all instances of memory specified by VkBindImageMemoryDeviceGroupInfo::pDeviceIndices must have been allocated
• If the pNext chain includes VkBindImageMemoryDeviceGroupInfo, and VkBindImageMemoryDeviceGroupInfo::splitInstanceBindRegionCount is not zero, then image must have been created with the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit set
• If the pNext chain includes VkBindImageMemoryDeviceGroupInfo, all elements of VkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegions must be valid rectangles contained within the dimensions of image
• If the pNext chain includes VkBindImageMemoryDeviceGroupInfo, the union of the areas of all elements of VkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegions that correspond to the same instance of image must cover the entire image.
• If image was created with a valid swapchain handle in VkImageSwapchainCreateInfoKHR::swapchain, then the pNext chain must include a valid instance of VkBindImageMemorySwapchainInfoKHR
• If the pNext chain includes an instance of VkBindImageMemorySwapchainInfoKHR, memory must be VK_NULL_HANDLE
• If the pNext chain does not include an instance of VkBindImageMemorySwapchainInfoKHR, memory must be a valid VkDeviceMemory handle

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_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 VkBindImageMemoryDeviceGroupInfo, VkBindImageMemorySwapchainInfoKHR, or VkBindImagePlaneMemoryInfo
• Each sType member in the pNext chain must be unique
• image must be a valid VkImage handle
• Both of image, and memory that are valid handles must have been created, allocated, or retrieved from the same VkDevice

See Also

VkDeviceMemory, VkDeviceSize, VkImage, VkStructureType, vkBindImageMemory2, vkBindImageMemory2KHR

Constructors

VkBindImageMemoryInfo

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkImage :: VkImage

  image is the image to be attached to memory.

• vkMemory :: VkDeviceMemory

  memory is a VkDeviceMemory object describing the device memory to attach.

• vkMemoryOffset :: VkDeviceSize

  memoryOffset is the start offset of the region of memory which is to be bound to the image. The number of bytes returned in the VkMemoryRequirements::size member in memory, starting from memoryOffset bytes, will be bound to the specified image.

Instances

Eq VkBindImageMemoryInfo

Methods

(==) :: VkBindImageMemoryInfo -> VkBindImageMemoryInfo -> Bool

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

Show VkBindImageMemoryInfo

Methods

showsPrec :: Int -> VkBindImageMemoryInfo -> ShowS

show :: VkBindImageMemoryInfo -> String

showList :: [VkBindImageMemoryInfo] -> ShowS

Storable VkBindImageMemoryInfo

Methods

sizeOf :: VkBindImageMemoryInfo -> Int

alignment :: VkBindImageMemoryInfo -> Int

peekElemOff :: Ptr VkBindImageMemoryInfo -> Int -> IO VkBindImageMemoryInfo

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

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

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

peek :: Ptr VkBindImageMemoryInfo -> IO VkBindImageMemoryInfo

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