org.lwjgl.util.vma.VmaAllocationCreateInfo

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VmaAllocationCreateInfo extends Struct<VmaAllocationCreateInfo> implements NativeResource


 struct VmaAllocationCreateInfo {
     VmaAllocationCreateFlags flags;
     VmaMemoryUsage usage;
     VkMemoryPropertyFlags requiredFlags;
     VkMemoryPropertyFlags preferredFlags;
     uint32_t memoryTypeBits;
     VmaPool pool;
     void * pUserData;
     float priority;
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VmaAllocationCreateInfo.Buffer

An array of VmaAllocationCreateInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation

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

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

FLAGS

The struct member offsets.

static final int

MEMORYTYPEBITS

The struct member offsets.

static final int

POOL

The struct member offsets.

static final int

PREFERREDFLAGS

The struct member offsets.

static final int

PRIORITY

The struct member offsets.

static final int

PUSERDATA

The struct member offsets.

static final int

REQUIREDFLAGS

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

USAGE

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

Description

VmaAllocationCreateInfo(ByteBuffer container)

Creates a VmaAllocationCreateInfo instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static VmaAllocationCreateInfo

calloc()

Returns a new VmaAllocationCreateInfo instance allocated with memCalloc.

static VmaAllocationCreateInfo.Buffer

calloc(int capacity)

Returns a new VmaAllocationCreateInfo.Buffer instance allocated with memCalloc.

static VmaAllocationCreateInfo.Buffer

calloc(int capacity, MemoryStack stack)

Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

static VmaAllocationCreateInfo

calloc(MemoryStack stack)

Returns a new VmaAllocationCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

static VmaAllocationCreateInfo

callocStack()

Deprecated.

static VmaAllocationCreateInfo.Buffer

callocStack(int capacity)

Deprecated.

static VmaAllocationCreateInfo.Buffer

callocStack(int capacity, MemoryStack stack)

Deprecated.

static VmaAllocationCreateInfo

callocStack(MemoryStack stack)

Deprecated.

static VmaAllocationCreateInfo

create()

Returns a new VmaAllocationCreateInfo instance allocated with BufferUtils.

static VmaAllocationCreateInfo.Buffer

create(int capacity)

Returns a new VmaAllocationCreateInfo.Buffer instance allocated with BufferUtils.

static VmaAllocationCreateInfo

create(long address)

Returns a new VmaAllocationCreateInfo instance for the specified memory address.

static VmaAllocationCreateInfo.Buffer

create(long address, int capacity)

Create a VmaAllocationCreateInfo.Buffer instance at the specified memory.

static @Nullable VmaAllocationCreateInfo

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VmaAllocationCreateInfo.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

flags()

VmaAllocationCreateInfo

flags(int value)

Sets the specified value to the flags field.

static VmaAllocationCreateInfo

malloc()

Returns a new VmaAllocationCreateInfo instance allocated with memAlloc.

static VmaAllocationCreateInfo.Buffer

malloc(int capacity)

Returns a new VmaAllocationCreateInfo.Buffer instance allocated with memAlloc.

static VmaAllocationCreateInfo.Buffer

malloc(int capacity, MemoryStack stack)

Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack.

static VmaAllocationCreateInfo

malloc(MemoryStack stack)

Returns a new VmaAllocationCreateInfo instance allocated on the specified MemoryStack.

static VmaAllocationCreateInfo

mallocStack()

Deprecated.

static VmaAllocationCreateInfo.Buffer

mallocStack(int capacity)

Deprecated.

static VmaAllocationCreateInfo.Buffer

mallocStack(int capacity, MemoryStack stack)

Deprecated.

static VmaAllocationCreateInfo

mallocStack(MemoryStack stack)

Deprecated.

int

memoryTypeBits()

VmaAllocationCreateInfo

memoryTypeBits(int value)

Sets the specified value to the memoryTypeBits field.

static int

nflags(long struct)

Unsafe version of flags().

static void

nflags(long struct, int value)

Unsafe version of flags.

static int

nmemoryTypeBits(long struct)

Unsafe version of memoryTypeBits().

static void

nmemoryTypeBits(long struct, int value)

Unsafe version of memoryTypeBits.

static long

npool(long struct)

Unsafe version of pool().

static void

npool(long struct, long value)

Unsafe version of pool.

static int

npreferredFlags(long struct)

Unsafe version of preferredFlags().

static void

npreferredFlags(long struct, int value)

Unsafe version of preferredFlags.

static float

npriority(long struct)

Unsafe version of priority().

static void

npriority(long struct, float value)

Unsafe version of priority.

static long

npUserData(long struct)

Unsafe version of pUserData().

static void

npUserData(long struct, long value)

Unsafe version of pUserData.

static int

nrequiredFlags(long struct)

Unsafe version of requiredFlags().

static void

nrequiredFlags(long struct, int value)

Unsafe version of requiredFlags.

static int

nusage(long struct)

Unsafe version of usage().

static void

nusage(long struct, int value)

Unsafe version of usage.

long

pool()

VmaAllocationCreateInfo

pool(long value)

Sets the specified value to the pool field.

int

preferredFlags()

VmaAllocationCreateInfo

preferredFlags(int value)

Sets the specified value to the preferredFlags field.

float

priority()

VmaAllocationCreateInfo

priority(float value)

Sets the specified value to the priority field.

long

pUserData()

VmaAllocationCreateInfo

pUserData(long value)

Sets the specified value to the pUserData field.

int

requiredFlags()

VmaAllocationCreateInfo

requiredFlags(int value)

Sets the specified value to the requiredFlags field.

VmaAllocationCreateInfo

set(int flags, int usage, int requiredFlags, int preferredFlags, int memoryTypeBits, long pool, long pUserData, float priority)

Initializes this struct with the specified values.

VmaAllocationCreateInfo

set(VmaAllocationCreateInfo src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

int

usage()

VmaAllocationCreateInfo

usage(int value)

Sets the specified value to the usage field.

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

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 Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- FLAGS
  
  public static final int FLAGS
  
  The struct member offsets.
- USAGE
  
  public static final int USAGE
  
  The struct member offsets.
- REQUIREDFLAGS
  
  public static final int REQUIREDFLAGS
  
  The struct member offsets.
- PREFERREDFLAGS
  
  public static final int PREFERREDFLAGS
  
  The struct member offsets.
- MEMORYTYPEBITS
  
  public static final int MEMORYTYPEBITS
  
  The struct member offsets.
- POOL
  
  public static final int POOL
  
  The struct member offsets.
- PUSERDATA
  
  public static final int PUSERDATA
  
  The struct member offsets.
- PRIORITY
  
  public static final int PRIORITY
  
  The struct member offsets.
Constructor Details
- VmaAllocationCreateInfo
  
  public VmaAllocationCreateInfo(ByteBuffer container)
  
  Creates a VmaAllocationCreateInfo 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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<VmaAllocationCreateInfo>
- flags
  
  public int flags()
  
  Returns:
  
  the value of the flags field.
- usage
  
  public int usage()
  
  Returns:
  
  the value of the usage field.
- requiredFlags
  
  public int requiredFlags()
  
  Returns:
  
  the value of the requiredFlags field.
- preferredFlags
  
  public int preferredFlags()
  
  Returns:
  
  the value of the preferredFlags field.
- memoryTypeBits
  
  public int memoryTypeBits()
  
  Returns:
  
  the value of the memoryTypeBits field.
- pool
  
  public long pool()
  
  Returns:
  
  the value of the pool field.
- pUserData
  
  public long pUserData()
  
  Returns:
  
  the value of the pUserData field.
- priority
  
  public float priority()
  
  Returns:
  
  the value of the priority field.
- flags
  
  public VmaAllocationCreateInfo flags(int value)
  
  Sets the specified value to the flags field.
- usage
  
  public VmaAllocationCreateInfo usage(int value)
  
  Sets the specified value to the usage field.
- requiredFlags
  
  public VmaAllocationCreateInfo requiredFlags(int value)
  
  Sets the specified value to the requiredFlags field.
- preferredFlags
  
  public VmaAllocationCreateInfo preferredFlags(int value)
  
  Sets the specified value to the preferredFlags field.
- memoryTypeBits
  
  public VmaAllocationCreateInfo memoryTypeBits(int value)
  
  Sets the specified value to the memoryTypeBits field.
- pool
  
  public VmaAllocationCreateInfo pool(long value)
  
  Sets the specified value to the pool field.
- pUserData
  
  public VmaAllocationCreateInfo pUserData(long value)
  
  Sets the specified value to the pUserData field.
- priority
  
  public VmaAllocationCreateInfo priority(float value)
  
  Sets the specified value to the priority field.
- set
  
  public VmaAllocationCreateInfo set(int flags, int usage, int requiredFlags, int preferredFlags, int memoryTypeBits, long pool, long pUserData, float priority)
  
  Initializes this struct with the specified values.
- set
  
  public VmaAllocationCreateInfo set(VmaAllocationCreateInfo src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VmaAllocationCreateInfo malloc()
  
  Returns a new VmaAllocationCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VmaAllocationCreateInfo calloc()
  
  Returns a new VmaAllocationCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VmaAllocationCreateInfo create()
  
  Returns a new VmaAllocationCreateInfo instance allocated with BufferUtils.
- create
  
  public static VmaAllocationCreateInfo create(long address)
  
  Returns a new VmaAllocationCreateInfo instance for the specified memory address.
- createSafe
  
  public static @Nullable VmaAllocationCreateInfo createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VmaAllocationCreateInfo.Buffer malloc(int capacity)
  
  Returns a new VmaAllocationCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VmaAllocationCreateInfo.Buffer calloc(int capacity)
  
  Returns a new VmaAllocationCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VmaAllocationCreateInfo.Buffer create(int capacity)
  
  Returns a new VmaAllocationCreateInfo.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VmaAllocationCreateInfo.Buffer create(long address, int capacity)
  
  Create a VmaAllocationCreateInfo.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VmaAllocationCreateInfo.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static VmaAllocationCreateInfo mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VmaAllocationCreateInfo callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VmaAllocationCreateInfo mallocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VmaAllocationCreateInfo callocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VmaAllocationCreateInfo.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VmaAllocationCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VmaAllocationCreateInfo malloc(MemoryStack stack)
  
  Returns a new VmaAllocationCreateInfo instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VmaAllocationCreateInfo calloc(MemoryStack stack)
  
  Returns a new VmaAllocationCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VmaAllocationCreateInfo.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VmaAllocationCreateInfo.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- nflags
  
  public static int nflags(long struct)
  
  Unsafe version of flags().
- nusage
  
  public static int nusage(long struct)
  
  Unsafe version of usage().
- nrequiredFlags
  
  public static int nrequiredFlags(long struct)
  
  Unsafe version of requiredFlags().
- npreferredFlags
  
  public static int npreferredFlags(long struct)
  
  Unsafe version of preferredFlags().
- nmemoryTypeBits
  
  public static int nmemoryTypeBits(long struct)
  
  Unsafe version of memoryTypeBits().
- npool
  
  public static long npool(long struct)
  
  Unsafe version of pool().
- npUserData
  
  public static long npUserData(long struct)
  
  Unsafe version of pUserData().
- npriority
  
  public static float npriority(long struct)
  
  Unsafe version of priority().
- nflags
  
  public static void nflags(long struct, int value)
  
  Unsafe version of flags.
- nusage
  
  public static void nusage(long struct, int value)
  
  Unsafe version of usage.
- nrequiredFlags
  
  public static void nrequiredFlags(long struct, int value)
  
  Unsafe version of requiredFlags.
- npreferredFlags
  
  public static void npreferredFlags(long struct, int value)
  
  Unsafe version of preferredFlags.
- nmemoryTypeBits
  
  public static void nmemoryTypeBits(long struct, int value)
  
  Unsafe version of memoryTypeBits.
- npool
  
  public static void npool(long struct, long value)
  
  Unsafe version of pool.
- npUserData
  
  public static void npUserData(long struct, long value)
  
  Unsafe version of pUserData.
- npriority
  
  public static void npriority(long struct, float value)
  
  Unsafe version of priority.

Class VmaAllocationCreateInfo

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

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 Details

SIZEOF

ALIGNOF

FLAGS

USAGE

REQUIREDFLAGS

PREFERREDFLAGS

MEMORYTYPEBITS

POOL

PUSERDATA

PRIORITY

Constructor Details

VmaAllocationCreateInfo

Method Details

sizeof

flags

usage

requiredFlags

preferredFlags

memoryTypeBits

pool

pUserData

priority

flags

usage

requiredFlags

preferredFlags

memoryTypeBits

pool

pUserData

priority

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nflags

nusage

nrequiredFlags

npreferredFlags

nmemoryTypeBits

npool

npUserData

npriority

nflags

nusage

nrequiredFlags

npreferredFlags

nmemoryTypeBits