Graphics.Vulkan.Core11.Promoted_from_VK_KHR_dedicated_allocation

Documentation

pattern VK_STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS :: VkStructureType

pattern VK_STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO :: VkStructureType

data VkMemoryDedicatedRequirements

VkMemoryDedicatedRequirements - Structure describing dedicated allocation requirements of buffer and image resources

Description

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetBufferMemoryRequirements2 call, requiresDedicatedAllocation may be VK_TRUE under one of the following conditions:

• The pNext chain of VkBufferCreateInfo for the call to vkCreateBuffer used to create the buffer being queried contained an instance of VkExternalMemoryBufferCreateInfo, and any of the handle types specified in VkExternalMemoryBufferCreateInfo::handleTypes requires dedicated allocation, as reported by vkGetPhysicalDeviceExternalBufferProperties in VkExternalBufferProperties::externalMemoryProperties::externalMemoryFeatures, the requiresDedicatedAllocation field will be set to VK_TRUE.

In all other cases, requiresDedicatedAllocation must be set to VK_FALSE by the implementation whenever a VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed to a call to vkGetBufferMemoryRequirements2.

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetBufferMemoryRequirements2 call and VK_BUFFER_CREATE_SPARSE_BINDING_BIT was set in VkBufferCreateInfo::flags when buffer was created then the implementation must set both prefersDedicatedAllocation and requiresDedicatedAllocation to VK_FALSE.

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetImageMemoryRequirements2 call, requiresDedicatedAllocation may be VK_TRUE under one of the following conditions:

• The pNext chain of VkImageCreateInfo for the call to vkCreateImage used to create the image being queried contained an instance of VkExternalMemoryImageCreateInfo, and any of the handle types specified in VkExternalMemoryImageCreateInfo::handleTypes requires dedicated allocation, as reported by vkGetPhysicalDeviceImageFormatProperties2 in VkExternalImageFormatProperties::externalMemoryProperties::externalMemoryFeatures, the requiresDedicatedAllocation field will be set to VK_TRUE.

In all other cases, requiresDedicatedAllocation must be set to VK_FALSE by the implementation whenever a VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed to a call to vkGetImageMemoryRequirements2.

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetImageMemoryRequirements2 call and VK_IMAGE_CREATE_SPARSE_BINDING_BIT was set in VkImageCreateInfo::flags when image was created then the implementation must set both prefersDedicatedAllocation and requiresDedicatedAllocation to VK_FALSE.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS

See Also

VkBool32, VkStructureType

Constructors

VkMemoryDedicatedRequirements

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkPrefersDedicatedAllocation :: VkBool32

  prefersDedicatedAllocation specifies that the implementation would prefer a dedicated allocation for this resource. The application is still free to suballocate the resource but it may get better performance if a dedicated allocation is used.

• vkRequiresDedicatedAllocation :: VkBool32

  requiresDedicatedAllocation specifies that a dedicated allocation is required for this resource.

Instances

Eq VkMemoryDedicatedRequirements

Methods

(==) :: VkMemoryDedicatedRequirements -> VkMemoryDedicatedRequirements -> Bool

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

Show VkMemoryDedicatedRequirements

Methods

showsPrec :: Int -> VkMemoryDedicatedRequirements -> ShowS

show :: VkMemoryDedicatedRequirements -> String

showList :: [VkMemoryDedicatedRequirements] -> ShowS

Storable VkMemoryDedicatedRequirements

Methods

sizeOf :: VkMemoryDedicatedRequirements -> Int

alignment :: VkMemoryDedicatedRequirements -> Int

peekElemOff :: Ptr VkMemoryDedicatedRequirements -> Int -> IO VkMemoryDedicatedRequirements

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

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

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

peek :: Ptr VkMemoryDedicatedRequirements -> IO VkMemoryDedicatedRequirements

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

data VkMemoryDedicatedAllocateInfo

VkMemoryDedicatedAllocateInfo - Specify a dedicated memory allocation resource

Description

Valid Usage

• At least one of image and buffer must be VK_NULL_HANDLE

• If image is not VK_NULL_HANDLE, VkMemoryAllocateInfo::allocationSize must equal the VkMemoryRequirements::size of the image
• If image is not VK_NULL_HANDLE, image must have been created without VK_IMAGE_CREATE_SPARSE_BINDING_BIT set in VkImageCreateInfo::flags
• If buffer is not VK_NULL_HANDLE, VkMemoryAllocateInfo::allocationSize must equal the VkMemoryRequirements::size of the buffer
• If buffer is not VK_NULL_HANDLE, buffer must have been created without VK_BUFFER_CREATE_SPARSE_BINDING_BIT set in VkBufferCreateInfo::flags
• If image is not VK_NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, and the external handle was created by the Vulkan API, then the memory being imported must also be a dedicated image allocation and image must be identical to the image associated with the imported memory.
• If buffer is not VK_NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, and the external handle was created by the Vulkan API, then the memory being imported must also be a dedicated buffer allocation and buffer must be identical to the buffer associated with the imported memory.
• If image is not VK_NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT, the memory being imported must also be a dedicated image allocation and image must be identical to the image associated with the imported memory.
• If buffer is not VK_NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT, the memory being imported must also be a dedicated buffer allocation and buffer must be identical to the buffer associated with the imported memory.
• If image is not VK_NULL_HANDLE, image must not have been created with VK_IMAGE_CREATE_DISJOINT_BIT set in VkImageCreateInfo::flags

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO

• If image is not VK_NULL_HANDLE, image must be a valid VkImage handle
• If buffer is not VK_NULL_HANDLE, buffer must be a valid VkBuffer handle
• Both of buffer, and image that are valid handles must have been created, allocated, or retrieved from the same VkDevice

See Also

VkBuffer, VkImage, VkStructureType

Constructors

VkMemoryDedicatedAllocateInfo

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 VK_NULL_HANDLE or a handle of an image which this memory will be bound to.

• vkBuffer :: VkBuffer

  buffer is VK_NULL_HANDLE or a handle of a buffer which this memory will be bound to.

Instances

Eq VkMemoryDedicatedAllocateInfo

Methods

(==) :: VkMemoryDedicatedAllocateInfo -> VkMemoryDedicatedAllocateInfo -> Bool

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

Show VkMemoryDedicatedAllocateInfo

Methods

showsPrec :: Int -> VkMemoryDedicatedAllocateInfo -> ShowS

show :: VkMemoryDedicatedAllocateInfo -> String

showList :: [VkMemoryDedicatedAllocateInfo] -> ShowS

Storable VkMemoryDedicatedAllocateInfo

Methods

sizeOf :: VkMemoryDedicatedAllocateInfo -> Int

alignment :: VkMemoryDedicatedAllocateInfo -> Int

peekElemOff :: Ptr VkMemoryDedicatedAllocateInfo -> Int -> IO VkMemoryDedicatedAllocateInfo

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

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

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

peek :: Ptr VkMemoryDedicatedAllocateInfo -> IO VkMemoryDedicatedAllocateInfo

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