Top Description Inners Fields Constructors Methods
org.lwjgl.stb

public Class STBVorbisInfo

extends Struct<STBVorbisInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct stb_vorbis_info
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
STBVorbisInfo.Buffer

An array of STBVorbisInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CHANNELS

The struct member offsets.

public static final int
MAX_FRAME_SIZE

The struct member offsets.

public static final int
SAMPLE_RATE

The struct member offsets.

public static final int
SETUP_MEMORY_REQUIRED

The struct member offsets.

public static final int
SETUP_TEMP_MEMORY_REQUIRED

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TEMP_MEMORY_REQUIRED

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
STBVorbisInfo(long address, ByteBuffer container)

public
STBVorbisInfo(ByteBuffer container)

Creates a STBVorbisInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static STBVorbisInfo
calloc()

Returns a new STBVorbisInfo instance allocated with memCalloc.

public static STBVorbisInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new STBVorbisInfo.Buffer instance allocated with memCalloc.

public static STBVorbisInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static STBVorbisInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static STBVorbisInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static STBVorbisInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static STBVorbisInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static STBVorbisInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int

Returns:

the value of the channels field.
channels
()

protected STBVorbisInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static STBVorbisInfo
create()

Returns a new STBVorbisInfo instance allocated with BufferUtils.

public static STBVorbisInfo
create(long address)

Returns a new STBVorbisInfo instance for the specified memory address.

public static STBVorbisInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new STBVorbisInfo.Buffer instance allocated with BufferUtils.

public static STBVorbisInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a STBVorbisInfo.Buffer instance at the specified memory.

public static STBVorbisInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static STBVorbisInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static STBVorbisInfo
malloc()

Returns a new STBVorbisInfo instance allocated with memAlloc.

public static STBVorbisInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new STBVorbisInfo.Buffer instance allocated with memAlloc.

public static STBVorbisInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new STBVorbisInfo instance allocated on the specified MemoryStack.

public static STBVorbisInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static STBVorbisInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static STBVorbisInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static STBVorbisInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static STBVorbisInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int

Returns:

the value of the max_frame_size field.
max_frame_size
()

public static int
nchannels(long struct)

Unsafe version of channels.

public static int
nmax_frame_size(long struct)

Unsafe version of max_frame_size.

public static int
nsample_rate(long struct)

Unsafe version of sample_rate.

public static int
nsetup_memory_required(long struct)

Unsafe version of setup_memory_required.

public static int
public static int
ntemp_memory_required(long struct)

Unsafe version of temp_memory_required.

public int

Returns:

the value of the sample_rate field.
sample_rate
()

public int

Returns:

the value of the setup_memory_required field.
setup_memory_required
()

public int

Returns:

the value of the setup_temp_memory_required field.
setup_temp_memory_required
()

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int

Returns:

the value of the temp_memory_required field.
temp_memory_required
()

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CHANNELSback to summary
public static final int CHANNELS

The struct member offsets.

MAX_FRAME_SIZEback to summary
public static final int MAX_FRAME_SIZE

The struct member offsets.

SAMPLE_RATEback to summary
public static final int SAMPLE_RATE

The struct member offsets.

SETUP_MEMORY_REQUIREDback to summary
public static final int SETUP_MEMORY_REQUIRED

The struct member offsets.

SETUP_TEMP_MEMORY_REQUIREDback to summary
public static final int SETUP_TEMP_MEMORY_REQUIRED

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TEMP_MEMORY_REQUIREDback to summary
public static final int TEMP_MEMORY_REQUIRED

The struct member offsets.

Constructor Detail

