Top Description Inners Fields Constructors Methods
org.lwjgl.stb

public Class STBVorbisAlloc

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

A buffer to use for allocations by STBVorbis

Layout


struct stb_vorbis_alloc {
    char * alloc_buffer;
    int alloc_buffer_length_in_bytes;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ALLOC_BUFFER

The struct member offsets.

public static final int
ALLOC_BUFFER_LENGTH_IN_BYTES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
STBVorbisAlloc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the alloc_buffer field.
alloc_buffer
()

public STBVorbisAlloc
alloc_buffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the alloc_buffer field.

public int

Returns:

the value of the alloc_buffer_length_in_bytes field.
alloc_buffer_length_in_bytes
()

public static STBVorbisAlloc
calloc()

Returns a new STBVorbisAlloc instance allocated with memCalloc.

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

Returns a new STBVorbisAlloc.Buffer instance allocated with memCalloc.

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

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

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

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

public static STBVorbisAlloc
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected STBVorbisAlloc
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 STBVorbisAlloc
create()

Returns a new STBVorbisAlloc instance allocated with BufferUtils.

public static STBVorbisAlloc
create(long address)

Returns a new STBVorbisAlloc instance for the specified memory address.

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

Returns a new STBVorbisAlloc.Buffer instance allocated with BufferUtils.

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

Create a STBVorbisAlloc.Buffer instance at the specified memory.

public static STBVorbisAlloc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static STBVorbisAlloc
malloc()

Returns a new STBVorbisAlloc instance allocated with memAlloc.

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

Returns a new STBVorbisAlloc.Buffer instance allocated with memAlloc.

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

Returns a new STBVorbisAlloc instance allocated on the specified MemoryStack.

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

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

public static STBVorbisAlloc
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
nalloc_buffer(long struct)

Unsafe version of alloc_buffer.

public static void
nalloc_buffer(long struct, ByteBuffer value)

Unsafe version of alloc_buffer.

public static int
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.

public STBVorbisAlloc

Returns:

this struct
set
(STBVorbisAlloc
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

ALLOC_BUFFERback to summary
public static final int ALLOC_BUFFER

The struct member offsets.

ALLOC_BUFFER_LENGTH_IN_BYTESback to summary
public static final int ALLOC_BUFFER_LENGTH_IN_BYTES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

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

alloc_bufferback to summary
public ByteBuffer alloc_buffer()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the alloc_buffer field.

Annotations
@NativeType:char *
alloc_bufferback to summary
public STBVorbisAlloc alloc_buffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the alloc_buffer field.

alloc_buffer_length_in_bytesback to summary
public int alloc_buffer_length_in_bytes()
Returns:int

the value of the alloc_buffer_length_in_bytes field.

callocback to summary
public static STBVorbisAlloc calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static STBVorbisAlloc calloc(MemoryStack stack)

Returns a new STBVorbisAlloc 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 STBVorbisAlloc.Buffer calloc(int capacity, MemoryStack stack)

Returns a new STBVorbisAlloc.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 STBVorbisAlloc callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
createback to summary
protected STBVorbisAlloc 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 STBVorbisAlloc create()

Returns a new STBVorbisAlloc instance allocated with BufferUtils.

createback to summary
public static STBVorbisAlloc create(long address)

Returns a new STBVorbisAlloc instance for the specified memory address.

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

Returns a new STBVorbisAlloc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a STBVorbisAlloc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static STBVorbisAlloc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static STBVorbisAlloc malloc(MemoryStack stack)

Returns a new STBVorbisAlloc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new STBVorbisAlloc.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 STBVorbisAlloc mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nalloc_bufferback to summary
public static ByteBuffer nalloc_buffer(long struct)

Unsafe version of alloc_buffer.

nalloc_bufferback to summary
public static void nalloc_buffer(long struct, ByteBuffer value)

Unsafe version of alloc_buffer.

nalloc_buffer_length_in_bytesback to summary
public static int nalloc_buffer_length_in_bytes(long struct)

Unsafe version of alloc_buffer_length_in_bytes.

nalloc_buffer_length_in_bytesback to summary
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.

setback to summary
public STBVorbisAlloc set(STBVorbisAlloc src)

Copies the specified struct data to this struct.

Parameters
src:STBVorbisAlloc

the source struct

Returns:STBVorbisAlloc

this struct

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
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.stb back to summary

public Class STBVorbisAlloc.Buffer

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

An array of STBVorbisAlloc structs.

Field Summary

Modifier and TypeField and Description
private static final STBVorbisAlloc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new STBVorbisAlloc.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 ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the alloc_buffer field.
alloc_buffer
()

public STBVorbisAlloc.Buffer
alloc_buffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the alloc_buffer field.

public int

Returns:

the value of the alloc_buffer_length_in_bytes field.
alloc_buffer_length_in_bytes
()

protected STBVorbisAlloc
protected STBVorbisAlloc.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final STBVorbisAlloc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new STBVorbisAlloc.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 STBVorbisAlloc#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

alloc_bufferback to summary
public ByteBuffer alloc_buffer()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the alloc_buffer field.

Annotations
@NativeType:char *
alloc_bufferback to summary
public STBVorbisAlloc.Buffer alloc_buffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the alloc_buffer field.

alloc_buffer_length_in_bytesback to summary
public int alloc_buffer_length_in_bytes()
Returns:int

the value of the alloc_buffer_length_in_bytes field.

getElementFactoryback to summary
protected STBVorbisAlloc getElementFactory()

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

Annotations
@Override
selfback to summary
protected STBVorbisAlloc.Buffer self()

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

Annotations
@Override