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

public Class VmaVirtualAllocationInfo

extends Struct<VmaVirtualAllocationInfo>
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 an existing virtual allocation, returned by GetVirtualAllocationInfo.

Layout


struct VmaVirtualAllocationInfo {
    VkDeviceSize offset;
    VkDeviceSize size;
    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
ALIGNOF

The struct alignment in bytes.

public static final int
OFFSET

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
VmaVirtualAllocationInfo(long address, ByteBuffer container)

public
VmaVirtualAllocationInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VmaVirtualAllocationInfo
calloc()

Returns a new VmaVirtualAllocationInfo instance allocated with memCalloc.

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

Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with memCalloc.

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

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

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

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

protected VmaVirtualAllocationInfo
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 VmaVirtualAllocationInfo
create()

Returns a new VmaVirtualAllocationInfo instance allocated with BufferUtils.

public static VmaVirtualAllocationInfo
create(long address)

Returns a new VmaVirtualAllocationInfo instance for the specified memory address.

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

Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with BufferUtils.

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

Create a VmaVirtualAllocationInfo.Buffer instance at the specified memory.

public static VmaVirtualAllocationInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VmaVirtualAllocationInfo
malloc()

Returns a new VmaVirtualAllocationInfo instance allocated with memAlloc.

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

Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with memAlloc.

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

Returns a new VmaVirtualAllocationInfo instance allocated on the specified MemoryStack.

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

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

public static long
noffset(long struct)

Unsafe version of offset.

public static long
npUserData(long struct)

Unsafe version of pUserData.

public static long
nsize(long struct)

Unsafe version of size.

public long
offset()

offset of the allocation.

public long
pUserData()

custom pointer associated with the allocation.

public long
size()

size of the allocation.

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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

OFFSETback to summary
public static final int OFFSET

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

VmaVirtualAllocationInfoback to summary
protected VmaVirtualAllocationInfo(long address, ByteBuffer container)
VmaVirtualAllocationInfoback to summary
public VmaVirtualAllocationInfo(ByteBuffer container)

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

callocback to summary
public static VmaVirtualAllocationInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaVirtualAllocationInfo calloc(MemoryStack stack)

Returns a new VmaVirtualAllocationInfo 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 VmaVirtualAllocationInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VmaVirtualAllocationInfo.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 VmaVirtualAllocationInfo 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 VmaVirtualAllocationInfo create()

Returns a new VmaVirtualAllocationInfo instance allocated with BufferUtils.

createback to summary
public static VmaVirtualAllocationInfo create(long address)

Returns a new VmaVirtualAllocationInfo instance for the specified memory address.

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

Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VmaVirtualAllocationInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaVirtualAllocationInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VmaVirtualAllocationInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaVirtualAllocationInfo malloc(MemoryStack stack)

Returns a new VmaVirtualAllocationInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

noffsetback to summary
public static long noffset(long struct)

Unsafe version of offset.

npUserDataback to summary
public static long npUserData(long struct)

Unsafe version of pUserData.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

offsetback to summary
public long offset()

offset of the allocation.

Offset at which the allocation was made.

Annotations
@NativeType:VkDeviceSize
pUserDataback to summary
public long pUserData()

custom pointer associated with the allocation.

Same value as passed in VmaVirtualAllocationCreateInfo::pUserData or to SetVirtualAllocationUserData.

Annotations
@NativeType:void *
sizeback to summary
public long size()

size of the allocation.

Same value as passed in VmaVirtualAllocationCreateInfo::size.

Annotations
@NativeType:VkDeviceSize
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 VmaVirtualAllocationInfo.Buffer

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

An array of VmaVirtualAllocationInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VmaVirtualAllocationInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaVirtualAllocationInfo.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
protected VmaVirtualAllocationInfo
public long

Returns:

the value of the VmaVirtualAllocationInfo#offset field.
offset
()

public long

Returns:

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

protected VmaVirtualAllocationInfo.Buffer
public long

Returns:

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaVirtualAllocationInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VmaVirtualAllocationInfo.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 VmaVirtualAllocationInfo#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

getElementFactoryback to summary
protected VmaVirtualAllocationInfo getElementFactory()

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

Annotations
@Override
offsetback to summary
public long offset()
Returns:long

the value of the VmaVirtualAllocationInfo#offset field.

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

the value of the VmaVirtualAllocationInfo#pUserData field.

Annotations
@NativeType:void *
selfback to summary
protected VmaVirtualAllocationInfo.Buffer self()

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

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

the value of the VmaVirtualAllocationInfo#size field.

Annotations
@NativeType:VkDeviceSize