Class STBVorbisComment

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<STBVorbisComment>

org.lwjgl.stb.STBVorbisComment

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

@NativeType("struct stb_vorbis_comment")
public class STBVorbisComment
extends Struct<STBVorbisComment>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	STBVorbisComment.Buffer	An array of STBVorbisComment structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	COMMENT_LIST	The struct member offsets.
static final int	COMMENT_LIST_LENGTH	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	VENDOR	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
STBVorbisComment(ByteBuffer container)	Creates a STBVorbisComment instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static STBVorbisComment	calloc()	Returns a new STBVorbisComment instance allocated with memCalloc.
static STBVorbisComment.Buffer	calloc(int capacity)	Returns a new STBVorbisComment.Buffer instance allocated with memCalloc.
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.
static STBVorbisComment	calloc(MemoryStack stack)	Returns a new STBVorbisComment instance allocated on the specified MemoryStack and initializes all its bits to zero.
PointerBuffer	comment_list()
int	comment_list_length()
static STBVorbisComment	create()	Returns a new STBVorbisComment instance allocated with BufferUtils.
static STBVorbisComment.Buffer	create(int capacity)	Returns a new STBVorbisComment.Buffer instance allocated with BufferUtils.
static STBVorbisComment	create(long address)	Returns a new STBVorbisComment instance for the specified memory address.
static STBVorbisComment.Buffer	create(long address, int capacity)	Create a STBVorbisComment.Buffer instance at the specified memory.
static @Nullable STBVorbisComment	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable STBVorbisComment.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static STBVorbisComment	malloc()	Returns a new STBVorbisComment instance allocated with memAlloc.
static STBVorbisComment.Buffer	malloc(int capacity)	Returns a new STBVorbisComment.Buffer instance allocated with memAlloc.
static STBVorbisComment.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new STBVorbisComment.Buffer instance allocated on the specified MemoryStack.
static STBVorbisComment	malloc(MemoryStack stack)	Returns a new STBVorbisComment instance allocated on the specified MemoryStack.
static PointerBuffer	ncomment_list(long struct)	Unsafe version of comment_list.
static int	ncomment_list_length(long struct)	Unsafe version of comment_list_length().
static ByteBuffer	nvendor(long struct)	Unsafe version of vendor().
static String	nvendorString(long struct)	Unsafe version of vendorString().
int	sizeof()	Returns sizeof(struct).
ByteBuffer	vendor()
String	vendorString()

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

VENDOR

public static final int VENDOR

The struct member offsets.

COMMENT_LIST_LENGTH

public static final int COMMENT_LIST_LENGTH

The struct member offsets.

COMMENT_LIST

public static final int COMMENT_LIST

The struct member offsets.

Constructor Details

STBVorbisComment

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<STBVorbisComment>

vendor

@NativeType("char *")
public ByteBuffer vendor()

Returns:

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

vendorString

@NativeType("char *")
public String vendorString()

Returns:

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

comment_list_length

public int comment_list_length()

Returns:

the value of the comment_list_length field.

comment_list

@NativeType("char **")
public PointerBuffer comment_list()

Returns:

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

malloc

public static STBVorbisComment malloc()

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

calloc

public static STBVorbisComment calloc()

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

create

public static STBVorbisComment create()

Returns a new STBVorbisComment instance allocated with BufferUtils.

create

public static STBVorbisComment create(long address)

Returns a new STBVorbisComment instance for the specified memory address.

createSafe

public static @Nullable STBVorbisComment createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static STBVorbisComment.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static STBVorbisComment.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static STBVorbisComment.Buffer create(int capacity)

Returns a new STBVorbisComment.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a STBVorbisComment.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static STBVorbisComment malloc(MemoryStack stack)

Returns a new STBVorbisComment instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nvendor

public static ByteBuffer nvendor(long struct)

Unsafe version of vendor().

nvendorString

public static String nvendorString(long struct)

Unsafe version of vendorString().

ncomment_list_length

public static int ncomment_list_length(long struct)

Unsafe version of comment_list_length().

ncomment_list

public static PointerBuffer ncomment_list(long struct)

Unsafe version of comment_list.