Class SDL_IOStreamInterface

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_IOStreamInterface>

org.lwjgl.sdl.SDL_IOStreamInterface

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_IOStreamInterface
extends Struct<SDL_IOStreamInterface>
implements NativeResource

struct SDL_IOStreamInterface {
    Uint32 version;
    Sint64 (* size) (void * userdata);
    Sint64 (* seek) (void * userdata, Sint64 offset, SDL_IOWhence whence);
    size_t (* read) (void * userdata, void * ptr, size_t size, SDL_IOStatus * status);
    size_t (* write) (void * userdata, void const * ptr, size_t size, SDL_IOStatus * status);
    bool (* flush) (void * userdata, SDL_IOStatus * status);
    bool (* close) (void * userdata);
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SDL_IOStreamInterface.Buffer	An array of SDL_IOStreamInterface structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CLOSE	The struct member offsets.
static final int	FLUSH	The struct member offsets.
static final int	READ	The struct member offsets.
static final int	SEEK	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	VERSION	The struct member offsets.
static final int	WRITE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
SDL_IOStreamInterface(ByteBuffer container)	Creates a SDL_IOStreamInterface instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static SDL_IOStreamInterface	calloc()	Returns a new SDL_IOStreamInterface instance allocated with memCalloc.
static SDL_IOStreamInterface.Buffer	calloc(int capacity)	Returns a new SDL_IOStreamInterface.Buffer instance allocated with memCalloc.
static SDL_IOStreamInterface.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new SDL_IOStreamInterface.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_IOStreamInterface	calloc(MemoryStack stack)	Returns a new SDL_IOStreamInterface instance allocated on the specified MemoryStack and initializes all its bits to zero.
SDL_IOStreamInterfaceCloseCallback	close$()
SDL_IOStreamInterface	close$(SDL_IOStreamInterfaceCloseCallbackI value)	Sets the specified value to the close field.
static SDL_IOStreamInterface	create()	Returns a new SDL_IOStreamInterface instance allocated with BufferUtils.
static SDL_IOStreamInterface.Buffer	create(int capacity)	Returns a new SDL_IOStreamInterface.Buffer instance allocated with BufferUtils.
static SDL_IOStreamInterface	create(long address)	Returns a new SDL_IOStreamInterface instance for the specified memory address.
static SDL_IOStreamInterface.Buffer	create(long address, int capacity)	Create a SDL_IOStreamInterface.Buffer instance at the specified memory.
static @Nullable SDL_IOStreamInterface	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SDL_IOStreamInterface.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
SDL_IOStreamInterfaceFlushCallback	flush()
SDL_IOStreamInterface	flush(SDL_IOStreamInterfaceFlushCallbackI value)	Sets the specified value to the flush field.
static SDL_IOStreamInterface	malloc()	Returns a new SDL_IOStreamInterface instance allocated with memAlloc.
static SDL_IOStreamInterface.Buffer	malloc(int capacity)	Returns a new SDL_IOStreamInterface.Buffer instance allocated with memAlloc.
static SDL_IOStreamInterface.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new SDL_IOStreamInterface.Buffer instance allocated on the specified MemoryStack.
static SDL_IOStreamInterface	malloc(MemoryStack stack)	Returns a new SDL_IOStreamInterface instance allocated on the specified MemoryStack.
static SDL_IOStreamInterfaceCloseCallback	nclose$(long struct)	Unsafe version of close$().
static void	nclose$(long struct, SDL_IOStreamInterfaceCloseCallbackI value)	Unsafe version of close$.
static SDL_IOStreamInterfaceFlushCallback	nflush(long struct)	Unsafe version of flush().
static void	nflush(long struct, SDL_IOStreamInterfaceFlushCallbackI value)	Unsafe version of flush.
static SDL_IOStreamInterfaceReadCallback	nread(long struct)	Unsafe version of read().
static void	nread(long struct, SDL_IOStreamInterfaceReadCallbackI value)	Unsafe version of read.
static SDL_IOStreamInterfaceSeekCallback	nseek(long struct)	Unsafe version of seek().
static void	nseek(long struct, SDL_IOStreamInterfaceSeekCallbackI value)	Unsafe version of seek.
static SDL_IOStreamInterfaceSizeCallback	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, SDL_IOStreamInterfaceSizeCallbackI value)	Unsafe version of size.
static int	nversion(long struct)	Unsafe version of version().
static void	nversion(long struct, int value)	Unsafe version of version.
static SDL_IOStreamInterfaceWriteCallback	nwrite(long struct)	Unsafe version of write().
static void	nwrite(long struct, SDL_IOStreamInterfaceWriteCallbackI value)	Unsafe version of write.
SDL_IOStreamInterfaceReadCallback	read()
SDL_IOStreamInterface	read(SDL_IOStreamInterfaceReadCallbackI value)	Sets the specified value to the read field.
SDL_IOStreamInterfaceSeekCallback	seek()
SDL_IOStreamInterface	seek(SDL_IOStreamInterfaceSeekCallbackI value)	Sets the specified value to the seek field.
SDL_IOStreamInterface	set(int version, SDL_IOStreamInterfaceSizeCallbackI size, SDL_IOStreamInterfaceSeekCallbackI seek, SDL_IOStreamInterfaceReadCallbackI read, SDL_IOStreamInterfaceWriteCallbackI write, SDL_IOStreamInterfaceFlushCallbackI flush, SDL_IOStreamInterfaceCloseCallbackI close$)	Initializes this struct with the specified values.
SDL_IOStreamInterface	set(SDL_IOStreamInterface src)	Copies the specified struct data to this struct.
SDL_IOStreamInterfaceSizeCallback	size()
SDL_IOStreamInterface	size(SDL_IOStreamInterfaceSizeCallbackI value)	Sets the specified value to the size field.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	version()
SDL_IOStreamInterface	version(int value)	Sets the specified value to the version field.
SDL_IOStreamInterfaceWriteCallback	write()
SDL_IOStreamInterface	write(SDL_IOStreamInterfaceWriteCallbackI value)	Sets the specified value to the write field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

