VkMemoryAllocateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkMemoryAllocateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkMemoryAllocateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure containing parameters of a memory allocation.
Description

A VkMemoryAllocateInfo structure defines a memory import operation if its pNext chain includes one of the following structures:
- VkImportMemoryWin32HandleInfoKHR with non-zero handleType value
- VkImportMemoryFdInfoKHR with a non-zero handleType value
- VkImportMemoryHostPointerInfoEXT with a non-zero handleType value
Importing memory must not modify the content of the memory. Implementations must ensure that importing memory does not enable the importing Vulkan instance to access any memory or resources in other Vulkan instances other than that corresponding to the memory object imported. Implementations must also ensure accessing imported memory which has not been initialized does not allow the importing Vulkan instance to obtain data from the exporting Vulkan instance or vice-versa.

Note

How exported and imported memory is isolated is left to the implementation, but applications should be aware that such isolation may prevent implementations from placing multiple exportable memory objects in the same physical or virtual page. Hence, applications should avoid creating many small external memory objects whenever possible.

When performing a memory import operation, it is the responsibility of the application to ensure the external handles meet all valid usage requirements. However, implementations must perform sufficient validation of external handles to ensure that the operation results in a valid memory object which will not cause program termination, device loss, queue stalls, or corruption of other resources when used as allowed according to its allocation parameters. If the external handle provided does not meet these requirements, the implementation must fail the memory import operation with the error code ERROR_INVALID_EXTERNAL_HANDLE.

Valid Usage
- allocationSize must be greater than 0
- If the pNext chain includes a VkExportMemoryAllocateInfo structure, and any of the handle types specified in VkExportMemoryAllocateInfo::handleTypes require a dedicated allocation, as reported by GetPhysicalDeviceImageFormatProperties2 in VkExternalImageFormatProperties::externalMemoryProperties.externalMemoryFeatures or VkExternalBufferProperties::externalMemoryProperties.externalMemoryFeatures, the pNext chain must include a VkMemoryDedicatedAllocateInfo or VkDedicatedAllocationMemoryAllocateInfoNV structure with either its image or buffer member set to a value other than NULL_HANDLE.
- If the pNext chain includes a VkExportMemoryAllocateInfo structure, it must not include a VkExportMemoryAllocateInfoNV or VkExportMemoryWin32HandleInfoNV structure.
- If the pNext chain includes a VkImportMemoryWin32HandleInfoKHR structure, it must not include a VkImportMemoryWin32HandleInfoNV structure.
- If the parameters define an import operation, the external handle specified was created by the Vulkan API, and the external handle type is EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR, then the values of allocationSize and memoryTypeIndex must match those specified when the memory object being imported was created.
- If the parameters define an import operation and the external handle specified was created by the Vulkan API, the device mask specified by VkMemoryAllocateFlagsInfo must match that specified when the memory object being imported was allocated.
- If the parameters define an import operation and the external handle specified was created by the Vulkan API, the list of physical devices that comprise the logical device passed to AllocateMemory must match the list of physical devices that comprise the logical device on which the memory was originally allocated.
- If the parameters define an import operation and the external handle is an NT handle or a global share handle created outside of the Vulkan API, the value of memoryTypeIndex must be one of those returned by GetMemoryWin32HandlePropertiesKHR.
- If the parameters define an import operation, the external handle was created by the Vulkan API, and the external handle type is EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR or EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR, then the values of allocationSize and memoryTypeIndex must match those specified when the memory object being imported was created.
- If the parameters define an import operation and the external handle type is EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, or EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, allocationSize must match the size reported in the memory requirements of the image or buffer member of the VkDedicatedAllocationMemoryAllocateInfoNV structure included in the pNext chain.
- If the parameters define an import operation and the external handle type is EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, allocationSize must match the size specified when creating the Direct3D 12 heap from which the external handle was extracted.
- If the parameters define an import operation and the external handle is a POSIX file descriptor created outside of the Vulkan API, the value of memoryTypeIndex must be one of those returned by GetMemoryFdPropertiesKHR.
- If the protected memory feature is not enabled, the VkMemoryAllocateInfo::memoryTypeIndex must not indicate a memory type that reports MEMORY_PROPERTY_PROTECTED_BIT.
- If the parameters define an import operation and the external handle is a host pointer, the value of memoryTypeIndex must be one of those returned by GetMemoryHostPointerPropertiesEXT
- If the parameters define an import operation and the external handle is a host pointer, allocationSize must be an integer multiple of VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
- If the parameters define an import operation and the external handle is a host pointer, the pNext chain must not include a VkDedicatedAllocationMemoryAllocateInfoNV structure with either its image or buffer field set to a value other than NULL_HANDLE.
- If the parameters define an import operation and the external handle is a host pointer, the pNext chain must not include a VkMemoryDedicatedAllocateInfo structure with either its image or buffer field set to a value other than NULL_HANDLE.
- If VkMemoryOpaqueCaptureAddressAllocateInfoKHR::opaqueCaptureAddress is not zero, VkMemoryAllocateFlagsInfo::flags must include MEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR
- If VkMemoryAllocateFlagsInfo::flags includes MEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR, the bufferDeviceAddressCaptureReplay feature must be enabled
- If VkMemoryAllocateFlagsInfo::flags includes MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT_KHR, the bufferDeviceAddress feature must be enabled
- If the pNext chain includes a VkImportMemoryHostPointerInfoEXT structure, VkMemoryOpaqueCaptureAddressAllocateInfoKHR::opaqueCaptureAddress must be zero
- If the parameters define an import operation, VkMemoryOpaqueCaptureAddressAllocateInfoKHR::opaqueCaptureAddress must be zero
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_MEMORY_ALLOCATE_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 VkDedicatedAllocationMemoryAllocateInfoNV, VkExportMemoryAllocateInfo, VkExportMemoryAllocateInfoNV, VkExportMemoryWin32HandleInfoKHR, VkExportMemoryWin32HandleInfoNV, VkImportMemoryFdInfoKHR, VkImportMemoryHostPointerInfoEXT, VkImportMemoryWin32HandleInfoKHR, VkImportMemoryWin32HandleInfoNV, VkMemoryAllocateFlagsInfo, VkMemoryDedicatedAllocateInfo, VkMemoryOpaqueCaptureAddressAllocateInfoKHR, or VkMemoryPriorityAllocateInfoEXT
- Each sType member in the pNext chain must be unique
See Also

AllocateMemory

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- allocationSize – the size of the allocation in bytes
- memoryTypeIndex – an index identifying a memory type from the memoryTypes array of the VkPhysicalDeviceMemoryProperties structure
Layout
```
 struct VkMemoryAllocateInfo {
     VkStructureType sType;
     void const * pNext;
     VkDeviceSize allocationSize;
     uint32_t memoryTypeIndex;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkMemoryAllocateInfo.Buffer
An array of VkMemoryAllocateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkMemoryAllocateInfo.Buffer` An array of `VkMemoryAllocateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ALLOCATIONSIZE` The struct member offsets.
`static int`	`MEMORYTYPEINDEX` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkMemoryAllocateInfo(java.nio.ByteBuffer container)` Creates a `VkMemoryAllocateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`allocationSize()` Returns the value of the `allocationSize` field.
`VkMemoryAllocateInfo`	`allocationSize(long value)` Sets the specified value to the `allocationSize` field.
`static VkMemoryAllocateInfo`	`calloc()` Returns a new `VkMemoryAllocateInfo` instance allocated with `memCalloc`.
`static VkMemoryAllocateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkMemoryAllocateInfo.Buffer` instance allocated with `memCalloc`.
`static VkMemoryAllocateInfo`	`callocStack()` Returns a new `VkMemoryAllocateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkMemoryAllocateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateInfo`	`create()` Returns a new `VkMemoryAllocateInfo` instance allocated with `BufferUtils`.
`static VkMemoryAllocateInfo.Buffer`	`create(int capacity)` Returns a new `VkMemoryAllocateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkMemoryAllocateInfo`	`create(long address)` Returns a new `VkMemoryAllocateInfo` instance for the specified memory address.
`static VkMemoryAllocateInfo.Buffer`	`create(long address, int capacity)` Create a `VkMemoryAllocateInfo.Buffer` instance at the specified memory.
`static VkMemoryAllocateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkMemoryAllocateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkMemoryAllocateInfo`	`malloc()` Returns a new `VkMemoryAllocateInfo` instance allocated with `memAlloc`.
`static VkMemoryAllocateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkMemoryAllocateInfo.Buffer` instance allocated with `memAlloc`.
`static VkMemoryAllocateInfo`	`mallocStack()` Returns a new `VkMemoryAllocateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryAllocateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkMemoryAllocateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryAllocateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkMemoryAllocateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateInfo` instance allocated on the specified `MemoryStack`.
`int`	`memoryTypeIndex()` Returns the value of the `memoryTypeIndex` field.
`VkMemoryAllocateInfo`	`memoryTypeIndex(int value)` Sets the specified value to the `memoryTypeIndex` field.
`static long`	`nallocationSize(long struct)` Unsafe version of `allocationSize()`.
`static void`	`nallocationSize(long struct, long value)` Unsafe version of `allocationSize`.
`static int`	`nmemoryTypeIndex(long struct)` Unsafe version of `memoryTypeIndex()`.
`static void`	`nmemoryTypeIndex(long struct, int value)` Unsafe version of `memoryTypeIndex`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkMemoryAllocateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkMemoryAllocateInfo`	`set(int sType, long pNext, long allocationSize, int memoryTypeIndex)` Initializes this struct with the specified values.
`VkMemoryAllocateInfo`	`set(VkMemoryAllocateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkMemoryAllocateInfo`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - ALLOCATIONSIZE
```
public static final int ALLOCATIONSIZE
```
    The struct member offsets.
  - MEMORYTYPEINDEX
```
public static final int MEMORYTYPEINDEX
```
    The struct member offsets.
- Constructor Detail
  - VkMemoryAllocateInfo
```
public VkMemoryAllocateInfo(java.nio.ByteBuffer container)
```
    Creates a VkMemoryAllocateInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - allocationSize
```
public long allocationSize()
```
    Returns the value of the allocationSize field.
  - memoryTypeIndex
```
public int memoryTypeIndex()
```
    Returns the value of the memoryTypeIndex field.
  - sType
```
public VkMemoryAllocateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkMemoryAllocateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - allocationSize
```
public VkMemoryAllocateInfo allocationSize(long value)
```
    Sets the specified value to the allocationSize field.
  - memoryTypeIndex
```
public VkMemoryAllocateInfo memoryTypeIndex(int value)
```
    Sets the specified value to the memoryTypeIndex field.
  - set
```
public VkMemoryAllocateInfo set(int sType,
                                long pNext,
                                long allocationSize,
                                int memoryTypeIndex)
```
    Initializes this struct with the specified values.
  - set
```
public VkMemoryAllocateInfo set(VkMemoryAllocateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkMemoryAllocateInfo malloc()
```
    Returns a new VkMemoryAllocateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkMemoryAllocateInfo calloc()
```
    Returns a new VkMemoryAllocateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkMemoryAllocateInfo create()
```
    Returns a new VkMemoryAllocateInfo instance allocated with BufferUtils.
  - create
```
public static VkMemoryAllocateInfo create(long address)
```
    Returns a new VkMemoryAllocateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkMemoryAllocateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkMemoryAllocateInfo.Buffer malloc(int capacity)
```
    Returns a new VkMemoryAllocateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkMemoryAllocateInfo.Buffer calloc(int capacity)
```
    Returns a new VkMemoryAllocateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkMemoryAllocateInfo.Buffer create(int capacity)
```
    Returns a new VkMemoryAllocateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkMemoryAllocateInfo.Buffer create(long address,
                                                 int capacity)
```
    Create a VkMemoryAllocateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkMemoryAllocateInfo.Buffer createSafe(long address,
                                                               int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkMemoryAllocateInfo mallocStack()
```
    Returns a new VkMemoryAllocateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkMemoryAllocateInfo callocStack()
```
    Returns a new VkMemoryAllocateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkMemoryAllocateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkMemoryAllocateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkMemoryAllocateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryAllocateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkMemoryAllocateInfo.Buffer mallocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryAllocateInfo.Buffer callocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nallocationSize
```
public static long nallocationSize(long struct)
```
    Unsafe version of allocationSize().
  - nmemoryTypeIndex
```
public static int nmemoryTypeIndex(long struct)
```
    Unsafe version of memoryTypeIndex().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nallocationSize
```
public static void nallocationSize(long struct,
                                   long value)
```
    Unsafe version of allocationSize.
  - nmemoryTypeIndex
```
public static void nmemoryTypeIndex(long struct,
                                    int value)
```
    Unsafe version of memoryTypeIndex.

Class VkMemoryAllocateInfo

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

ALLOCATIONSIZE

MEMORYTYPEINDEX

Constructor Detail

VkMemoryAllocateInfo

Method Detail

sizeof

sType

pNext

allocationSize

memoryTypeIndex

sType

pNext

allocationSize

memoryTypeIndex

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nallocationSize

nmemoryTypeIndex

nsType

npNext

nallocationSize

nmemoryTypeIndex