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

public Class VmaAllocatorInfo

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

Information about existing VmaAllocator object.

Layout


struct VmaAllocatorInfo {
    VkInstance instance;
    VkPhysicalDevice physicalDevice;
    VkDevice device;
}

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
DEVICE

The struct member offsets.

public static final int
INSTANCE

The struct member offsets.

public static final int
PHYSICALDEVICE

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

public
VmaAllocatorInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VmaAllocatorInfo
calloc()

Returns a new VmaAllocatorInfo instance allocated with memCalloc.

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

Returns a new VmaAllocatorInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VmaAllocatorInfo instance allocated with BufferUtils.

public static VmaAllocatorInfo
create(long address)

Returns a new VmaAllocatorInfo instance for the specified memory address.

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

Returns a new VmaAllocatorInfo.Buffer instance allocated with BufferUtils.

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

Create a VmaAllocatorInfo.Buffer instance at the specified memory.

public static VmaAllocatorInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
device()

Handle to Vulkan device object.

public long
instance()

Handle to Vulkan instance object.

public static VmaAllocatorInfo
malloc()

Returns a new VmaAllocatorInfo instance allocated with memAlloc.

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

Returns a new VmaAllocatorInfo.Buffer instance allocated with memAlloc.

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

Returns a new VmaAllocatorInfo instance allocated on the specified MemoryStack.

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

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

public static long
ndevice(long struct)

Unsafe version of device.

public static long
ninstance(long struct)

Unsafe version of instance.

public static long
nphysicalDevice(long struct)

Unsafe version of physicalDevice.

public long
physicalDevice()

Handle to Vulkan physical device object.

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.

DEVICEback to summary
public static final int DEVICE

The struct member offsets.

INSTANCEback to summary
public static final int INSTANCE

The struct member offsets.

PHYSICALDEVICEback to summary
public static final int PHYSICALDEVICE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VmaAllocatorInfoback to summary
protected VmaAllocatorInfo(long address, ByteBuffer container)
VmaAllocatorInfoback to summary
public VmaAllocatorInfo(ByteBuffer container)

Creates a VmaAllocatorInfo 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 VmaAllocatorInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaAllocatorInfo calloc(MemoryStack stack)

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

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

Returns a new VmaAllocatorInfo instance allocated with BufferUtils.

createback to summary
public static VmaAllocatorInfo create(long address)

Returns a new VmaAllocatorInfo instance for the specified memory address.

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

Returns a new VmaAllocatorInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VmaAllocatorInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaAllocatorInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceback to summary
public long device()

Handle to Vulkan device object.

This is the same value as has been passed through VmaAllocatorCreateInfo::device.

Annotations
@NativeType:VkDevice
instanceback to summary
public long instance()

Handle to Vulkan instance object.

This is the same value as has been passed through VmaAllocatorCreateInfo::instance.

Annotations
@NativeType:VkInstance
mallocback to summary
public static VmaAllocatorInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaAllocatorInfo malloc(MemoryStack stack)

Returns a new VmaAllocatorInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndeviceback to summary
public static long ndevice(long struct)

Unsafe version of device.

ninstanceback to summary
public static long ninstance(long struct)

Unsafe version of instance.

nphysicalDeviceback to summary
public static long nphysicalDevice(long struct)

Unsafe version of physicalDevice.

physicalDeviceback to summary
public long physicalDevice()

Handle to Vulkan physical device object.

This is the same value as has been passed through VmaAllocatorCreateInfo::physicalDevice.

Annotations
@NativeType:VkPhysicalDevice
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 VmaAllocatorInfo.Buffer

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

An array of VmaAllocatorInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VmaAllocatorInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaAllocatorInfo.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 VmaAllocatorInfo#device field.
device
()

protected VmaAllocatorInfo
public long

Returns:

the value of the VmaAllocatorInfo#instance field.
instance
()

public long

Returns:

the value of the VmaAllocatorInfo#physicalDevice field.
physicalDevice
()

protected VmaAllocatorInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaAllocatorInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

deviceback to summary
public long device()
Returns:long

the value of the VmaAllocatorInfo#device field.

Annotations
@NativeType:VkDevice
getElementFactoryback to summary
protected VmaAllocatorInfo getElementFactory()

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

Annotations
@Override
instanceback to summary
public long instance()
Returns:long

the value of the VmaAllocatorInfo#instance field.

Annotations
@NativeType:VkInstance
physicalDeviceback to summary
public long physicalDevice()
Returns:long

the value of the VmaAllocatorInfo#physicalDevice field.

Annotations
@NativeType:VkPhysicalDevice
selfback to summary
protected VmaAllocatorInfo.Buffer self()

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

Annotations
@Override