org.lwjgl.stb.STBVorbisComment Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.stb;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Layout
*
*
* struct stb_vorbis_comment {
* char * vendor;
* int comment_list_length;
* char ** comment_list;
* }
*/
@NativeType("struct stb_vorbis_comment")
public class STBVorbisComment extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
VENDOR,
COMMENT_LIST_LENGTH,
COMMENT_LIST;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
VENDOR = layout.offsetof(0);
COMMENT_LIST_LENGTH = layout.offsetof(1);
COMMENT_LIST = layout.offsetof(2);
}
/**
* Creates a {@code STBVorbisComment} instance at the current position of the specified {@link 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.
*/
public STBVorbisComment(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** @return a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code vendor} field. */
@NativeType("char *")
public ByteBuffer vendor() { return nvendor(address()); }
/** @return the null-terminated string pointed to by the {@code vendor} field. */
@NativeType("char *")
public String vendorString() { return nvendorString(address()); }
/** @return the value of the {@code comment_list_length} field. */
public int comment_list_length() { return ncomment_list_length(address()); }
/** @return a {@link PointerBuffer} view of the data pointed to by the {@code comment_list} field. */
@NativeType("char **")
public PointerBuffer comment_list() { return ncomment_list(address()); }
// -----------------------------------
/** Returns a new {@code STBVorbisComment} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static STBVorbisComment malloc() {
return wrap(STBVorbisComment.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code STBVorbisComment} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static STBVorbisComment calloc() {
return wrap(STBVorbisComment.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code STBVorbisComment} instance allocated with {@link BufferUtils}. */
public static STBVorbisComment create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(STBVorbisComment.class, memAddress(container), container);
}
/** Returns a new {@code STBVorbisComment} instance for the specified memory address. */
public static STBVorbisComment create(long address) {
return wrap(STBVorbisComment.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static STBVorbisComment createSafe(long address) {
return address == NULL ? null : wrap(STBVorbisComment.class, address);
}
/**
* Returns a new {@link STBVorbisComment.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static STBVorbisComment.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link STBVorbisComment.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static STBVorbisComment.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link STBVorbisComment.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static STBVorbisComment.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link STBVorbisComment.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static STBVorbisComment.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static STBVorbisComment.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
/**
* Returns a new {@code STBVorbisComment} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static STBVorbisComment malloc(MemoryStack stack) {
return wrap(STBVorbisComment.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code STBVorbisComment} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static STBVorbisComment calloc(MemoryStack stack) {
return wrap(STBVorbisComment.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link STBVorbisComment.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static STBVorbisComment.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link STBVorbisComment.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static STBVorbisComment.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #vendor}. */
public static ByteBuffer nvendor(long struct) { return memByteBufferNT1(memGetAddress(struct + STBVorbisComment.VENDOR)); }
/** Unsafe version of {@link #vendorString}. */
public static String nvendorString(long struct) { return memASCII(memGetAddress(struct + STBVorbisComment.VENDOR)); }
/** Unsafe version of {@link #comment_list_length}. */
public static int ncomment_list_length(long struct) { return UNSAFE.getInt(null, struct + STBVorbisComment.COMMENT_LIST_LENGTH); }
/** Unsafe version of {@link #comment_list() comment_list}. */
public static PointerBuffer ncomment_list(long struct) { return memPointerBuffer(memGetAddress(struct + STBVorbisComment.COMMENT_LIST), ncomment_list_length(struct)); }
// -----------------------------------
/** An array of {@link STBVorbisComment} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final STBVorbisComment ELEMENT_FACTORY = STBVorbisComment.create(-1L);
/**
* Creates a new {@code 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 {@link STBVorbisComment#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected STBVorbisComment getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code vendor} field. */
@NativeType("char *")
public ByteBuffer vendor() { return STBVorbisComment.nvendor(address()); }
/** @return the null-terminated string pointed to by the {@code vendor} field. */
@NativeType("char *")
public String vendorString() { return STBVorbisComment.nvendorString(address()); }
/** @return the value of the {@code comment_list_length} field. */
public int comment_list_length() { return STBVorbisComment.ncomment_list_length(address()); }
/** @return a {@link PointerBuffer} view of the data pointed to by the {@code comment_list} field. */
@NativeType("char **")
public PointerBuffer comment_list() { return STBVorbisComment.ncomment_list(address()); }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy