STBVorbisAlloc (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.stb.STBVorbisAlloc

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

public class STBVorbisAlloc
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

A buffer to use for allocations by STBVorbis

Layout


 struct stb_vorbis_alloc {
     char * alloc_buffer;
     int alloc_buffer_length_in_bytes;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

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

Constructors
Constructor and Description
`STBVorbisAlloc(java.nio.ByteBuffer container)` Creates a `STBVorbisAlloc` 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
`int`	`alloc_buffer_length_in_bytes()` Returns the value of the `alloc_buffer_length_in_bytes` field.
`java.nio.ByteBuffer`	`alloc_buffer()` Returns a `ByteBuffer` view of the data pointed to by the `alloc_buffer` field.
`STBVorbisAlloc`	`alloc_buffer(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `alloc_buffer` field.
`static STBVorbisAlloc`	`calloc()` Returns a new `STBVorbisAlloc` instance allocated with `memCalloc`.
`static STBVorbisAlloc.Buffer`	`calloc(int capacity)` Returns a new `STBVorbisAlloc.Buffer` instance allocated with `memCalloc`.
`static STBVorbisAlloc`	`callocStack()` Returns a new `STBVorbisAlloc` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBVorbisAlloc.Buffer`	`callocStack(int capacity)` Returns a new `STBVorbisAlloc.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBVorbisAlloc.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisAlloc.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBVorbisAlloc`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisAlloc` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBVorbisAlloc`	`create()` Returns a new `STBVorbisAlloc` instance allocated with `BufferUtils`.
`static STBVorbisAlloc.Buffer`	`create(int capacity)` Returns a new `STBVorbisAlloc.Buffer` instance allocated with `BufferUtils`.
`static STBVorbisAlloc`	`create(long address)` Returns a new `STBVorbisAlloc` instance for the specified memory address.
`static STBVorbisAlloc.Buffer`	`create(long address, int capacity)` Create a `STBVorbisAlloc.Buffer` instance at the specified memory.
`static STBVorbisAlloc`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBVorbisAlloc.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBVorbisAlloc`	`malloc()` Returns a new `STBVorbisAlloc` instance allocated with `memAlloc`.
`static STBVorbisAlloc.Buffer`	`malloc(int capacity)` Returns a new `STBVorbisAlloc.Buffer` instance allocated with `memAlloc`.
`static STBVorbisAlloc`	`mallocStack()` Returns a new `STBVorbisAlloc` instance allocated on the thread-local `MemoryStack`.
`static STBVorbisAlloc.Buffer`	`mallocStack(int capacity)` Returns a new `STBVorbisAlloc.Buffer` instance allocated on the thread-local `MemoryStack`.
`static STBVorbisAlloc.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisAlloc.Buffer` instance allocated on the specified `MemoryStack`.
`static STBVorbisAlloc`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisAlloc` instance allocated on the specified `MemoryStack`.
`static int`	`nalloc_buffer_length_in_bytes(long struct)` Unsafe version of `alloc_buffer_length_in_bytes()`.
`static void`	`nalloc_buffer_length_in_bytes(long struct, int value)` Sets the specified value to the `alloc_buffer_length_in_bytes` field of the specified `struct`.
`static java.nio.ByteBuffer`	`nalloc_buffer(long struct)` Unsafe version of `alloc_buffer`.
`static void`	`nalloc_buffer(long struct, java.nio.ByteBuffer value)` Unsafe version of `alloc_buffer`.
`STBVorbisAlloc`	`set(STBVorbisAlloc 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.
  - ALLOC_BUFFER
```
public static final int ALLOC_BUFFER
```
    The struct member offsets.
  - ALLOC_BUFFER_LENGTH_IN_BYTES
```
public static final int ALLOC_BUFFER_LENGTH_IN_BYTES
```
    The struct member offsets.
- Constructor Detail
  - STBVorbisAlloc
```
public STBVorbisAlloc(java.nio.ByteBuffer container)
```
    Creates a STBVorbisAlloc 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
  - alloc_buffer
```
public java.nio.ByteBuffer alloc_buffer()
```
    Returns a ByteBuffer view of the data pointed to by the alloc_buffer field.
  - alloc_buffer_length_in_bytes
```
public int alloc_buffer_length_in_bytes()
```
    Returns the value of the alloc_buffer_length_in_bytes field.
  - alloc_buffer
```
public STBVorbisAlloc alloc_buffer(java.nio.ByteBuffer value)
```
    Sets the address of the specified ByteBuffer to the alloc_buffer field.
  - set
```
public STBVorbisAlloc set(STBVorbisAlloc src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static STBVorbisAlloc malloc()
```
    Returns a new STBVorbisAlloc instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static STBVorbisAlloc calloc()
```
    Returns a new STBVorbisAlloc instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static STBVorbisAlloc create()
```
    Returns a new STBVorbisAlloc instance allocated with BufferUtils.
  - create
```
public static STBVorbisAlloc create(long address)
```
    Returns a new STBVorbisAlloc instance for the specified memory address.
  - createSafe
```
@Nullable
public static STBVorbisAlloc createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static STBVorbisAlloc.Buffer malloc(int capacity)
```
    Returns a new STBVorbisAlloc.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static STBVorbisAlloc.Buffer calloc(int capacity)
```
    Returns a new STBVorbisAlloc.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBVorbisAlloc.Buffer create(int capacity)
```
    Returns a new STBVorbisAlloc.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBVorbisAlloc.Buffer create(long address,
                                           int capacity)
```
    Create a STBVorbisAlloc.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static STBVorbisAlloc.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static STBVorbisAlloc mallocStack()
```
    Returns a new STBVorbisAlloc instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static STBVorbisAlloc callocStack()
```
    Returns a new STBVorbisAlloc instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static STBVorbisAlloc mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisAlloc instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static STBVorbisAlloc callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisAlloc instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static STBVorbisAlloc.Buffer mallocStack(int capacity)
```
    Returns a new STBVorbisAlloc.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static STBVorbisAlloc.Buffer callocStack(int capacity)
```
    Returns a new STBVorbisAlloc.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static STBVorbisAlloc.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisAlloc.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static STBVorbisAlloc.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisAlloc.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
  - nalloc_buffer
```
public static java.nio.ByteBuffer nalloc_buffer(long struct)
```
    Unsafe version of alloc_buffer.
  - nalloc_buffer_length_in_bytes
```
public static int nalloc_buffer_length_in_bytes(long struct)
```
    Unsafe version of alloc_buffer_length_in_bytes().
  - nalloc_buffer
```
public static void nalloc_buffer(long struct,
                                 java.nio.ByteBuffer value)
```
    Unsafe version of alloc_buffer.
  - nalloc_buffer_length_in_bytes
```
public static void nalloc_buffer_length_in_bytes(long struct,
                                                 int value)
```
    Sets the specified value to the alloc_buffer_length_in_bytes field of the specified struct.
  - 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 STBVorbisAlloc

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

ALLOC_BUFFER

ALLOC_BUFFER_LENGTH_IN_BYTES

Constructor Detail

STBVorbisAlloc

Method Detail

sizeof

alloc_buffer

alloc_buffer_length_in_bytes

alloc_buffer

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nalloc_buffer

nalloc_buffer_length_in_bytes

nalloc_buffer

nalloc_buffer_length_in_bytes

validate

validate