VmaAllocationInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.vma.VmaAllocationInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VmaAllocationInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Parameters of VmaAllocation objects, that can be retrieved using function GetAllocationInfo.
Member documentation
- memoryType – memory type index that this allocation was allocated from.
  It never changes.
- deviceMemory – handle to Vulkan memory object.
  Same memory object can be shared by multiple allocations.
  
  It can change after call to Defragment if this allocation is passed to the function, or if allocation is lost.
  
  If the allocation is lost, it is equal to VK_NULL_HANDLE.
- offset – offset into deviceMemory object to the beginning of this allocation, in bytes. (deviceMemory, offset) pair is unique to this allocation.
  It can change after call to Defragment if this allocation is passed to the function, or if allocation is lost.
- size – size of this allocation, in bytes.
  It never changes, unless allocation is lost.
- pMappedData – pointer to the beginning of this allocation as mapped data.
  If the allocation hasn't been mapped using MapMemory and hasn't been created with ALLOCATION_CREATE_MAPPED_BIT flag, this value null.
  
  It can change after call to MapMemory, UnmapMemory. It can also change after call to Defragment if this allocation is passed to the function.
- pUserData – custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using SetAllocationUserData.
  It can change after call to SetAllocationUserData for this allocation.
Layout
```
 struct VmaAllocationInfo {
     uint32_t memoryType;
     VkDeviceMemory deviceMemory;
     VkDeviceSize offset;
     VkDeviceSize size;
     void * pMappedData;
     void * pUserData;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VmaAllocationInfo.Buffer
An array of VmaAllocationInfo 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`	`VmaAllocationInfo.Buffer` An array of `VmaAllocationInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DEVICEMEMORY` The struct member offsets.
`static int`	`MEMORYTYPE` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`PMAPPEDDATA` The struct member offsets.
`static int`	`PUSERDATA` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

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

Constructor Summary

Constructors
Constructor and Description

VmaAllocationInfo(java.nio.ByteBuffer container)
Creates a VmaAllocationInfo instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`VmaAllocationInfo(java.nio.ByteBuffer container)` Creates a `VmaAllocationInfo` 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
`static VmaAllocationInfo`	`calloc()` Returns a new `VmaAllocationInfo` instance allocated with `memCalloc`.
`static VmaAllocationInfo.Buffer`	`calloc(int capacity)` Returns a new `VmaAllocationInfo.Buffer` instance allocated with `memCalloc`.
`static VmaAllocationInfo`	`callocStack()` Returns a new `VmaAllocationInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationInfo.Buffer`	`callocStack(int capacity)` Returns a new `VmaAllocationInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationInfo`	`create()` Returns a new `VmaAllocationInfo` instance allocated with `BufferUtils`.
`static VmaAllocationInfo.Buffer`	`create(int capacity)` Returns a new `VmaAllocationInfo.Buffer` instance allocated with `BufferUtils`.
`static VmaAllocationInfo`	`create(long address)` Returns a new `VmaAllocationInfo` instance for the specified memory address.
`static VmaAllocationInfo.Buffer`	`create(long address, int capacity)` Create a `VmaAllocationInfo.Buffer` instance at the specified memory.
`static VmaAllocationInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaAllocationInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`deviceMemory()` Returns the value of the `deviceMemory` field.
`static VmaAllocationInfo`	`malloc()` Returns a new `VmaAllocationInfo` instance allocated with `memAlloc`.
`static VmaAllocationInfo.Buffer`	`malloc(int capacity)` Returns a new `VmaAllocationInfo.Buffer` instance allocated with `memAlloc`.
`static VmaAllocationInfo`	`mallocStack()` Returns a new `VmaAllocationInfo` instance allocated on the thread-local `MemoryStack`.
`static VmaAllocationInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VmaAllocationInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaAllocationInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaAllocationInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationInfo` instance allocated on the specified `MemoryStack`.
`int`	`memoryType()` Returns the value of the `memoryType` field.
`static long`	`ndeviceMemory(long struct)` Unsafe version of `deviceMemory()`.
`static int`	`nmemoryType(long struct)` Unsafe version of `memoryType()`.
`static long`	`noffset(long struct)` Unsafe version of `offset()`.
`static long`	`npMappedData(long struct)` Unsafe version of `pMappedData()`.
`static long`	`npUserData(long struct)` Unsafe version of `pUserData()`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`long`	`offset()` Returns the value of the `offset` field.
`long`	`pMappedData()` Returns the value of the `pMappedData` field.
`long`	`pUserData()` Returns the value of the `pUserData` field.
`long`	`size()` Returns the value of the `size` field.
`int`	`sizeof()`

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.
  - MEMORYTYPE
```
public static final int MEMORYTYPE
```
    The struct member offsets.
  - DEVICEMEMORY
```
public static final int DEVICEMEMORY
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
  - PMAPPEDDATA
