Top Description Inners Fields Constructors Methods
org.lwjgl.stb

public Class STBVorbisComment

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

Layout


struct stb_vorbis_comment {
    char * vendor;
    int comment_list_length;
    char ** comment_list;
}

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
COMMENT_LIST

The struct member offsets.

public static final int
COMMENT_LIST_LENGTH

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VENDOR

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
STBVorbisComment(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static STBVorbisComment
calloc()

Returns a new STBVorbisComment instance allocated with memCalloc.

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

Returns a new STBVorbisComment.Buffer instance allocated with memCalloc.

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

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

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

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

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the comment_list field.
comment_list
()

public int

Returns:

the value of the comment_list_length field.
comment_list_length
()

protected STBVorbisComment
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 STBVorbisComment
create()

Returns a new STBVorbisComment instance allocated with BufferUtils.

public static STBVorbisComment
create(long address)

Returns a new STBVorbisComment instance for the specified memory address.

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

Returns a new STBVorbisComment.Buffer instance allocated with BufferUtils.

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

Create a STBVorbisComment.Buffer instance at the specified memory.

public static STBVorbisComment
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static STBVorbisComment
malloc()

Returns a new STBVorbisComment instance allocated with memAlloc.

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

Returns a new STBVorbisComment.Buffer instance allocated with memAlloc.

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

Returns a new STBVorbisComment instance allocated on the specified MemoryStack.

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

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

public static PointerBuffer
ncomment_list(long struct)

Unsafe version of comment_list.

public static int
ncomment_list_length(long struct)

Unsafe version of comment_list_length.

public static ByteBuffer
nvendor(long struct)

Unsafe version of vendor.

public static String
nvendorString(long struct)

Unsafe version of vendorString.

public int
sizeof()

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

Returns sizeof(struct).
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the vendor field.
vendor
()

public String

Returns:

the null-terminated string pointed to by the vendor field.
vendorString
()

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.

COMMENT_LISTback to summary
public static final int COMMENT_LIST

The struct member offsets.

COMMENT_LIST_LENGTHback to summary
public static final int COMMENT_LIST_LENGTH

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VENDORback to summary
public static final int VENDOR

The struct member offsets.

Constructor Detail

STBVorbisCommentback to summary
protected STBVorbisComment(long address, ByteBuffer container)
STBVorbisCommentback to summary
public STBVorbisComment(ByteBuffer container)

Creates a STBVorbisComment 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 STBVorbisComment calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static STBVorbisComment calloc(MemoryStack stack)

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

Returns a new STBVorbisComment.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

comment_listback to summary
public PointerBuffer comment_list()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the comment_list field.

Annotations
@NativeType:char **
comment_list_lengthback to summary
public int comment_list_length()
Returns:int

the value of the comment_list_length field.

createback to summary
protected STBVorbisComment 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 STBVorbisComment create()

Returns a new STBVorbisComment instance allocated with BufferUtils.

createback to summary
public static STBVorbisComment create(long address)

Returns a new STBVorbisComment instance for the specified memory address.

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

Returns a new STBVorbisComment.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a STBVorbisComment.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static STBVorbisComment createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static STBVorbisComment malloc(MemoryStack stack)

Returns a new STBVorbisComment instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncomment_listback to summary
public static PointerBuffer ncomment_list(long struct)

Unsafe version of comment_list.

ncomment_list_lengthback to summary
public static int ncomment_list_length(long struct)

Unsafe version of comment_list_length.

nvendorback to summary
public static ByteBuffer nvendor(long struct)

Unsafe version of vendor.

nvendorStringback to summary
public static String nvendorString(long struct)

Unsafe version of vendorString.

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
vendorback to summary
public ByteBuffer vendor()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the vendor field.

Annotations
@NativeType:char *
vendorStringback to summary
public String vendorString()
Returns:String

the null-terminated string pointed to by the vendor field.

Annotations
@NativeType:char *
org.lwjgl.stb back to summary

public Class STBVorbisComment.Buffer

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

An array of STBVorbisComment structs.

Field Summary

Modifier and TypeField and Description
private static final STBVorbisComment

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new STBVorbisComment.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 PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the comment_list field.
comment_list
()

public int

Returns:

the value of the comment_list_length field.
comment_list_length
()

protected STBVorbisComment
protected STBVorbisComment.Buffer
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the vendor field.
vendor
()

public String

Returns:

the null-terminated string pointed to by the vendor field.
vendorString
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final STBVorbisComment ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

comment_listback to summary
public PointerBuffer comment_list()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the comment_list field.

Annotations
@NativeType:char **
comment_list_lengthback to summary
public int comment_list_length()
Returns:int

the value of the comment_list_length field.

getElementFactoryback to summary
protected STBVorbisComment getElementFactory()

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

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

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

Annotations
@Override
vendorback to summary
public ByteBuffer vendor()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the vendor field.

Annotations
@NativeType:char *
vendorStringback to summary
public String vendorString()
Returns:String

the null-terminated string pointed to by the vendor field.

Annotations
@NativeType:char *