VmaDefragmentationInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.vma.VmaDefragmentationInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VmaDefragmentationInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Deprecated. Optional configuration parameters to be passed to function Defragment.
This is a part of the old interface. It is recommended to use structure VmaDefragmentationInfo2 and function DefragmentationBegin instead.

Member documentation
- maxBytesToMove – maximum total numbers of bytes that can be copied while moving allocations to different places.
  Default is VK_WHOLE_SIZE, which means no limit.
- maxAllocationsToMove – maximum number of allocations that can be moved to different place.
  Default is UINT32_MAX, which means no limit.
Layout
```
 struct VmaDefragmentationInfo {
     VkDeviceSize maxBytesToMove;
     uint32_t maxAllocationsToMove;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VmaDefragmentationInfo.Buffer
An array of VmaDefragmentationInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VmaDefragmentationInfo.Buffer` An array of `VmaDefragmentationInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MAXALLOCATIONSTOMOVE` The struct member offsets.
`static int`	`MAXBYTESTOMOVE` The struct member offsets.
`static 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 and Description
`VmaDefragmentationInfo(java.nio.ByteBuffer container)` Creates a `VmaDefragmentationInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VmaDefragmentationInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaDefragmentationInfo.Buffer`	`callocStack(int capacity)` Returns a new `VmaDefragmentationInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaDefragmentationInfo.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaDefragmentationInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 VmaDefragmentationInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaDefragmentationInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`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`	`mallocStack()` Returns a new `VmaDefragmentationInfo` instance allocated on the thread-local `MemoryStack`.
`static VmaDefragmentationInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VmaDefragmentationInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaDefragmentationInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaDefragmentationInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaDefragmentationInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaDefragmentationInfo` instance allocated on the specified `MemoryStack`.
`int`	`maxAllocationsToMove()` Returns the value of the `maxAllocationsToMove` field.
`VmaDefragmentationInfo`	`maxAllocationsToMove(int value)` Sets the specified value to the `maxAllocationsToMove` field.
`long`	`maxBytesToMove()` Returns the value of the `maxBytesToMove` field.
`VmaDefragmentationInfo`	`maxBytesToMove(long value)` Sets the specified value to the `maxBytesToMove` field.
`static int`	`nmaxAllocationsToMove(long struct)` Unsafe version of `maxAllocationsToMove()`.
`static void`	`nmaxAllocationsToMove(long struct, int value)` Unsafe version of `maxAllocationsToMove`.
`static long`	`nmaxBytesToMove(long struct)` Unsafe version of `maxBytesToMove()`.
`static void`	`nmaxBytesToMove(long struct, long value)` Unsafe version of `maxBytesToMove`.
`VmaDefragmentationInfo`	`set(long maxBytesToMove, int maxAllocationsToMove)` 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

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 Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - MAXBYTESTOMOVE
```
public static final int MAXBYTESTOMOVE
```
    The struct member offsets.
  - MAXALLOCATIONSTOMOVE
```
public static final int MAXALLOCATIONSTOMOVE
```
    The struct member offsets.
- Constructor Detail
  - VmaDefragmentationInfo
```
public VmaDefragmentationInfo(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - maxBytesToMove
```
public long maxBytesToMove()
```
    Returns the value of the maxBytesToMove field.
  - maxAllocationsToMove
```
public int maxAllocationsToMove()
```
    Returns the value of the maxAllocationsToMove field.
  - maxBytesToMove
```
public VmaDefragmentationInfo maxBytesToMove(long value)
```
    Sets the specified value to the maxBytesToMove field.
  - maxAllocationsToMove
```
public VmaDefragmentationInfo maxAllocationsToMove(int value)
```
    Sets the specified value to the maxAllocationsToMove field.
  - set
```
public VmaDefragmentationInfo set(long maxBytesToMove,
                                  int maxAllocationsToMove)
```
    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
```
@Nullable
public static 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
```
@Nullable
public static VmaDefragmentationInfo.Buffer createSafe(long address,
                                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaDefragmentationInfo mallocStack()
```
    Returns a new VmaDefragmentationInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaDefragmentationInfo callocStack()
```
    Returns a new VmaDefragmentationInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaDefragmentationInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaDefragmentationInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaDefragmentationInfo callocStack(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
  - mallocStack
```
public static VmaDefragmentationInfo.Buffer mallocStack(int capacity)
```
    Returns a new VmaDefragmentationInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaDefragmentationInfo.Buffer callocStack(int capacity)
```
    Returns a new VmaDefragmentationInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaDefragmentationInfo.Buffer mallocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaDefragmentationInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaDefragmentationInfo.Buffer callocStack(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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nmaxBytesToMove
```
public static long nmaxBytesToMove(long struct)
```
    Unsafe version of maxBytesToMove().
  - nmaxAllocationsToMove
```
public static int nmaxAllocationsToMove(long struct)
```
    Unsafe version of maxAllocationsToMove().
  - nmaxBytesToMove
```
public static void nmaxBytesToMove(long struct,
                                   long value)
```
    Unsafe version of maxBytesToMove.
  - nmaxAllocationsToMove
```
public static void nmaxAllocationsToMove(long struct,
                                         int value)
```
    Unsafe version of maxAllocationsToMove.

Class VmaDefragmentationInfo

Member documentation

Layout

Nested Class Summary

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 Detail

SIZEOF

ALIGNOF

MAXBYTESTOMOVE

MAXALLOCATIONSTOMOVE

Constructor Detail

VmaDefragmentationInfo

Method Detail

sizeof

maxBytesToMove

maxAllocationsToMove

maxBytesToMove

maxAllocationsToMove

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmaxBytesToMove

nmaxAllocationsToMove

nmaxBytesToMove

nmaxAllocationsToMove