STBVorbisInfo (LWJGL 3.2.4 SNAPSHOT

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

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

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

Information about a Vorbis stream.

Layout


 struct stb_vorbis_info {
     unsigned int sample_rate;
     int channels;
     unsigned int setup_memory_required;
     unsigned int setup_temp_memory_required;
     unsigned int temp_memory_required;
     int max_frame_size;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CHANNELS` The struct member offsets.
`static int`	`MAX_FRAME_SIZE` The struct member offsets.
`static int`	`SAMPLE_RATE` The struct member offsets.
`static int`	`SETUP_MEMORY_REQUIRED` The struct member offsets.
`static int`	`SETUP_TEMP_MEMORY_REQUIRED` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TEMP_MEMORY_REQUIRED` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`STBVorbisInfo(java.nio.ByteBuffer container)` Creates a `STBVorbisInfo` 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 STBVorbisInfo`	`calloc()` Returns a new `STBVorbisInfo` instance allocated with `memCalloc`.
`static STBVorbisInfo.Buffer`	`calloc(int capacity)` Returns a new `STBVorbisInfo.Buffer` instance allocated with `memCalloc`.
`static STBVorbisInfo`	`callocStack()` Returns a new `STBVorbisInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBVorbisInfo.Buffer`	`callocStack(int capacity)` Returns a new `STBVorbisInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBVorbisInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBVorbisInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`channels()` Returns the value of the `channels` field.
`static STBVorbisInfo`	`create()` Returns a new `STBVorbisInfo` instance allocated with `BufferUtils`.
`static STBVorbisInfo.Buffer`	`create(int capacity)` Returns a new `STBVorbisInfo.Buffer` instance allocated with `BufferUtils`.
`static STBVorbisInfo`	`create(long address)` Returns a new `STBVorbisInfo` instance for the specified memory address.
`static STBVorbisInfo.Buffer`	`create(long address, int capacity)` Create a `STBVorbisInfo.Buffer` instance at the specified memory.
`static STBVorbisInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBVorbisInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBVorbisInfo`	`malloc()` Returns a new `STBVorbisInfo` instance allocated with `memAlloc`.
`static STBVorbisInfo.Buffer`	`malloc(int capacity)` Returns a new `STBVorbisInfo.Buffer` instance allocated with `memAlloc`.
`static STBVorbisInfo`	`mallocStack()` Returns a new `STBVorbisInfo` instance allocated on the thread-local `MemoryStack`.
`static STBVorbisInfo.Buffer`	`mallocStack(int capacity)` Returns a new `STBVorbisInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static STBVorbisInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static STBVorbisInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBVorbisInfo` instance allocated on the specified `MemoryStack`.
`int`	`max_frame_size()` Returns the value of the `max_frame_size` field.
`static int`	`nchannels(long struct)` Unsafe version of `channels()`.
`static int`	`nmax_frame_size(long struct)` Unsafe version of `max_frame_size()`.
`static int`	`nsample_rate(long struct)` Unsafe version of `sample_rate()`.
`static int`	`nsetup_memory_required(long struct)` Unsafe version of `setup_memory_required()`.
`static int`	`nsetup_temp_memory_required(long struct)` Unsafe version of `setup_temp_memory_required()`.
`static int`	`ntemp_memory_required(long struct)` Unsafe version of `temp_memory_required()`.
`int`	`sample_rate()` Returns the value of the `sample_rate` field.
`int`	`setup_memory_required()` Returns the value of the `setup_memory_required` field.
`int`	`setup_temp_memory_required()` Returns the value of the `setup_temp_memory_required` field.
`int`	`sizeof()`
`int`	`temp_memory_required()` Returns the value of the `temp_memory_required` field.

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.
  - SAMPLE_RATE
```
public static final int SAMPLE_RATE
```
    The struct member offsets.
  - CHANNELS
```
public static final int CHANNELS
```
    The struct member offsets.
  - SETUP_MEMORY_REQUIRED
```
public static final int SETUP_MEMORY_REQUIRED
```
    The struct member offsets.
  - SETUP_TEMP_MEMORY_REQUIRED
```
public static final int SETUP_TEMP_MEMORY_REQUIRED
```
    The struct member offsets.
  - TEMP_MEMORY_REQUIRED
```
public static final int TEMP_MEMORY_REQUIRED
```
    The struct member offsets.
  - MAX_FRAME_SIZE
```
public static final int MAX_FRAME_SIZE
```
    The struct member offsets.
- Constructor Detail
  - STBVorbisInfo
```
public STBVorbisInfo(java.nio.ByteBuffer container)
```
    Creates a STBVorbisInfo 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
  - sample_rate
```
public int sample_rate()
```
    Returns the value of the sample_rate field.
  - channels
```
public int channels()
```
    Returns the value of the channels field.
  - setup_memory_required
```
public int setup_memory_required()
```
    Returns the value of the setup_memory_required field.
  - setup_temp_memory_required
```
public int setup_temp_memory_required()
```
    Returns the value of the setup_temp_memory_required field.
  - temp_memory_required
```
public int temp_memory_required()
```
    Returns the value of the temp_memory_required field.
  - max_frame_size
```
public int max_frame_size()
```
    Returns the value of the max_frame_size field.
  - malloc
```
public static STBVorbisInfo malloc()
```
    Returns a new STBVorbisInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static STBVorbisInfo calloc()
```
    Returns a new STBVorbisInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static STBVorbisInfo create()
```
    Returns a new STBVorbisInfo instance allocated with BufferUtils.
  - create
```
public static STBVorbisInfo create(long address)
```
    Returns a new STBVorbisInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static STBVorbisInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static STBVorbisInfo.Buffer malloc(int capacity)
```
    Returns a new STBVorbisInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static STBVorbisInfo.Buffer calloc(int capacity)
```
    Returns a new STBVorbisInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBVorbisInfo.Buffer create(int capacity)
```
    Returns a new STBVorbisInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBVorbisInfo.Buffer create(long address,
                                          int capacity)
```
    Create a STBVorbisInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static STBVorbisInfo.Buffer createSafe(long address,
                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static STBVorbisInfo mallocStack()
```
    Returns a new STBVorbisInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static STBVorbisInfo callocStack()
```
    Returns a new STBVorbisInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static STBVorbisInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static STBVorbisInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static STBVorbisInfo.Buffer mallocStack(int capacity)
```
    Returns a new STBVorbisInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static STBVorbisInfo.Buffer callocStack(int capacity)
```
    Returns a new STBVorbisInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static STBVorbisInfo.Buffer mallocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static STBVorbisInfo.Buffer callocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisInfo.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
  - nsample_rate
```
public static int nsample_rate(long struct)
```
    Unsafe version of sample_rate().
  - nchannels
```
public static int nchannels(long struct)
```
    Unsafe version of channels().
  - nsetup_memory_required
```
public static int nsetup_memory_required(long struct)
```
    Unsafe version of setup_memory_required().
  - nsetup_temp_memory_required
```
public static int nsetup_temp_memory_required(long struct)
```
    Unsafe version of setup_temp_memory_required().
  - ntemp_memory_required
```
public static int ntemp_memory_required(long struct)
```
    Unsafe version of temp_memory_required().
  - nmax_frame_size
```
public static int nmax_frame_size(long struct)
```
    Unsafe version of max_frame_size().

Class STBVorbisInfo

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

SAMPLE_RATE

CHANNELS

SETUP_MEMORY_REQUIRED

SETUP_TEMP_MEMORY_REQUIRED

TEMP_MEMORY_REQUIRED

MAX_FRAME_SIZE

Constructor Detail

STBVorbisInfo

Method Detail

sizeof

sample_rate

channels

setup_memory_required

setup_temp_memory_required

temp_memory_required

max_frame_size

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsample_rate

nchannels

nsetup_memory_required

nsetup_temp_memory_required

ntemp_memory_required

nmax_frame_size