VmaRecordSettings (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VmaRecordSettings
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Parameters for recording calls to VMA functions. To be used in VmaAllocatorCreateInfo::pRecordSettings.
Member documentation
- flags – flags for recording. Must be:
  RECORD_FLUSH_AFTER_CALL_BIT
- pFilePath – path to the file that should be written by the recording.
  Suggested extension: "csv". If the file already exists, it will be overwritten. It will be opened for the whole time VmaAllocator object is alive. If opening this file fails, creation of the whole allocator object fails.
Layout
```
 struct VmaRecordSettings {
     VmaRecordFlags flags;
     char const * pFilePath;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VmaRecordSettings.Buffer
An array of VmaRecordSettings 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`	`VmaRecordSettings.Buffer` An array of `VmaRecordSettings` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PFILEPATH` 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

VmaRecordSettings(java.nio.ByteBuffer container)
Creates a VmaRecordSettings instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`VmaRecordSettings(java.nio.ByteBuffer container)` Creates a `VmaRecordSettings` 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 VmaRecordSettings`	`calloc()` Returns a new `VmaRecordSettings` instance allocated with `memCalloc`.
`static VmaRecordSettings.Buffer`	`calloc(int capacity)` Returns a new `VmaRecordSettings.Buffer` instance allocated with `memCalloc`.
`static VmaRecordSettings`	`callocStack()` Returns a new `VmaRecordSettings` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaRecordSettings.Buffer`	`callocStack(int capacity)` Returns a new `VmaRecordSettings.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaRecordSettings.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaRecordSettings.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaRecordSettings`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaRecordSettings` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaRecordSettings`	`create()` Returns a new `VmaRecordSettings` instance allocated with `BufferUtils`.
`static VmaRecordSettings.Buffer`	`create(int capacity)` Returns a new `VmaRecordSettings.Buffer` instance allocated with `BufferUtils`.
`static VmaRecordSettings`	`create(long address)` Returns a new `VmaRecordSettings` instance for the specified memory address.
`static VmaRecordSettings.Buffer`	`create(long address, int capacity)` Create a `VmaRecordSettings.Buffer` instance at the specified memory.
`static VmaRecordSettings`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaRecordSettings.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VmaRecordSettings`	`flags(int value)` Sets the specified value to the `flags` field.
`static VmaRecordSettings`	`malloc()` Returns a new `VmaRecordSettings` instance allocated with `memAlloc`.
`static VmaRecordSettings.Buffer`	`malloc(int capacity)` Returns a new `VmaRecordSettings.Buffer` instance allocated with `memAlloc`.
`static VmaRecordSettings`	`mallocStack()` Returns a new `VmaRecordSettings` instance allocated on the thread-local `MemoryStack`.
`static VmaRecordSettings.Buffer`	`mallocStack(int capacity)` Returns a new `VmaRecordSettings.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaRecordSettings.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaRecordSettings.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaRecordSettings`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaRecordSettings` instance allocated on the specified `MemoryStack`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static java.nio.ByteBuffer`	`npFilePath(long struct)` Unsafe version of `pFilePath()`.
`static void`	`npFilePath(long struct, java.nio.ByteBuffer value)` Unsafe version of `pFilePath`.
`static java.lang.String`	`npFilePathString(long struct)` Unsafe version of `pFilePathString()`.
`java.nio.ByteBuffer`	`pFilePath()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `pFilePath` field.
`VmaRecordSettings`	`pFilePath(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `pFilePath` field.
`java.lang.String`	`pFilePathString()` Decodes the null-terminated string pointed to by the `pFilePath` field.
`VmaRecordSettings`	`set(int flags, java.nio.ByteBuffer pFilePath)` Initializes this struct with the specified values.
`VmaRecordSettings`	`set(VmaRecordSettings src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - PFILEPATH
```
public static final int PFILEPATH
```
    The struct member offsets.
- Constructor Detail
  - VmaRecordSettings
```
public VmaRecordSettings(java.nio.ByteBuffer container)
```
    Creates a VmaRecordSettings 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
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - pFilePath
```
public java.nio.ByteBuffer pFilePath()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the pFilePath field.
  - pFilePathString
```
public java.lang.String pFilePathString()
```
    Decodes the null-terminated string pointed to by the pFilePath field.
  - flags
```
public VmaRecordSettings flags(int value)
```
    Sets the specified value to the flags field.
  - pFilePath
```
public VmaRecordSettings pFilePath(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the pFilePath field.
  - set
```
public VmaRecordSettings set(int flags,
                             java.nio.ByteBuffer pFilePath)
```
    Initializes this struct with the specified values.
  - set
```
public VmaRecordSettings set(VmaRecordSettings src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VmaRecordSettings malloc()
```
    Returns a new VmaRecordSettings instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VmaRecordSettings calloc()
```
    Returns a new VmaRecordSettings instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VmaRecordSettings create()
```
    Returns a new VmaRecordSettings instance allocated with BufferUtils.
  - create
```
public static VmaRecordSettings create(long address)
```
    Returns a new VmaRecordSettings instance for the specified memory address.
  - createSafe
```
@Nullable
public static VmaRecordSettings createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VmaRecordSettings.Buffer malloc(int capacity)
```
    Returns a new VmaRecordSettings.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VmaRecordSettings.Buffer calloc(int capacity)
```
    Returns a new VmaRecordSettings.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaRecordSettings.Buffer create(int capacity)
```
    Returns a new VmaRecordSettings.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaRecordSettings.Buffer create(long address,
                                              int capacity)
```
    Create a VmaRecordSettings.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VmaRecordSettings.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaRecordSettings mallocStack()
```
    Returns a new VmaRecordSettings instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaRecordSettings callocStack()
```
    Returns a new VmaRecordSettings instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaRecordSettings mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaRecordSettings instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaRecordSettings callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaRecordSettings instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VmaRecordSettings.Buffer mallocStack(int capacity)
```
    Returns a new VmaRecordSettings.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaRecordSettings.Buffer callocStack(int capacity)
```
    Returns a new VmaRecordSettings.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaRecordSettings.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaRecordSettings.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaRecordSettings.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaRecordSettings.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
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - npFilePath
```
public static java.nio.ByteBuffer npFilePath(long struct)
```
    Unsafe version of pFilePath().
  - npFilePathString
```
public static java.lang.String npFilePathString(long struct)
```
    Unsafe version of pFilePathString().
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - npFilePath
```
public static void npFilePath(long struct,
                              java.nio.ByteBuffer value)
```
    Unsafe version of pFilePath.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VmaRecordSettings

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

FLAGS

PFILEPATH

Constructor Detail

VmaRecordSettings

Method Detail

sizeof

flags

pFilePath

pFilePathString

flags

pFilePath

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nflags

npFilePath

npFilePathString

nflags

npFilePath

validate

validate