VERSION

public static final int VERSION

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

SEEK

public static final int SEEK

The struct member offsets.

READ

public static final int READ

The struct member offsets.

WRITE

public static final int WRITE

The struct member offsets.

FLUSH

public static final int FLUSH

The struct member offsets.

CLOSE

public static final int CLOSE

The struct member offsets.

Constructor Details

SDL_IOStreamInterface

public SDL_IOStreamInterface(ByteBuffer container)

Creates a SDL_IOStreamInterface 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<SDL_IOStreamInterface>

version

@NativeType("Uint32")
public int version()

Returns:

the value of the version field.

size

@NativeType("Sint64 (*) (void *)")
public SDL_IOStreamInterfaceSizeCallback size()

Returns:

the value of the size field.

seek

@NativeType("Sint64 (*) (void *, Sint64, SDL_IOWhence)")
public SDL_IOStreamInterfaceSeekCallback seek()

Returns:

the value of the seek field.

read

@NativeType("size_t (*) (void *, void *, size_t, SDL_IOStatus *)")
public SDL_IOStreamInterfaceReadCallback read()

Returns:

the value of the read field.

write

@NativeType("size_t (*) (void *, void const *, size_t, SDL_IOStatus *)")
public SDL_IOStreamInterfaceWriteCallback write()

Returns:

the value of the write field.

flush

@NativeType("bool (*) (void *, SDL_IOStatus *)")
public SDL_IOStreamInterfaceFlushCallback flush()

Returns:

the value of the flush field.

close$

@NativeType("bool (*) (void *)")
public SDL_IOStreamInterfaceCloseCallback close$()

Returns:

the value of the close field.

version

public SDL_IOStreamInterface version(@NativeType("Uint32")
 int value)

Sets the specified value to the version field.

size

public SDL_IOStreamInterface size(@NativeType("Sint64 (*) (void *)")
 SDL_IOStreamInterfaceSizeCallbackI value)

Sets the specified value to the size field.

seek

public SDL_IOStreamInterface seek(@NativeType("Sint64 (*) (void *, Sint64, SDL_IOWhence)")
 SDL_IOStreamInterfaceSeekCallbackI value)

Sets the specified value to the seek field.

read

public SDL_IOStreamInterface read(@NativeType("size_t (*) (void *, void *, size_t, SDL_IOStatus *)")
 SDL_IOStreamInterfaceReadCallbackI value)

Sets the specified value to the read field.

write

public SDL_IOStreamInterface write(@NativeType("size_t (*) (void *, void const *, size_t, SDL_IOStatus *)")
 SDL_IOStreamInterfaceWriteCallbackI value)

Sets the specified value to the write field.

flush

public SDL_IOStreamInterface flush(@NativeType("bool (*) (void *, SDL_IOStatus *)")
 SDL_IOStreamInterfaceFlushCallbackI value)

Sets the specified value to the flush field.

close$

public SDL_IOStreamInterface close$(@NativeType("bool (*) (void *)")
 SDL_IOStreamInterfaceCloseCallbackI value)

Sets the specified value to the close field.

set

public SDL_IOStreamInterface set(int version,
 SDL_IOStreamInterfaceSizeCallbackI size,
 SDL_IOStreamInterfaceSeekCallbackI seek,
 SDL_IOStreamInterfaceReadCallbackI read,
 SDL_IOStreamInterfaceWriteCallbackI write,
 SDL_IOStreamInterfaceFlushCallbackI flush,
 SDL_IOStreamInterfaceCloseCallbackI close$)

Initializes this struct with the specified values.

set

public SDL_IOStreamInterface set(SDL_IOStreamInterface src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_IOStreamInterface malloc()

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

calloc

public static SDL_IOStreamInterface calloc()

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

create

public static SDL_IOStreamInterface create()

Returns a new SDL_IOStreamInterface instance allocated with BufferUtils.

create

public static SDL_IOStreamInterface create(long address)

Returns a new SDL_IOStreamInterface instance for the specified memory address.

createSafe

public static @Nullable SDL_IOStreamInterface createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_IOStreamInterface.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static SDL_IOStreamInterface.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static SDL_IOStreamInterface.Buffer create(int capacity)

Returns a new SDL_IOStreamInterface.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static SDL_IOStreamInterface.Buffer create(long address,
 int capacity)

Create a SDL_IOStreamInterface.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable SDL_IOStreamInterface.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static SDL_IOStreamInterface malloc(MemoryStack stack)

Returns a new SDL_IOStreamInterface instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_IOStreamInterface calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new SDL_IOStreamInterface.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

nversion

public static int nversion(long struct)

Unsafe version of version().

nsize

public static SDL_IOStreamInterfaceSizeCallback nsize(long struct)

Unsafe version of size().

nseek

public static SDL_IOStreamInterfaceSeekCallback nseek(long struct)

Unsafe version of seek().

nread

public static SDL_IOStreamInterfaceReadCallback nread(long struct)

Unsafe version of read().

nwrite

public static SDL_IOStreamInterfaceWriteCallback nwrite(long struct)

Unsafe version of write().

nflush

public static SDL_IOStreamInterfaceFlushCallback nflush(long struct)

Unsafe version of flush().

nclose$

public static SDL_IOStreamInterfaceCloseCallback nclose$(long struct)

Unsafe version of close$().

nversion

public static void nversion(long struct,
 int value)

Unsafe version of version.

nsize

public static void nsize(long struct,
 SDL_IOStreamInterfaceSizeCallbackI value)

Unsafe version of size.

nseek

public static void nseek(long struct,
 SDL_IOStreamInterfaceSeekCallbackI value)

Unsafe version of seek.

nread

public static void nread(long struct,
 SDL_IOStreamInterfaceReadCallbackI value)

Unsafe version of read.

nwrite

public static void nwrite(long struct,
 SDL_IOStreamInterfaceWriteCallbackI value)

Unsafe version of write.

nflush

public static void nflush(long struct,
 SDL_IOStreamInterfaceFlushCallbackI value)

Unsafe version of flush.

nclose$

public static void nclose$(long struct,
 SDL_IOStreamInterfaceCloseCallbackI value)

Unsafe version of close$.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate