Package org.lwjgl.util.vma

Class VmaDefragmentationInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaDefragmentationInfo>

org.lwjgl.util.vma.VmaDefragmentationInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VmaDefragmentationInfo
extends Struct<VmaDefragmentationInfo>
implements NativeResource

 struct VmaDefragmentationInfo {
     VmaDefragmentationFlags flags;
     VmaPool pool;
     VkDeviceSize maxBytesPerPass;
     uint32_t maxAllocationsPerPass;
     {@link VmaCheckDefragmentationBreakFunctionI PFN_vmaCheckDefragmentationBreakFunction} pfnBreakCallback;
     void * pBreakCallbackUserData;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VmaDefragmentationInfo.Buffer	An array of VmaDefragmentationInfo 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	MAXALLOCATIONSPERPASS	The struct member offsets.
static final int	MAXBYTESPERPASS	The struct member offsets.
static final int	PBREAKCALLBACKUSERDATA	The struct member offsets.
static final int	PFNBREAKCALLBACK	The struct member offsets.
static final int	POOL	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VmaDefragmentationInfo(ByteBuffer container)	Creates a VmaDefragmentationInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VmaDefragmentationInfo	calloc()	Returns a new VmaDefragmentationInfo instance allocated with memCalloc.
static VmaDefragmentationInfo.Buffer	calloc(int capacity)	Returns a new VmaDefragmentationInfo.Buffer instance allocated with memCalloc.
static VmaDefragmentationInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VmaDefragmentationInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaDefragmentationInfo	calloc(MemoryStack stack)	Returns a new VmaDefragmentationInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaDefragmentationInfo	callocStack()	Deprecated.
static VmaDefragmentationInfo.Buffer	callocStack(int capacity)	Deprecated.
static VmaDefragmentationInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VmaDefragmentationInfo	callocStack(MemoryStack stack)	Deprecated.
static VmaDefragmentationInfo	create()	Returns a new VmaDefragmentationInfo instance allocated with BufferUtils.
static VmaDefragmentationInfo.Buffer	create(int capacity)	Returns a new VmaDefragmentationInfo.Buffer instance allocated with BufferUtils.
static VmaDefragmentationInfo	create(long address)	Returns a new VmaDefragmentationInfo instance for the specified memory address.
static VmaDefragmentationInfo.Buffer	create(long address, int capacity)	Create a VmaDefragmentationInfo.Buffer instance at the specified memory.
static @Nullable VmaDefragmentationInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VmaDefragmentationInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VmaDefragmentationInfo	flags(int value)	Sets the specified value to the flags field.
static VmaDefragmentationInfo	malloc()	Returns a new VmaDefragmentationInfo instance allocated with memAlloc.
static VmaDefragmentationInfo.Buffer	malloc(int capacity)	Returns a new VmaDefragmentationInfo.Buffer instance allocated with memAlloc.
static VmaDefragmentationInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VmaDefragmentationInfo.Buffer instance allocated on the specified MemoryStack.
static VmaDefragmentationInfo	malloc(MemoryStack stack)	Returns a new VmaDefragmentationInfo instance allocated on the specified MemoryStack.
static VmaDefragmentationInfo	mallocStack()	Deprecated.
static VmaDefragmentationInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VmaDefragmentationInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VmaDefragmentationInfo	mallocStack(MemoryStack stack)	Deprecated.
int	maxAllocationsPerPass()
VmaDefragmentationInfo	maxAllocationsPerPass(int value)	Sets the specified value to the maxAllocationsPerPass field.
long	maxBytesPerPass()
VmaDefragmentationInfo	maxBytesPerPass(long value)	Sets the specified value to the maxBytesPerPass field.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	nmaxAllocationsPerPass(long struct)	Unsafe version of maxAllocationsPerPass().
static void	nmaxAllocationsPerPass(long struct, int value)	Unsafe version of maxAllocationsPerPass.
static long	nmaxBytesPerPass(long struct)	Unsafe version of maxBytesPerPass().
static void	nmaxBytesPerPass(long struct, long value)	Unsafe version of maxBytesPerPass.
static long	npBreakCallbackUserData(long struct)	Unsafe version of pBreakCallbackUserData().
static void	npBreakCallbackUserData(long struct, long value)	Unsafe version of pBreakCallbackUserData.
static @Nullable VmaCheckDefragmentationBreakFunction	npfnBreakCallback(long struct)	Unsafe version of pfnBreakCallback().
static void	npfnBreakCallback(long struct, @Nullable VmaCheckDefragmentationBreakFunctionI value)	Unsafe version of pfnBreakCallback.
static long	npool(long struct)	Unsafe version of pool().
static void	npool(long struct, long value)	Unsafe version of pool.
long	pBreakCallbackUserData()
VmaDefragmentationInfo	pBreakCallbackUserData(long value)	Sets the specified value to the pBreakCallbackUserData field.
@Nullable VmaCheckDefragmentationBreakFunction	pfnBreakCallback()
VmaDefragmentationInfo	pfnBreakCallback(@Nullable VmaCheckDefragmentationBreakFunctionI value)	Sets the specified value to the pfnBreakCallback field.
long	pool()
VmaDefragmentationInfo	pool(long value)	Sets the specified value to the pool field.
VmaDefragmentationInfo	set(int flags, long pool, long maxBytesPerPass, int maxAllocationsPerPass, VmaCheckDefragmentationBreakFunctionI pfnBreakCallback, long pBreakCallbackUserData)	Initializes this struct with the specified values.
VmaDefragmentationInfo	set(VmaDefragmentationInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

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.

POOL

public static final int POOL

The struct member offsets.

MAXBYTESPERPASS

public static final int MAXBYTESPERPASS

The struct member offsets.

MAXALLOCATIONSPERPASS

public static final int MAXALLOCATIONSPERPASS

The struct member offsets.

PFNBREAKCALLBACK

public static final int PFNBREAKCALLBACK

The struct member offsets.

PBREAKCALLBACKUSERDATA

public static final int PBREAKCALLBACKUSERDATA

The struct member offsets.

Constructor Details

VmaDefragmentationInfo

public VmaDefragmentationInfo(ByteBuffer container)

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

flags

public int flags()

Returns:

the value of the flags field.

pool

public long pool()

Returns:

the value of the pool field.

maxBytesPerPass

public long maxBytesPerPass()

Returns:

the value of the maxBytesPerPass field.

maxAllocationsPerPass

public int maxAllocationsPerPass()

Returns:

the value of the maxAllocationsPerPass field.

pfnBreakCallback

public @Nullable VmaCheckDefragmentationBreakFunction pfnBreakCallback()

Returns:

the value of the pfnBreakCallback field.

pBreakCallbackUserData

public long pBreakCallbackUserData()

Returns:

the value of the pBreakCallbackUserData field.

flags

public VmaDefragmentationInfo flags(int value)

Sets the specified value to the flags field.

pool

public VmaDefragmentationInfo pool(long value)

Sets the specified value to the pool field.

maxBytesPerPass

public VmaDefragmentationInfo maxBytesPerPass(long value)

Sets the specified value to the maxBytesPerPass field.

maxAllocationsPerPass

public VmaDefragmentationInfo maxAllocationsPerPass(int value)

Sets the specified value to the maxAllocationsPerPass field.

pfnBreakCallback

public VmaDefragmentationInfo pfnBreakCallback(@Nullable VmaCheckDefragmentationBreakFunctionI value)

Sets the specified value to the pfnBreakCallback field.

pBreakCallbackUserData

public VmaDefragmentationInfo pBreakCallbackUserData(long value)

Sets the specified value to the pBreakCallbackUserData field.

set

public VmaDefragmentationInfo set(int flags,
 long pool,
 long maxBytesPerPass,
 int maxAllocationsPerPass,
 VmaCheckDefragmentationBreakFunctionI pfnBreakCallback,
 long pBreakCallbackUserData)

Initializes this struct with the specified values.

set

public VmaDefragmentationInfo set(VmaDefragmentationInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VmaDefragmentationInfo malloc()

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

calloc

public static VmaDefragmentationInfo calloc()

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

create

public static VmaDefragmentationInfo create()

Returns a new VmaDefragmentationInfo instance allocated with BufferUtils.

create

public static VmaDefragmentationInfo create(long address)

Returns a new VmaDefragmentationInfo instance for the specified memory address.

createSafe

public static @Nullable VmaDefragmentationInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VmaDefragmentationInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VmaDefragmentationInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VmaDefragmentationInfo.Buffer create(int capacity)

Returns a new VmaDefragmentationInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VmaDefragmentationInfo.Buffer create(long address,
 int capacity)

Create a VmaDefragmentationInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VmaDefragmentationInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VmaDefragmentationInfo mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VmaDefragmentationInfo callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VmaDefragmentationInfo mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VmaDefragmentationInfo callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VmaDefragmentationInfo.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VmaDefragmentationInfo.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VmaDefragmentationInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VmaDefragmentationInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VmaDefragmentationInfo malloc(MemoryStack stack)

Returns a new VmaDefragmentationInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VmaDefragmentationInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VmaDefragmentationInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VmaDefragmentationInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

npool

public static long npool(long struct)

Unsafe version of pool().

nmaxBytesPerPass

public static long nmaxBytesPerPass(long struct)

Unsafe version of maxBytesPerPass().

nmaxAllocationsPerPass

public static int nmaxAllocationsPerPass(long struct)

Unsafe version of maxAllocationsPerPass().

npfnBreakCallback

public static @Nullable VmaCheckDefragmentationBreakFunction npfnBreakCallback(long struct)

Unsafe version of pfnBreakCallback().

npBreakCallbackUserData

public static long npBreakCallbackUserData(long struct)

Unsafe version of pBreakCallbackUserData().

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

npool

public static void npool(long struct,
 long value)

Unsafe version of pool.

nmaxBytesPerPass

public static void nmaxBytesPerPass(long struct,
 long value)

Unsafe version of maxBytesPerPass.

nmaxAllocationsPerPass

public static void nmaxAllocationsPerPass(long struct,
 int value)

Unsafe version of maxAllocationsPerPass.

npfnBreakCallback

public static void npfnBreakCallback(long struct,
 @Nullable VmaCheckDefragmentationBreakFunctionI value)

Unsafe version of pfnBreakCallback.

npBreakCallbackUserData

public static void npBreakCallbackUserData(long struct,
 long value)

Unsafe version of pBreakCallbackUserData.