STBVorbisInfoback to summary
protected STBVorbisInfo(long address, ByteBuffer container)
STBVorbisInfoback to summary
public STBVorbisInfo(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

callocback to summary
public static STBVorbisInfo calloc()

Returns a new STBVorbisInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static STBVorbisInfo.Buffer calloc(int capacity)

Returns a new STBVorbisInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static STBVorbisInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static STBVorbisInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static STBVorbisInfo callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static STBVorbisInfo callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static STBVorbisInfo.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static STBVorbisInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
channelsback to summary
public int channels()
Returns:int

the value of the channels field.

createback to summary
protected STBVorbisInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static STBVorbisInfo create()

Returns a new STBVorbisInfo instance allocated with BufferUtils.

createback to summary
public static STBVorbisInfo create(long address)

Returns a new STBVorbisInfo instance for the specified memory address.

createback to summary
public static STBVorbisInfo.Buffer create(int capacity)

Returns a new STBVorbisInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static STBVorbisInfo.Buffer create(long address, int capacity)

Create a STBVorbisInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static STBVorbisInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static STBVorbisInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static STBVorbisInfo malloc()

Returns a new STBVorbisInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static STBVorbisInfo.Buffer malloc(int capacity)

Returns a new STBVorbisInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static STBVorbisInfo malloc(MemoryStack stack)

Returns a new STBVorbisInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static STBVorbisInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static STBVorbisInfo mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static STBVorbisInfo mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static STBVorbisInfo.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static STBVorbisInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
max_frame_sizeback to summary
public int max_frame_size()
Returns:int

the value of the max_frame_size field.

nchannelsback to summary
public static int nchannels(long struct)

Unsafe version of channels.

nmax_frame_sizeback to summary
public static int nmax_frame_size(long struct)

Unsafe version of max_frame_size.

nsample_rateback to summary
public static int nsample_rate(long struct)

Unsafe version of sample_rate.

nsetup_memory_requiredback to summary
public static int nsetup_memory_required(long struct)

Unsafe version of setup_memory_required.

nsetup_temp_memory_requiredback to summary
public static int nsetup_temp_memory_required(long struct)

Unsafe version of setup_temp_memory_required.

ntemp_memory_requiredback to summary
public static int ntemp_memory_required(long struct)

Unsafe version of temp_memory_required.

sample_rateback to summary
public int sample_rate()
Returns:int

the value of the sample_rate field.

Annotations
@NativeType:unsigned int
setup_memory_requiredback to summary
public int setup_memory_required()
Returns:int

the value of the setup_memory_required field.

Annotations
@NativeType:unsigned int
setup_temp_memory_requiredback to summary
public int setup_temp_memory_required()
Returns:int

the value of the setup_temp_memory_required field.

Annotations
@NativeType:unsigned int
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
temp_memory_requiredback to summary
public int temp_memory_required()
Returns:int

the value of the temp_memory_required field.

Annotations
@NativeType:unsigned int
org.lwjgl.stb back to summary

public Class STBVorbisInfo.Buffer

extends StructBuffer<STBVorbisInfo, STBVorbisInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of STBVorbisInfo structs.

Field Summary

Modifier and TypeField and Description
private static final STBVorbisInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new STBVorbisInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the channels field.
channels
()

protected STBVorbisInfo
public int

Returns:

the value of the max_frame_size field.
max_frame_size
()

public int

Returns:

the value of the sample_rate field.
sample_rate
()

protected STBVorbisInfo.Buffer
public int

Returns:

the value of the setup_memory_required field.
setup_memory_required
()

public int

Returns:

the value of the setup_temp_memory_required field.
setup_temp_memory_required
()

public int

Returns:

the value of the temp_memory_required field.
temp_memory_required
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final STBVorbisInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new STBVorbisInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by STBVorbisInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

channelsback to summary
public int channels()
Returns:int

the value of the channels field.

getElementFactoryback to summary
protected STBVorbisInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
max_frame_sizeback to summary
public int max_frame_size()
Returns:int

the value of the max_frame_size field.

sample_rateback to summary
public int sample_rate()
Returns:int

the value of the sample_rate field.

Annotations
@NativeType:unsigned int
selfback to summary
protected STBVorbisInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
setup_memory_requiredback to summary
public int setup_memory_required()
Returns:int

the value of the setup_memory_required field.

Annotations
@NativeType:unsigned int
setup_temp_memory_requiredback to summary
public int setup_temp_memory_required()
Returns:int

the value of the setup_temp_memory_required field.

Annotations
@NativeType:unsigned int
temp_memory_requiredback to summary
public int temp_memory_required()
Returns:int

the value of the temp_memory_required field.

Annotations
@NativeType:unsigned int