Top Description Inners Fields Constructors Methods
org.lwjgl.stb

public Class STBIIOCallbacks

extends Struct<STBIIOCallbacks>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct stbi_io_callbacks
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EOF

The struct member offsets.

public static final int
READ

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SKIP

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
STBIIOCallbacks(long address, ByteBuffer container)

public
STBIIOCallbacks(ByteBuffer container)

Creates a STBIIOCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static STBIIOCallbacks
calloc()

Returns a new STBIIOCallbacks instance allocated with memCalloc.

public static STBIIOCallbacks.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new STBIIOCallbacks.Buffer instance allocated with memCalloc.

public static STBIIOCallbacks
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static STBIIOCallbacks.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static STBIIOCallbacks
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static STBIIOCallbacks
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static STBIIOCallbacks.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static STBIIOCallbacks.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected STBIIOCallbacks
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static STBIIOCallbacks
create()

Returns a new STBIIOCallbacks instance allocated with BufferUtils.

public static STBIIOCallbacks
create(long address)

Returns a new STBIIOCallbacks instance for the specified memory address.

public static STBIIOCallbacks.Buffer
create(int
the buffer capacity
capacity
)

Returns a new STBIIOCallbacks.Buffer instance allocated with BufferUtils.

public static STBIIOCallbacks.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a STBIIOCallbacks.Buffer instance at the specified memory.

public static STBIIOCallbacks
createSafe(long address)

Like create, but returns null if address is NULL.

public static STBIIOCallbacks.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public STBIEOFCallback
eof()

returns nonzero if we are at end of file/data

public STBIIOCallbacks
eof(STBIEOFCallbackI value)

Sets the specified value to the eof field.

public static STBIIOCallbacks
malloc()

Returns a new STBIIOCallbacks instance allocated with memAlloc.

public static STBIIOCallbacks.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new STBIIOCallbacks.Buffer instance allocated with memAlloc.

public static STBIIOCallbacks
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new STBIIOCallbacks instance allocated on the specified MemoryStack.

public static STBIIOCallbacks.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static STBIIOCallbacks
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static STBIIOCallbacks
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static STBIIOCallbacks.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static STBIIOCallbacks.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static STBIEOFCallback
neof(long struct)

Unsafe version of eof.

public static void
neof(long struct, STBIEOFCallbackI value)

Unsafe version of eof.

public static STBIReadCallback
nread(long struct)

Unsafe version of read.

public static void
nread(long struct, STBIReadCallbackI value)

Unsafe version of read.

public static STBISkipCallback
nskip(long struct)

Unsafe version of skip.

public static void
nskip(long struct, STBISkipCallbackI value)

Unsafe version of skip.

public STBIReadCallback
read()

fill data with size bytes.

public STBIIOCallbacks
read(STBIReadCallbackI value)

Sets the specified value to the read field.

public STBIIOCallbacks
set(STBIReadCallbackI read, STBISkipCallbackI skip, STBIEOFCallbackI eof)

Initializes this struct with the specified values.

public STBIIOCallbacks

Returns:

