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

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

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

Layout


 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 interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`COMMENT_LIST COMMENT_LIST_LENGTH`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`VENDOR`	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 Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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, org.lwjgl.system.MemoryStack stack)`	Returns a new `STBVorbisComment.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBVorbisComment`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `STBVorbisComment` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`org.lwjgl.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 STBVorbisComment`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static 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, org.lwjgl.system.MemoryStack stack)`	Returns a new `STBVorbisComment.Buffer` instance allocated on the specified `MemoryStack`.
`static STBVorbisComment`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `STBVorbisComment` instance allocated on the specified `MemoryStack`.
`static org.lwjgl.PointerBuffer`	`ncomment_list(long struct)`	Unsafe version of `comment_list`.
`static int`	`ncomment_list_length(long struct)`	Unsafe version of `comment_list_length()`.
`static java.nio.ByteBuffer`	`nvendor(long struct)`	Unsafe version of `vendor()`.
`static java.lang.String`	`nvendorString(long struct)`	Unsafe version of `vendorString()`.
`int`	`sizeof()`
`java.nio.ByteBuffer`	`vendor()`
`java.lang.String`	`vendorString()`

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - VENDOR, COMMENT_LIST_LENGTH, COMMENT_LIST
    
    The struct member offsets.
- Constructor Detail
  - STBVorbisComment
```
public STBVorbisComment(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - vendor
```
public java.nio.ByteBuffer vendor()
```
    Returns:
    
    a ByteBuffer view of the null-terminated string pointed to by the vendor field.
  - vendorString
```
public java.lang.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
```
public org.lwjgl.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
```
@Nullable
public static 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
```
@Nullable
public static STBVorbisComment.Buffer createSafe(long address,
                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static STBVorbisComment malloc(org.lwjgl.system.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(org.lwjgl.system.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,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisComment.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static STBVorbisComment.Buffer calloc(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBVorbisComment.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
  - nvendor
```
public static java.nio.ByteBuffer nvendor(long struct)
```
    Unsafe version of vendor().
  - nvendorString
```
public static java.lang.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 org.lwjgl.PointerBuffer ncomment_list(long struct)
```
    Unsafe version of comment_list.

Class STBVorbisComment

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

VENDOR, COMMENT_LIST_LENGTH, COMMENT_LIST

Constructor Detail

STBVorbisComment

Method Detail

sizeof

vendor

vendorString

comment_list_length

comment_list

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nvendor

nvendorString

ncomment_list_length

ncomment_list