Package org.lwjgl.stb

Class STBIIOCallbacks

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<STBIIOCallbacks>

org.lwjgl.stb.STBIIOCallbacks

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class STBIIOCallbacks
extends Struct<STBIIOCallbacks>
implements NativeResource

Image IO callbacks, used by load_from_callbacks.

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	Description
static class	STBIIOCallbacks.Buffer	An array of STBIIOCallbacks structs.

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EOF	The struct member offsets.
static final int	READ	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
STBIIOCallbacks(ByteBuffer container)	Creates a STBIIOCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new STBIIOCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static STBIIOCallbacks	calloc(MemoryStack stack)	Returns a new STBIIOCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.
static STBIIOCallbacks	callocStack()	Deprecated.
static STBIIOCallbacks.Buffer	callocStack(int capacity)	Deprecated.
static STBIIOCallbacks.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static STBIIOCallbacks	callocStack(MemoryStack stack)	Deprecated.
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 nonzero if we are at end of file/data
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new STBIIOCallbacks.Buffer instance allocated on the specified MemoryStack.
static STBIIOCallbacks	malloc(MemoryStack stack)	Returns a new STBIIOCallbacks instance allocated on the specified MemoryStack.
static STBIIOCallbacks	mallocStack()	Deprecated.
static STBIIOCallbacks.Buffer	mallocStack(int capacity)	Deprecated.
static STBIIOCallbacks.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static STBIIOCallbacks	mallocStack(MemoryStack stack)	Deprecated.
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()	fill data with size bytes.
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()	Returns sizeof(struct).
STBISkipCallback	skip()	skip the next n bytes, or unget the last -n bytes if negative
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.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

STBIIOCallbacks

public STBIIOCallbacks(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<STBIIOCallbacks>

read

public STBIReadCallback read()

fill data with size bytes. Return number of bytes actually read.

skip

public STBISkipCallback skip()

skip the next n bytes, or unget the last -n bytes if negative

eof

public STBIEOFCallback eof()

returns nonzero if we are at end of file/data

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

@Deprecated
public static STBIIOCallbacks mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static STBIIOCallbacks callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static STBIIOCallbacks mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static STBIIOCallbacks callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static STBIIOCallbacks.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static STBIIOCallbacks.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static STBIIOCallbacks.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static STBIIOCallbacks.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static STBIIOCallbacks malloc(MemoryStack stack)

Returns a new STBIIOCallbacks instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static STBIIOCallbacks calloc(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

malloc

public static STBIIOCallbacks.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new STBIIOCallbacks.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static STBIIOCallbacks.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new STBIIOCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

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