this struct
set
(STBIIOCallbacks
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public STBISkipCallback
skip()

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

public STBIIOCallbacks
skip(STBISkipCallbackI value)

Sets the specified value to the skip field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

EOFback to summary
public static final int EOF

The struct member offsets.

READback to summary
public static final int READ

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SKIPback to summary
public static final int SKIP

The struct member offsets.

Constructor Detail

STBIIOCallbacksback to summary
protected STBIIOCallbacks(long address, ByteBuffer container)
STBIIOCallbacksback to summary
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 Detail

callocback to summary
public static STBIIOCallbacks calloc()

Returns a new STBIIOCallbacks instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static STBIIOCallbacks.Buffer calloc(int capacity)

Returns a new STBIIOCallbacks.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static STBIIOCallbacks callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static STBIIOCallbacks callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static STBIIOCallbacks.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static STBIIOCallbacks.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected STBIIOCallbacks create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static STBIIOCallbacks create()

Returns a new STBIIOCallbacks instance allocated with BufferUtils.

createback to summary
public static STBIIOCallbacks create(long address)

Returns a new STBIIOCallbacks instance for the specified memory address.

createback to summary
public static STBIIOCallbacks.Buffer create(int capacity)

Returns a new STBIIOCallbacks.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static STBIIOCallbacks.Buffer create(long address, int capacity)

Create a STBIIOCallbacks.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static STBIIOCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static STBIIOCallbacks.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
eofback to summary
public STBIEOFCallback eof()

returns nonzero if we are at end of file/data

Annotations
@NativeType:int (*) (void *)
eofback to summary
public STBIIOCallbacks eof(STBIEOFCallbackI value)

Sets the specified value to the eof field.

mallocback to summary
public static STBIIOCallbacks malloc()

Returns a new STBIIOCallbacks instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static STBIIOCallbacks.Buffer malloc(int capacity)

Returns a new STBIIOCallbacks.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static STBIIOCallbacks malloc(MemoryStack stack)

Returns a new STBIIOCallbacks instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static STBIIOCallbacks mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static STBIIOCallbacks mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static STBIIOCallbacks.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static STBIIOCallbacks.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
neofback to summary
public static STBIEOFCallback neof(long struct)

Unsafe version of eof.

neofback to summary
public static void neof(long struct, STBIEOFCallbackI value)

Unsafe version of eof.

nreadback to summary
public static STBIReadCallback nread(long struct)

Unsafe version of read.

nreadback to summary
public static void nread(long struct, STBIReadCallbackI value)

Unsafe version of read.

nskipback to summary
public static STBISkipCallback nskip(long struct)

Unsafe version of skip.

nskipback to summary
public static void nskip(long struct, STBISkipCallbackI value)

Unsafe version of skip.

readback to summary
public STBIReadCallback read()

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

Annotations
@NativeType:int (*) (void *, char *, int)
readback to summary
public STBIIOCallbacks read(STBIReadCallbackI value)

Sets the specified value to the read field.

setback to summary
public STBIIOCallbacks set(STBIReadCallbackI read, STBISkipCallbackI skip, STBIEOFCallbackI eof)

Initializes this struct with the specified values.

setback to summary
public STBIIOCallbacks set(STBIIOCallbacks src)

Copies the specified struct data to this struct.

Parameters
src:STBIIOCallbacks

the source struct

Returns:STBIIOCallbacks

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
skipback to summary
public STBISkipCallback skip()

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

Annotations
@NativeType:void (*) (void *, int)
skipback to summary
public STBIIOCallbacks skip(STBISkipCallbackI value)

Sets the specified value to the skip field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.stb back to summary

public Class STBIIOCallbacks.Buffer

extends StructBuffer<STBIIOCallbacks, STBIIOCallbacks.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of STBIIOCallbacks structs.

Field Summary

Modifier and TypeField and Description
private static final STBIIOCallbacks

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new STBIIOCallbacks.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public STBIEOFCallback

Returns:

the value of the STBIIOCallbacks#eof field.
eof
()

public STBIIOCallbacks.Buffer
eof(STBIEOFCallbackI value)

Sets the specified value to the STBIIOCallbacks#eof field.

protected STBIIOCallbacks
public STBIReadCallback

Returns:

the value of the STBIIOCallbacks#read field.
read
()

public STBIIOCallbacks.Buffer
read(STBIReadCallbackI value)

Sets the specified value to the STBIIOCallbacks#read field.

protected STBIIOCallbacks.Buffer
public STBISkipCallback

Returns:

the value of the STBIIOCallbacks#skip field.
skip
()

public STBIIOCallbacks.Buffer
skip(STBISkipCallbackI value)

Sets the specified value to the STBIIOCallbacks#skip field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final STBIIOCallbacks ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new STBIIOCallbacks.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 STBIIOCallbacks#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

eofback to summary
public STBIEOFCallback eof()
Returns:STBIEOFCallback

the value of the STBIIOCallbacks#eof field.

Annotations
@NativeType:int (*) (void *)
eofback to summary
public STBIIOCallbacks.Buffer eof(STBIEOFCallbackI value)

Sets the specified value to the STBIIOCallbacks#eof field.

getElementFactoryback to summary
protected STBIIOCallbacks getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
readback to summary
public STBIReadCallback read()
Returns:STBIReadCallback

the value of the STBIIOCallbacks#read field.

Annotations
@NativeType:int (*) (void *, char *, int)
readback to summary
public STBIIOCallbacks.Buffer read(STBIReadCallbackI value)

Sets the specified value to the STBIIOCallbacks#read field.

selfback to summary
protected STBIIOCallbacks.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
skipback to summary
public STBISkipCallback skip()
Returns:STBISkipCallback

the value of the STBIIOCallbacks#skip field.

Annotations
@NativeType:void (*) (void *, int)
skipback to summary
public STBIIOCallbacks.Buffer skip(STBISkipCallbackI value)

Sets the specified value to the STBIIOCallbacks#skip field.