Top Description Inners Fields Constructors Methods
org.lwjgl.util.vma

public Class VmaVirtualAllocationCreateInfo

extends Struct<VmaVirtualAllocationCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Parameters of created virtual allocation to be passed to VirtualAllocate.

Layout


struct VmaVirtualAllocationCreateInfo {
    VkDeviceSize size;
    VkDeviceSize alignment;
    VmaVirtualAllocationCreateFlags flags;
    void * pUserData;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNMENT

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
PUSERDATA

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VmaVirtualAllocationCreateInfo(long address, ByteBuffer container)

public
VmaVirtualAllocationCreateInfo(ByteBuffer container)

Creates a VmaVirtualAllocationCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public long
alignment()

required alignment of the allocation.

public VmaVirtualAllocationCreateInfo
alignment(long value)

Sets the specified value to the alignment field.

public static VmaVirtualAllocationCreateInfo
calloc()

Returns a new VmaVirtualAllocationCreateInfo instance allocated with memCalloc.

public static VmaVirtualAllocationCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with memCalloc.

public static VmaVirtualAllocationCreateInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VmaVirtualAllocationCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VmaVirtualAllocationCreateInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VmaVirtualAllocationCreateInfo
create()

Returns a new VmaVirtualAllocationCreateInfo instance allocated with BufferUtils.

public static VmaVirtualAllocationCreateInfo
create(long address)

Returns a new VmaVirtualAllocationCreateInfo instance for the specified memory address.

public static VmaVirtualAllocationCreateInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with BufferUtils.

public static VmaVirtualAllocationCreateInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VmaVirtualAllocationCreateInfo.Buffer instance at the specified memory.

public static VmaVirtualAllocationCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VmaVirtualAllocationCreateInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
flags()

use combination of VmaVirtualAllocationCreateFlagBits.

public VmaVirtualAllocationCreateInfo
flags(int value)

Sets the specified value to the flags field.

public static VmaVirtualAllocationCreateInfo
malloc()

Returns a new VmaVirtualAllocationCreateInfo instance allocated with memAlloc.

public static VmaVirtualAllocationCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with memAlloc.

public static VmaVirtualAllocationCreateInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VmaVirtualAllocationCreateInfo instance allocated on the specified MemoryStack.

public static VmaVirtualAllocationCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
nalignment(long struct)

Unsafe version of alignment.

public static void
nalignment(long struct, long value)

Unsafe version of alignment.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npUserData(long struct)

Unsafe version of pUserData.

public static void
npUserData(long struct, long value)

Unsafe version of pUserData.

public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

Unsafe version of size.

public long
pUserData()

custom pointer to be associated with the allocation.

public VmaVirtualAllocationCreateInfo
pUserData(long value)

Sets the specified value to the pUserData field.

public VmaVirtualAllocationCreateInfo
set(long size, long alignment, int flags, long pUserData)

Initializes this struct with the specified values.

public VmaVirtualAllocationCreateInfo

Returns:

this struct
set
(VmaVirtualAllocationCreateInfo
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

size of the allocation.

public VmaVirtualAllocationCreateInfo
size(long value)

Sets the specified value to the size field.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNMENTback to summary
public static final int ALIGNMENT

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PUSERDATAback to summary
public static final int PUSERDATA

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VmaVirtualAllocationCreateInfoback to summary
protected VmaVirtualAllocationCreateInfo(long address, ByteBuffer container)
VmaVirtualAllocationCreateInfoback to summary
public VmaVirtualAllocationCreateInfo(ByteBuffer container)

Creates a VmaVirtualAllocationCreateInfo 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

alignmentback to summary
public long alignment()

required alignment of the allocation. Optional.

Must be power of two. Special value 0 has the same meaning as 1 - means no special alignment is required, so allocation can start at any offset.

Annotations
@NativeType:VkDeviceSize
alignmentback to summary
public VmaVirtualAllocationCreateInfo alignment(long value)

Sets the specified value to the alignment field.

callocback to summary
public static VmaVirtualAllocationCreateInfo calloc()

Returns a new VmaVirtualAllocationCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VmaVirtualAllocationCreateInfo.Buffer calloc(int capacity)

Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaVirtualAllocationCreateInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VmaVirtualAllocationCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VmaVirtualAllocationCreateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VmaVirtualAllocationCreateInfo create()

Returns a new VmaVirtualAllocationCreateInfo instance allocated with BufferUtils.

createback to summary
public static VmaVirtualAllocationCreateInfo create(long address)

Returns a new VmaVirtualAllocationCreateInfo instance for the specified memory address.

createback to summary
public static VmaVirtualAllocationCreateInfo.Buffer create(int capacity)

Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VmaVirtualAllocationCreateInfo.Buffer create(long address, int capacity)

Create a VmaVirtualAllocationCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaVirtualAllocationCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VmaVirtualAllocationCreateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

use combination of VmaVirtualAllocationCreateFlagBits. One or more of:

VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT
VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT
VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT
VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT
VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK
Annotations
@NativeType:VmaVirtualAllocationCreateFlags
flagsback to summary
public VmaVirtualAllocationCreateInfo flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VmaVirtualAllocationCreateInfo malloc()

Returns a new VmaVirtualAllocationCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VmaVirtualAllocationCreateInfo.Buffer malloc(int capacity)

Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaVirtualAllocationCreateInfo malloc(MemoryStack stack)

Returns a new VmaVirtualAllocationCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VmaVirtualAllocationCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nalignmentback to summary
public static long nalignment(long struct)

Unsafe version of alignment.

nalignmentback to summary
public static void nalignment(long struct, long value)

Unsafe version of alignment.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

npUserDataback to summary
public static long npUserData(long struct)

Unsafe version of pUserData.

npUserDataback to summary
public static void npUserData(long struct, long value)

Unsafe version of pUserData.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, long value)

Unsafe version of size.

pUserDataback to summary
public long pUserData()

custom pointer to be associated with the allocation. Optional.

It can be any value and can be used for user-defined purposes. It can be fetched or changed later.

Annotations
@NativeType:void *
pUserDataback to summary
public VmaVirtualAllocationCreateInfo pUserData(long value)

Sets the specified value to the pUserData field.

setback to summary
public VmaVirtualAllocationCreateInfo set(long size, long alignment, int flags, long pUserData)

Initializes this struct with the specified values.

setback to summary
public VmaVirtualAllocationCreateInfo set(VmaVirtualAllocationCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VmaVirtualAllocationCreateInfo

the source struct

Returns:VmaVirtualAllocationCreateInfo

this struct

sizeback to summary
public long size()

size of the allocation.

Cannot be zero.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VmaVirtualAllocationCreateInfo size(long value)

Sets the specified value to the size field.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.util.vma back to summary

public Class VmaVirtualAllocationCreateInfo.Buffer

extends StructBuffer<VmaVirtualAllocationCreateInfo, VmaVirtualAllocationCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VmaVirtualAllocationCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VmaVirtualAllocationCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaVirtualAllocationCreateInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VmaVirtualAllocationCreateInfo#alignment field.
alignment
()

public VmaVirtualAllocationCreateInfo.Buffer
alignment(long value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#alignment field.

public int

Returns:

the value of the VmaVirtualAllocationCreateInfo#flags field.
flags
()

public VmaVirtualAllocationCreateInfo.Buffer
flags(int value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#flags field.

protected VmaVirtualAllocationCreateInfo
public long

Returns:

the value of the VmaVirtualAllocationCreateInfo#pUserData field.
pUserData
()

public VmaVirtualAllocationCreateInfo.Buffer
pUserData(long value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#pUserData field.

protected VmaVirtualAllocationCreateInfo.Buffer
public long

Returns:

the value of the VmaVirtualAllocationCreateInfo#size field.
size
()

public VmaVirtualAllocationCreateInfo.Buffer
size(long value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#size field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaVirtualAllocationCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VmaVirtualAllocationCreateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VmaVirtualAllocationCreateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

alignmentback to summary
public long alignment()
Returns:long

the value of the VmaVirtualAllocationCreateInfo#alignment field.

Annotations
@NativeType:VkDeviceSize
alignmentback to summary
public VmaVirtualAllocationCreateInfo.Buffer alignment(long value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#alignment field.

flagsback to summary
public int flags()
Returns:int

the value of the VmaVirtualAllocationCreateInfo#flags field.

Annotations
@NativeType:VmaVirtualAllocationCreateFlags
flagsback to summary
public VmaVirtualAllocationCreateInfo.Buffer flags(int value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#flags field.

getElementFactoryback to summary
protected VmaVirtualAllocationCreateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pUserDataback to summary
public long pUserData()
Returns:long

the value of the VmaVirtualAllocationCreateInfo#pUserData field.

Annotations
@NativeType:void *
pUserDataback to summary
public VmaVirtualAllocationCreateInfo.Buffer pUserData(long value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#pUserData field.

selfback to summary
protected VmaVirtualAllocationCreateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VmaVirtualAllocationCreateInfo#size field.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VmaVirtualAllocationCreateInfo.Buffer size(long value)

Sets the specified value to the VmaVirtualAllocationCreateInfo#size field.