Package org.lwjgl.stb

Class STBVorbisAlloc

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

    public class STBVorbisAlloc
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    A buffer to use for allocations by STBVorbis

    Layout

    struct stb_vorbis_alloc {
    char * alloc_buffer;
    int alloc_buffer_length_in_bytes;
}

    • Field Detail

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.

    • Constructor Detail

      • STBVorbisAlloc

        public STBVorbisAlloc(java.nio.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

      • sizeof

        public int sizeof()
        Description copied from class: org.lwjgl.system.Struct
        Returns the sizeof(struct).
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • alloc_buffer

        public java.nio.ByteBuffer alloc_buffer()
        Returns a ByteBuffer view of the data pointed to by the alloc_buffer field.

      • alloc_buffer_length_in_bytes

        public int alloc_buffer_length_in_bytes()
        Returns the value of the alloc_buffer_length_in_bytes field.

      • alloc_buffer

        public STBVorbisAlloc alloc_buffer(java.nio.ByteBuffer value)
        Sets the address of the specified ByteBuffer to the alloc_buffer field.

      • set

        public STBVorbisAlloc set(STBVorbisAlloc src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct

      • malloc

        public static STBVorbisAlloc malloc()
        Returns a new STBVorbisAlloc instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static STBVorbisAlloc calloc()
        Returns a new STBVorbisAlloc instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static STBVorbisAlloc create(long address)
        Returns a new STBVorbisAlloc instance for the specified memory address or null if the address is NULL.

      • malloc

        public static STBVorbisAlloc.Buffer malloc(int capacity)
        Returns a new STBVorbisAlloc.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • calloc

        public static STBVorbisAlloc.Buffer calloc(int capacity)
        Returns a new STBVorbisAlloc.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • create

        public static STBVorbisAlloc.Buffer create(long address,
                                           int capacity)
        Create a STBVorbisAlloc.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity

      • callocStack

        public static STBVorbisAlloc callocStack()
        Returns a new STBVorbisAlloc instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

      • mallocStack

        public static STBVorbisAlloc mallocStack(org.lwjgl.system.MemoryStack stack)
        Returns a new STBVorbisAlloc instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • callocStack

        public static STBVorbisAlloc callocStack(org.lwjgl.system.MemoryStack stack)
        Returns a new STBVorbisAlloc instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • callocStack

        public static STBVorbisAlloc.Buffer callocStack(int capacity)
        Returns a new STBVorbisAlloc.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity

      • mallocStack

        public static STBVorbisAlloc.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
        Returns a new STBVorbisAlloc.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • callocStack

        public static STBVorbisAlloc.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
        Returns a new STBVorbisAlloc.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

      • validate

        public static void validate(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate

      • validate

        public static void validate(long array,
                            int count)
        Calls STBVorbisAlloc.validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array