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

public Class VmaVirtualBlockCreateInfo

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

Parameters of created VmaVirtualBlock object to be passed to CreateVirtualBlock.

Layout


struct VmaVirtualBlockCreateInfo {
    VkDeviceSize size;
    VmaVirtualBlockCreateFlagBits flags;
    VkAllocationCallbacks const * pAllocationCallbacks;
}

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
FLAGS

The struct member offsets.

public static final int
PALLOCATIONCALLBACKS

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

public
VmaVirtualBlockCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VmaVirtualBlockCreateInfo
calloc()

Returns a new VmaVirtualBlockCreateInfo instance allocated with memCalloc.

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

Returns a new VmaVirtualBlockCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VmaVirtualBlockCreateInfo instance allocated with BufferUtils.

public static VmaVirtualBlockCreateInfo
create(long address)

Returns a new VmaVirtualBlockCreateInfo instance for the specified memory address.

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

Returns a new VmaVirtualBlockCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VmaVirtualBlockCreateInfo.Buffer instance at the specified memory.

public static VmaVirtualBlockCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

use combination of VmaVirtualBlockCreateFlagBits.

public VmaVirtualBlockCreateInfo
flags(int value)

Sets the specified value to the flags field.

public static VmaVirtualBlockCreateInfo
malloc()

Returns a new VmaVirtualBlockCreateInfo instance allocated with memAlloc.

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

Returns a new VmaVirtualBlockCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VmaVirtualBlockCreateInfo instance allocated on the specified MemoryStack.

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

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static VkAllocationCallbacks
npAllocationCallbacks(long struct)

Unsafe version of pAllocationCallbacks.

public static void
public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

Unsafe version of size.

public VkAllocationCallbacks
pAllocationCallbacks()

custom CPU memory allocation callbacks.

public VmaVirtualBlockCreateInfo
pAllocationCallbacks(VkAllocationCallbacks value)

Sets the address of the specified VkAllocationCallbacks to the pAllocationCallbacks field.

public VmaVirtualBlockCreateInfo
set(long size, int flags, VkAllocationCallbacks pAllocationCallbacks)

Initializes this struct with the specified values.

public VmaVirtualBlockCreateInfo

Returns:

this struct
set
(VmaVirtualBlockCreateInfo
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

total size of the virtual block.

public VmaVirtualBlockCreateInfo
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

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.

PALLOCATIONCALLBACKSback to summary
public static final int PALLOCATIONCALLBACKS

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

VmaVirtualBlockCreateInfoback to summary
protected VmaVirtualBlockCreateInfo(long address, ByteBuffer container)
VmaVirtualBlockCreateInfoback to summary
public VmaVirtualBlockCreateInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaVirtualBlockCreateInfo calloc(MemoryStack stack)

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

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

Returns a new VmaVirtualBlockCreateInfo instance allocated with BufferUtils.

createback to summary
public static VmaVirtualBlockCreateInfo create(long address)

Returns a new VmaVirtualBlockCreateInfo instance for the specified memory address.

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

Returns a new VmaVirtualBlockCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VmaVirtualBlockCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaVirtualBlockCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VmaVirtualBlockCreateInfo.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 VmaVirtualBlockCreateFlagBits. One or more of:

VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BITVIRTUAL_BLOCK_CREATE_ALGORITHM_MASK
Annotations
@NativeType:VmaVirtualBlockCreateFlagBits
flagsback to summary
public VmaVirtualBlockCreateInfo flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VmaVirtualBlockCreateInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaVirtualBlockCreateInfo malloc(MemoryStack stack)

Returns a new VmaVirtualBlockCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

npAllocationCallbacksback to summary
public static VkAllocationCallbacks npAllocationCallbacks(long struct)

Unsafe version of pAllocationCallbacks.

Annotations
@Nullable
npAllocationCallbacksback to summary
public static void npAllocationCallbacks(long struct, VkAllocationCallbacks value)

Unsafe version of pAllocationCallbacks.

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.

pAllocationCallbacksback to summary
public VkAllocationCallbacks pAllocationCallbacks()

custom CPU memory allocation callbacks. Optional.

Optional, can be null. When specified, they will be used for all CPU-side memory allocations.

Annotations
@Nullable
@NativeType:VkAllocationCallbacks const *
pAllocationCallbacksback to summary
public VmaVirtualBlockCreateInfo pAllocationCallbacks(VkAllocationCallbacks value)

Sets the address of the specified VkAllocationCallbacks to the pAllocationCallbacks field.

setback to summary
public VmaVirtualBlockCreateInfo set(long size, int flags, VkAllocationCallbacks pAllocationCallbacks)

Initializes this struct with the specified values.

setback to summary
public VmaVirtualBlockCreateInfo set(VmaVirtualBlockCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VmaVirtualBlockCreateInfo

the source struct

Returns:VmaVirtualBlockCreateInfo

this struct

sizeback to summary
public long size()

total size of the virtual block.

Sizes can be expressed in bytes or any units you want as long as you are consistent in using them. For example, if you allocate from some array of structures, 1 can mean single instance of entire structure.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VmaVirtualBlockCreateInfo 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 VmaVirtualBlockCreateInfo.Buffer

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

An array of VmaVirtualBlockCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VmaVirtualBlockCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaVirtualBlockCreateInfo.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 int

Returns:

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

public VmaVirtualBlockCreateInfo.Buffer
flags(int value)

Sets the specified value to the VmaVirtualBlockCreateInfo#flags field.

protected VmaVirtualBlockCreateInfo
public VkAllocationCallbacks

Returns:

a VkAllocationCallbacks view of the struct pointed to by the VmaVirtualBlockCreateInfo#pAllocationCallbacks field.
pAllocationCallbacks
()

public VmaVirtualBlockCreateInfo.Buffer
protected VmaVirtualBlockCreateInfo.Buffer
public long

Returns:

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

public VmaVirtualBlockCreateInfo.Buffer
size(long value)

Sets the specified value to the VmaVirtualBlockCreateInfo#size field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaVirtualBlockCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public int flags()
Returns:int

the value of the VmaVirtualBlockCreateInfo#flags field.

Annotations
@NativeType:VmaVirtualBlockCreateFlagBits
flagsback to summary
public VmaVirtualBlockCreateInfo.Buffer flags(int value)

Sets the specified value to the VmaVirtualBlockCreateInfo#flags field.

getElementFactoryback to summary
protected VmaVirtualBlockCreateInfo getElementFactory()

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

Annotations
@Override
pAllocationCallbacksback to summary
public VkAllocationCallbacks pAllocationCallbacks()
Returns:VkAllocationCallbacks

a VkAllocationCallbacks view of the struct pointed to by the VmaVirtualBlockCreateInfo#pAllocationCallbacks field.

Annotations
@Nullable
@NativeType:VkAllocationCallbacks const *
pAllocationCallbacksback to summary
public VmaVirtualBlockCreateInfo.Buffer pAllocationCallbacks(VkAllocationCallbacks value)

Sets the address of the specified VkAllocationCallbacks to the VmaVirtualBlockCreateInfo#pAllocationCallbacks field.

selfback to summary
protected VmaVirtualBlockCreateInfo.Buffer self()

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

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

the value of the VmaVirtualBlockCreateInfo#size field.

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

Sets the specified value to the VmaVirtualBlockCreateInfo#size field.