java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaDefragmentationInfo>

org.lwjgl.util.vma.VmaDefragmentationInfo

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VmaDefragmentationInfo extends org.lwjgl.system.Struct<VmaDefragmentationInfo> implements org.lwjgl.system.NativeResource

Parameters for defragmentation.

To be used with function BeginDefragmentation.

Layout


 struct VmaDefragmentationInfo {
     VmaDefragmentationFlags flags();
     VmaPool pool();
     VkDeviceSize maxBytesPerPass();
     uint32_t maxAllocationsPerPass();
     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
org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.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, org.lwjgl.system.MemoryStack stack)

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

static VmaDefragmentationInfo

calloc(org.lwjgl.system.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, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VmaDefragmentationInfo

callocStack(org.lwjgl.system.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()

use combination of VmaDefragmentationFlagBits.

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, org.lwjgl.system.MemoryStack stack)

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

static VmaDefragmentationInfo

malloc(org.lwjgl.system.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, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VmaDefragmentationInfo

mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

int

maxAllocationsPerPass()

maximum number of allocations that can be moved during single pass to a different place.

VmaDefragmentationInfo

maxAllocationsPerPass(int value)

Sets the specified value to the maxAllocationsPerPass() field.

long

maxBytesPerPass()

maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.

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()

optional data to pass to custom callback for stopping pass of defragmentation.

VmaDefragmentationInfo

pBreakCallbackUserData(long value)

Sets the specified value to the pBreakCallbackUserData() field.

@Nullable VmaCheckDefragmentationBreakFunction

pfnBreakCallback()

Optional custom callback for stopping BeginDefragmentation.

VmaDefragmentationInfo

pfnBreakCallback(@Nullable VmaCheckDefragmentationBreakFunctionI value)

Sets the specified value to the pfnBreakCallback() field.

long

pool()

custom pool to be defragmented.

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()

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()
  
  Specified by:
  
  sizeof in class org.lwjgl.system.Struct<VmaDefragmentationInfo>
- flags
  
  public int flags()
  
  use combination of VmaDefragmentationFlagBits. One or more of:
  DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED_BIT
  DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT DEFRAGMENTATION_FLAG_ALGORITHM_EXTENSIVE_BIT
  DEFRAGMENTATION_FLAG_ALGORITHM_MASK
- pool
  
  public long pool()
  
  custom pool to be defragmented.
  If null then default pools will undergo defragmentation process.
- maxBytesPerPass
  
  public long maxBytesPerPass()
  
  maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
  0 means no limit.
- maxAllocationsPerPass
  
  public int maxAllocationsPerPass()
  
  maximum number of allocations that can be moved during single pass to a different place.
  0 means no limit.
- pfnBreakCallback
  
  public @Nullable VmaCheckDefragmentationBreakFunction pfnBreakCallback()
  
  Optional custom callback for stopping BeginDefragmentation.
  Have to return true for breaking current defragmentation pass.
- pBreakCallbackUserData
  
  public long pBreakCallbackUserData()
  
  optional data to pass to custom callback for stopping pass of defragmentation.
- 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(org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VmaDefragmentationInfo callocStack(org.lwjgl.system.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, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VmaDefragmentationInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VmaDefragmentationInfo malloc(org.lwjgl.system.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(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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.

`DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT`	`DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED_BIT`
`DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT`	`DEFRAGMENTATION_FLAG_ALGORITHM_EXTENSIVE_BIT`
`DEFRAGMENTATION_FLAG_ALGORITHM_MASK`

Class VmaDefragmentationInfo

Layout

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

FLAGS

POOL

MAXBYTESPERPASS

MAXALLOCATIONSPERPASS

PFNBREAKCALLBACK

PBREAKCALLBACKUSERDATA

Constructor Details

VmaDefragmentationInfo

Method Details

sizeof

flags

pool

maxBytesPerPass

maxAllocationsPerPass

pfnBreakCallback

pBreakCallbackUserData

flags

pool

maxBytesPerPass

maxAllocationsPerPass

pfnBreakCallback

pBreakCallbackUserData

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nflags

npool

nmaxBytesPerPass

nmaxAllocationsPerPass

npfnBreakCallback

npBreakCallbackUserData

nflags

npool

nmaxBytesPerPass

nmaxAllocationsPerPass

npfnBreakCallback

npBreakCallbackUserData