org.lwjgl.vulkan

Class NVDedicatedAllocation

java.lang.Object

org.lwjgl.vulkan.NVDedicatedAllocation

public final class NVDedicatedAllocation
extends java.lang.Object

This extension allows device memory to be allocated for a particular buffer or image resource, which on some devices can significantly improve the performance of that resource. Normal device memory allocations must support memory aliasing and sparse binding, which could interfere with optimizations like framebuffer compression or efficient page table usage. This is important for render targets and very large resources, but need not (and probably should not) be used for smaller resources that can benefit from suballocation.

This extension adds a few small structures to resource creation and memory allocation: a new structure that flags whether am image/buffer will have a dedicated allocation, and a structure indicating the image or buffer that an allocation will be bound to.

Examples

     // Create an image with
     // VkDedicatedAllocationImageCreateInfoNV::dedicatedAllocation
     // set to VK_TRUE
 
     VkDedicatedAllocationImageCreateInfoNV dedicatedImageInfo =
     {
         VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV,            // sType
         NULL,                                                                   // pNext
         VK_TRUE,                                                                // dedicatedAllocation
     };
 
     VkImageCreateInfo imageCreateInfo =
     {
         VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO,    // sType
         &dedicatedImageInfo                     // pNext
         // Other members set as usual
     };
 
     VkImage image;
     VkResult result = vkCreateImage(
         device,
         &imageCreateInfo,
         NULL,                       // pAllocator
         &image);
 
     VkMemoryRequirements memoryRequirements;
     vkGetImageMemoryRequirements(
         device,
         image,
         &memoryRequirements);
 
     // Allocate memory with VkDedicatedAllocationMemoryAllocateInfoNV::image
     // pointing to the image we are allocating the memory for
 
     VkDedicatedAllocationMemoryAllocateInfoNV dedicatedInfo =
     {
         VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV,             // sType
         NULL,                                                                       // pNext
         image,                                                                      // image
         VK_NULL_HANDLE,                                                             // buffer
     };
 
     VkMemoryAllocateInfo memoryAllocateInfo =
     {
         VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO,                 // sType
         &dedicatedInfo,                                         // pNext
         memoryRequirements.size,                                // allocationSize
         FindMemoryTypeIndex(memoryRequirements.memoryTypeBits), // memoryTypeIndex
     };
 
     VkDeviceMemory memory;
     vkAllocateMemory(
         device,
         &memoryAllocateInfo,
         NULL,                       // pAllocator
         &memory);
 
     // Bind the image to the memory
 
     vkBindImageMemory(
         device,
         image,
         memory,
         0);

Name String

VK_NV_dedicated_allocation

Extension Type

Device extension

Registered Extension Number

27

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0

Deprecation state

• Deprecated by VK_KHR_dedicated_allocation extension
  • Which in turn was promoted to Vulkan 1.1

Contact

• Jeff Bolz jeffbolznv

Last Modified Date

2016-05-31

IP Status

No known IP claims.

Contributors

• Jeff Bolz, NVIDIA

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VK_NV_DEDICATED_ALLOCATION_EXTENSION_NAME The extension name.
static int	VK_NV_DEDICATED_ALLOCATION_SPEC_VERSION The extension specification version.
static int	VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_BUFFER_CREATE_INFO_NV Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV Extends VkStructureType.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_NV_DEDICATED_ALLOCATION_SPEC_VERSION

public static final int VK_NV_DEDICATED_ALLOCATION_SPEC_VERSION

The extension specification version.

See Also:

Constant Field Values

VK_NV_DEDICATED_ALLOCATION_EXTENSION_NAME

public static final java.lang.String VK_NV_DEDICATED_ALLOCATION_EXTENSION_NAME

The extension name.

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV

public static final int VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV
• STRUCTURE_TYPE_DEDICATED_ALLOCATION_BUFFER_CREATE_INFO_NV
• STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_BUFFER_CREATE_INFO_NV

public static final int VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_BUFFER_CREATE_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV
• STRUCTURE_TYPE_DEDICATED_ALLOCATION_BUFFER_CREATE_INFO_NV
• STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV

public static final int VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV
• STRUCTURE_TYPE_DEDICATED_ALLOCATION_BUFFER_CREATE_INFO_NV
• STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV

See Also:

Constant Field Values