STBIIOCallbacks (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.stb.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);
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class STBIIOCallbacks.Buffer
An array of STBIIOCallbacks structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`STBIIOCallbacks.Buffer` An array of `STBIIOCallbacks` structs.

Field Summary

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

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

Constructors
Constructor and Description
`STBIIOCallbacks(java.nio.ByteBuffer container)` Creates a `STBIIOCallbacks` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static STBIIOCallbacks`	`calloc()` Returns a new `STBIIOCallbacks` instance allocated with `memCalloc`.
`static STBIIOCallbacks.Buffer`	`calloc(int capacity)` Returns a new `STBIIOCallbacks.Buffer` instance allocated with `memCalloc`.
`static STBIIOCallbacks`	`callocStack()` Returns a new `STBIIOCallbacks` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`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.
`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.
`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.
`static STBIIOCallbacks`	`create()` Returns a new `STBIIOCallbacks` instance allocated with `BufferUtils`.
`static STBIIOCallbacks.Buffer`	`create(int capacity)` Returns a new `STBIIOCallbacks.Buffer` instance allocated with `BufferUtils`.
`static STBIIOCallbacks`	`create(long address)` Returns a new `STBIIOCallbacks` instance for the specified memory address.
`static STBIIOCallbacks.Buffer`	`create(long address, int capacity)` Create a `STBIIOCallbacks.Buffer` instance at the specified memory.
`static STBIIOCallbacks`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBIIOCallbacks.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`STBIEOFCallback`	`eof()` Returns the value of the `eof` field.
`STBIIOCallbacks`	`eof(STBIEOFCallbackI value)` Sets the specified value to the `eof` field.
`static STBIIOCallbacks`	`malloc()` Returns a new `STBIIOCallbacks` instance allocated with `memAlloc`.
`static STBIIOCallbacks.Buffer`	`malloc(int capacity)` Returns a new `STBIIOCallbacks.Buffer` instance allocated with `memAlloc`.
`static STBIIOCallbacks`	`mallocStack()` Returns a new `STBIIOCallbacks` instance allocated on the thread-local `MemoryStack`.
`static STBIIOCallbacks.Buffer`	`mallocStack(int capacity)` Returns a new `STBIIOCallbacks.Buffer` instance allocated on the thread-local `MemoryStack`.
`static STBIIOCallbacks.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBIIOCallbacks.Buffer` instance allocated on the specified `MemoryStack`.
`static STBIIOCallbacks`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBIIOCallbacks` instance allocated on the specified `MemoryStack`.
`static STBIEOFCallback`	`neof(long struct)` Unsafe version of `eof()`.
`static void`	`neof(long struct, STBIEOFCallbackI value)` Unsafe version of `eof`.
`static STBIReadCallback`	`nread(long struct)` Unsafe version of `read()`.
`static void`	`nread(long struct, STBIReadCallbackI value)` Unsafe version of `read`.
`static STBISkipCallback`	`nskip(long struct)` Unsafe version of `skip()`.
`static void`	`nskip(long struct, STBISkipCallbackI value)` Unsafe version of `skip`.
`STBIReadCallback`	`read()` Returns the value of the `read` field.
`STBIIOCallbacks`	`read(STBIReadCallbackI value)` Sets the specified value to the `read` field.
`STBIIOCallbacks`	`set(STBIIOCallbacks src)` Copies the specified struct data to this struct.
`STBIIOCallbacks`	`set(STBIReadCallbackI read, STBISkipCallbackI skip, STBIEOFCallbackI eof)` Initializes this struct with the specified values.
`int`	`sizeof()`
`STBISkipCallback`	`skip()` Returns the value of the `skip` field.
`STBIIOCallbacks`	`skip(STBISkipCallbackI value)` Sets the specified value to the `skip` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - READ
```
public static final int READ
```
    The struct member offsets.
  - SKIP
```
public static final int SKIP
```
    The struct member offsets.
  - EOF
```
public static final int 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
  - read
```
public STBIReadCallback read()
```
    Returns the value of the read field.
  - skip
```
public STBISkipCallback skip()
```
    Returns the value of the skip field.
  - eof
```
public STBIEOFCallback eof()
```
    Returns the value of the eof field.
  - read
```
public STBIIOCallbacks read(STBIReadCallbackI value)
```
    Sets the specified value to the read field.
  - skip
```
public STBIIOCallbacks skip(STBISkipCallbackI value)
```
    Sets the specified value to the skip field.
  - eof
```
public STBIIOCallbacks eof(STBIEOFCallbackI value)
```
    Sets the specified value to the eof field.
  - set
```
public STBIIOCallbacks set(STBIReadCallbackI read,
                           STBISkipCallbackI skip,
                           STBIEOFCallbackI eof)
```
    Initializes this struct with the specified values.
  - 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(int capacity)
```
    Returns a new STBIIOCallbacks.Buffer instance allocated with BufferUtils.
    
    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
  - mallocStack
```
public static STBIIOCallbacks.Buffer mallocStack(int capacity)
```
    Returns a new STBIIOCallbacks.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - 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
  - nread
```
public static STBIReadCallback nread(long struct)
```
    Unsafe version of read().
  - nskip
```
public static STBISkipCallback nskip(long struct)
```
    Unsafe version of skip().
  - neof
```
public static STBIEOFCallback neof(long struct)
```
    Unsafe version of eof().
  - nread
```
public static void nread(long struct,
                         STBIReadCallbackI value)
```
    Unsafe version of read.
  - nskip
```
public static void nskip(long struct,
                         STBISkipCallbackI value)
```
    Unsafe version of skip.
  - 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

Class STBIIOCallbacks

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

READ

SKIP

EOF

Constructor Detail

STBIIOCallbacks

Method Detail

sizeof

read

skip

eof

read

skip

eof

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nread

nskip

neof

nread

nskip

neof

validate

validate