```
public static final int PMAPPEDDATA
```
    The struct member offsets.
  - PUSERDATA
```
public static final int PUSERDATA
```
    The struct member offsets.
- Constructor Detail
  - VmaAllocationInfo
```
public VmaAllocationInfo(java.nio.ByteBuffer container)
```
    Creates a VmaAllocationInfo 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
  - memoryType
```
public int memoryType()
```
    Returns the value of the memoryType field.
  - deviceMemory
```
public long deviceMemory()
```
    Returns the value of the deviceMemory field.
  - offset
```
public long offset()
```
    Returns the value of the offset field.
  - size
```
public long size()
```
    Returns the value of the size field.
  - pMappedData
```
public long pMappedData()
```
    Returns the value of the pMappedData field.
  - pUserData
```
public long pUserData()
```
    Returns the value of the pUserData field.
  - malloc
```
public static VmaAllocationInfo malloc()
```
    Returns a new VmaAllocationInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VmaAllocationInfo calloc()
```
    Returns a new VmaAllocationInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VmaAllocationInfo create()
```
    Returns a new VmaAllocationInfo instance allocated with BufferUtils.
  - create
```
public static VmaAllocationInfo create(long address)
```
    Returns a new VmaAllocationInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VmaAllocationInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VmaAllocationInfo.Buffer malloc(int capacity)
```
    Returns a new VmaAllocationInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VmaAllocationInfo.Buffer calloc(int capacity)
```
    Returns a new VmaAllocationInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaAllocationInfo.Buffer create(int capacity)
```
    Returns a new VmaAllocationInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaAllocationInfo.Buffer create(long address,
                                              int capacity)
```
    Create a VmaAllocationInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VmaAllocationInfo.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaAllocationInfo mallocStack()
```
    Returns a new VmaAllocationInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaAllocationInfo callocStack()
```
    Returns a new VmaAllocationInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaAllocationInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaAllocationInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VmaAllocationInfo.Buffer mallocStack(int capacity)
```
    Returns a new VmaAllocationInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaAllocationInfo.Buffer callocStack(int capacity)
```
    Returns a new VmaAllocationInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaAllocationInfo.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaAllocationInfo.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationInfo.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
  - nmemoryType
```
public static int nmemoryType(long struct)
```
    Unsafe version of memoryType().
  - ndeviceMemory
```
public static long ndeviceMemory(long struct)
```
    Unsafe version of deviceMemory().
  - noffset
```
public static long noffset(long struct)
```
    Unsafe version of offset().
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - npMappedData
```
public static long npMappedData(long struct)
```
    Unsafe version of pMappedData().
  - npUserData
```
public static long npUserData(long struct)
```
    Unsafe version of pUserData().

Class VmaAllocationInfo

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

MEMORYTYPE

DEVICEMEMORY

OFFSET

SIZE

PMAPPEDDATA

PUSERDATA

Constructor Detail

VmaAllocationInfo

Method Detail

sizeof

memoryType

deviceMemory

offset

size

pMappedData

pUserData

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmemoryType

ndeviceMemory

noffset

nsize

npMappedData

npUserData