Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_NV_dedicated_allocation

Description

Name

VK_NV_dedicated_allocation - device extension

VK_NV_dedicated_allocation

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%0A<<Here describe the issue or question you have about the VK_NV_dedicated_allocation extension> >

Other Extension Metadata

Last Modified Date: 2016-05-31

IP Status

No known IP claims.

Contributors

Jeff Bolz, NVIDIA

Description

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.

New Structures

Extending BufferCreateInfo:
- DedicatedAllocationBufferCreateInfoNV

Extending ImageCreateInfo:
- DedicatedAllocationImageCreateInfoNV
Extending MemoryAllocateInfo:
- DedicatedAllocationMemoryAllocateInfoNV

New Enum Constants

NV_DEDICATED_ALLOCATION_EXTENSION_NAME

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);

Version History

Revision 1, 2016-05-31 (Jeff Bolz)
- Internal revisions

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

data DedicatedAllocationImageCreateInfoNV = DedicatedAllocationImageCreateInfoNV {
- dedicatedAllocation :: Bool
}
data DedicatedAllocationBufferCreateInfoNV = DedicatedAllocationBufferCreateInfoNV {
- dedicatedAllocation :: Bool
}
data DedicatedAllocationMemoryAllocateInfoNV = DedicatedAllocationMemoryAllocateInfoNV {
- image :: Image
- buffer :: Buffer
}
type NV_DEDICATED_ALLOCATION_SPEC_VERSION = 1
pattern NV_DEDICATED_ALLOCATION_SPEC_VERSION :: forall a. Integral a => a
type NV_DEDICATED_ALLOCATION_EXTENSION_NAME = "VK_NV_dedicated_allocation"
pattern NV_DEDICATED_ALLOCATION_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data DedicatedAllocationImageCreateInfoNV Source #

VkDedicatedAllocationImageCreateInfoNV - Specify that an image is bound to a dedicated memory resource

Description

Note

Using a dedicated allocation for color and depth/stencil attachments or other large images may improve performance on some devices.

Valid Usage

If dedicatedAllocation is TRUE, ImageCreateInfo::flags must not include IMAGE_CREATE_SPARSE_BINDING_BIT, IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or IMAGE_CREATE_SPARSE_ALIASED_BIT

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV

Eq DedicatedAllocationBufferCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods (==) :: DedicatedAllocationBufferCreateInfoNV -> DedicatedAllocationBufferCreateInfoNV -> Bool # (/=) :: DedicatedAllocationBufferCreateInfoNV -> DedicatedAllocationBufferCreateInfoNV -> Bool #
Show DedicatedAllocationBufferCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods showsPrec :: Int -> DedicatedAllocationBufferCreateInfoNV -> ShowS # show :: DedicatedAllocationBufferCreateInfoNV -> String # showList :: [DedicatedAllocationBufferCreateInfoNV] -> ShowS #
Storable DedicatedAllocationBufferCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods sizeOf :: DedicatedAllocationBufferCreateInfoNV -> Int # alignment :: DedicatedAllocationBufferCreateInfoNV -> Int # peekElemOff :: Ptr DedicatedAllocationBufferCreateInfoNV -> Int -> IO DedicatedAllocationBufferCreateInfoNV # pokeElemOff :: Ptr DedicatedAllocationBufferCreateInfoNV -> Int -> DedicatedAllocationBufferCreateInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO DedicatedAllocationBufferCreateInfoNV # pokeByteOff :: Ptr b -> Int -> DedicatedAllocationBufferCreateInfoNV -> IO () # peek :: Ptr DedicatedAllocationBufferCreateInfoNV -> IO DedicatedAllocationBufferCreateInfoNV # poke :: Ptr DedicatedAllocationBufferCreateInfoNV -> DedicatedAllocationBufferCreateInfoNV -> IO () #
FromCStruct DedicatedAllocationBufferCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods peekCStruct :: Ptr DedicatedAllocationBufferCreateInfoNV -> IO DedicatedAllocationBufferCreateInfoNV Source #
ToCStruct DedicatedAllocationBufferCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods withCStruct :: DedicatedAllocationBufferCreateInfoNV -> (Ptr DedicatedAllocationBufferCreateInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr DedicatedAllocationBufferCreateInfoNV -> DedicatedAllocationBufferCreateInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr DedicatedAllocationBufferCreateInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr DedicatedAllocationBufferCreateInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero DedicatedAllocationBufferCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods zero :: DedicatedAllocationBufferCreateInfoNV Source #

data DedicatedAllocationMemoryAllocateInfoNV Source #

VkDedicatedAllocationMemoryAllocateInfoNV - Specify a dedicated memory allocation resource

Valid Usage

At least one of image and buffer must be NULL_HANDLE

If image is not NULL_HANDLE, the image must have been created with DedicatedAllocationImageCreateInfoNV::dedicatedAllocation equal to TRUE
If buffer is not NULL_HANDLE, the buffer must have been created with DedicatedAllocationBufferCreateInfoNV::dedicatedAllocation equal to TRUE
If image is not NULL_HANDLE, MemoryAllocateInfo::allocationSize must equal the MemoryRequirements::size of the image
If buffer is not NULL_HANDLE, MemoryAllocateInfo::allocationSize must equal the MemoryRequirements::size of the buffer
If image is not NULL_HANDLE and MemoryAllocateInfo defines a memory import operation, 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 NULL_HANDLE and MemoryAllocateInfo defines a memory import operation, the memory being imported must also be a dedicated buffer allocation and buffer must be identical to the buffer associated with the imported memory

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV

If image is not NULL_HANDLE, image must be a valid Image handle
If buffer is not NULL_HANDLE, buffer must be a valid Buffer handle
Both of buffer, and image that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Eq DedicatedAllocationMemoryAllocateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods (==) :: DedicatedAllocationMemoryAllocateInfoNV -> DedicatedAllocationMemoryAllocateInfoNV -> Bool # (/=) :: DedicatedAllocationMemoryAllocateInfoNV -> DedicatedAllocationMemoryAllocateInfoNV -> Bool #
Show DedicatedAllocationMemoryAllocateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods showsPrec :: Int -> DedicatedAllocationMemoryAllocateInfoNV -> ShowS # show :: DedicatedAllocationMemoryAllocateInfoNV -> String # showList :: [DedicatedAllocationMemoryAllocateInfoNV] -> ShowS #
Storable DedicatedAllocationMemoryAllocateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods sizeOf :: DedicatedAllocationMemoryAllocateInfoNV -> Int # alignment :: DedicatedAllocationMemoryAllocateInfoNV -> Int # peekElemOff :: Ptr DedicatedAllocationMemoryAllocateInfoNV -> Int -> IO DedicatedAllocationMemoryAllocateInfoNV # pokeElemOff :: Ptr DedicatedAllocationMemoryAllocateInfoNV -> Int -> DedicatedAllocationMemoryAllocateInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO DedicatedAllocationMemoryAllocateInfoNV # pokeByteOff :: Ptr b -> Int -> DedicatedAllocationMemoryAllocateInfoNV -> IO () # peek :: Ptr DedicatedAllocationMemoryAllocateInfoNV -> IO DedicatedAllocationMemoryAllocateInfoNV # poke :: Ptr DedicatedAllocationMemoryAllocateInfoNV -> DedicatedAllocationMemoryAllocateInfoNV -> IO () #
FromCStruct DedicatedAllocationMemoryAllocateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods peekCStruct :: Ptr DedicatedAllocationMemoryAllocateInfoNV -> IO DedicatedAllocationMemoryAllocateInfoNV Source #
ToCStruct DedicatedAllocationMemoryAllocateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods withCStruct :: DedicatedAllocationMemoryAllocateInfoNV -> (Ptr DedicatedAllocationMemoryAllocateInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr DedicatedAllocationMemoryAllocateInfoNV -> DedicatedAllocationMemoryAllocateInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr DedicatedAllocationMemoryAllocateInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr DedicatedAllocationMemoryAllocateInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero DedicatedAllocationMemoryAllocateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods zero :: DedicatedAllocationMemoryAllocateInfoNV Source #

type NV_DEDICATED_ALLOCATION_SPEC_VERSION = 1 Source #

pattern NV_DEDICATED_ALLOCATION_SPEC_VERSION :: forall a. Integral a => a Source #

type NV_DEDICATED_ALLOCATION_EXTENSION_NAME = "VK_NV_dedicated_allocation" Source #

pattern NV_DEDICATED_ALLOCATION_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

Eq DedicatedAllocationImageCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods (==) :: DedicatedAllocationImageCreateInfoNV -> DedicatedAllocationImageCreateInfoNV -> Bool # (/=) :: DedicatedAllocationImageCreateInfoNV -> DedicatedAllocationImageCreateInfoNV -> Bool #
Show DedicatedAllocationImageCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods showsPrec :: Int -> DedicatedAllocationImageCreateInfoNV -> ShowS # show :: DedicatedAllocationImageCreateInfoNV -> String # showList :: [DedicatedAllocationImageCreateInfoNV] -> ShowS #
Storable DedicatedAllocationImageCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods sizeOf :: DedicatedAllocationImageCreateInfoNV -> Int # alignment :: DedicatedAllocationImageCreateInfoNV -> Int # peekElemOff :: Ptr DedicatedAllocationImageCreateInfoNV -> Int -> IO DedicatedAllocationImageCreateInfoNV # pokeElemOff :: Ptr DedicatedAllocationImageCreateInfoNV -> Int -> DedicatedAllocationImageCreateInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO DedicatedAllocationImageCreateInfoNV # pokeByteOff :: Ptr b -> Int -> DedicatedAllocationImageCreateInfoNV -> IO () # peek :: Ptr DedicatedAllocationImageCreateInfoNV -> IO DedicatedAllocationImageCreateInfoNV # poke :: Ptr DedicatedAllocationImageCreateInfoNV -> DedicatedAllocationImageCreateInfoNV -> IO () #
FromCStruct DedicatedAllocationImageCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods peekCStruct :: Ptr DedicatedAllocationImageCreateInfoNV -> IO DedicatedAllocationImageCreateInfoNV Source #
ToCStruct DedicatedAllocationImageCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods withCStruct :: DedicatedAllocationImageCreateInfoNV -> (Ptr DedicatedAllocationImageCreateInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr DedicatedAllocationImageCreateInfoNV -> DedicatedAllocationImageCreateInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr DedicatedAllocationImageCreateInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr DedicatedAllocationImageCreateInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero DedicatedAllocationImageCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_dedicated_allocation Methods zero :: DedicatedAllocationImageCreateInfoNV Source #

Name

VK_NV_dedicated_allocation

Other Extension Metadata

Description

New Structures

New Enum Constants

Examples

Version History

See Also

Document Notes

Documentation

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Valid Usage

Valid Usage (Implicit)

See Also

Instances

DedicatedAllocationImageCreateInfoNV
Fields dedicatedAllocation :: Bool `dedicatedAllocation` specifies whether the image will have a dedicated allocation bound to it.

DedicatedAllocationBufferCreateInfoNV
Fields dedicatedAllocation :: Bool `dedicatedAllocation` specifies whether the buffer will have a dedicated allocation bound to it.

DedicatedAllocationMemoryAllocateInfoNV
Fields image :: Image `image` is `NULL_HANDLE` or a handle of an image which this memory will be bound to. buffer :: Buffer `buffer` is `NULL_HANDLE` or a handle of a buffer which this memory will be bound to.