Package org.lwjgl.stb

Class STBIIOCallbacks

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class STBIIOCallbacks
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Image IO callbacks, used by load_from_callbacks.

    Member documentation

    • read – fill data with size bytes. Return number of bytes actually read.
    • skip – skip the next n bytes, or unget the last -n bytes if negative
    • eof – returns nonzero if we are at end of file/data

    Layout

    
 struct stbi_io_callbacks {
     int (*read) (void *user, char *data, int size);
     void (*skip) (void *user, int n);
     int (*eof) (void *user);
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • READ, SKIP, EOF

        The struct member offsets.

    • Constructor Detail

      • STBIIOCallbacks

        public STBIIOCallbacks​(java.nio.ByteBuffer container)
        Creates a STBIIOCallbacks 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

      • set

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

      • malloc

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

      • calloc

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

      • create

        public static STBIIOCallbacks create()
        Returns a new STBIIOCallbacks instance allocated with BufferUtils.

      • create

        public static STBIIOCallbacks create​(long address)
        Returns a new STBIIOCallbacks instance for the specified memory address.

      • createSafe

        @Nullable
public static STBIIOCallbacks createSafe​(long address)
        Like create, but returns null if address is NULL.

      • malloc

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

      • calloc

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

      • create

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

      • createSafe

        @Nullable
public static STBIIOCallbacks.Buffer createSafe​(long address,
                                                int capacity)
        Like create, but returns null if address is NULL.

      • mallocStack

        public static STBIIOCallbacks mallocStack()
        Returns a new STBIIOCallbacks instance allocated on the thread-local MemoryStack.

      • callocStack

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

      • mallocStack

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

      • callocStack

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

      • callocStack

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

      • mallocStack

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

      • callocStack

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

      • neof

        public static void neof​(long struct,
                        STBIEOFCallbackI value)
        Unsafe version of eof.

      • 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 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