Class SDL_StorageInterface

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_StorageInterface>

org.lwjgl.sdl.SDL_StorageInterface

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_StorageInterface
extends Struct<SDL_StorageInterface>
implements NativeResource

struct SDL_StorageInterface {
    Uint32 version;
    bool (* close) (void * userdata);
    bool (* ready) (void * userdata);
    bool (* enumerate) (void * userdata, char const * path, SDL_EnumerateDirectoryCallback callback, void * callback_userdata);
    bool (* info) (void * userdata, char const * path, SDL_PathInfo * info);
    bool (* read_file) (void * userdata, char const * path, void * destination, Uint64 length);
    bool (* write_file) (void * userdata, char const * path, void const * source, Uint64 length);
    bool (* mkdir) (void * userdata, char const * path);
    bool (* remove) (void * userdata, char const * path);
    bool (* rename) (void * userdata, char const * oldpath, char const * newpath);
    bool (* copy) (void * userdata, char const * oldpath, char const * newpath);
    Uint64 (* space_remaining) (void * userdata);
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SDL_StorageInterface.Buffer	An array of SDL_StorageInterface 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	COPY	The struct member offsets.
static final int	ENUMERATE	The struct member offsets.
static final int	INFO	The struct member offsets.
static final int	MKDIR	The struct member offsets.
static final int	READ_FILE	The struct member offsets.
static final int	READY	The struct member offsets.
static final int	REMOVE	The struct member offsets.
static final int	RENAME	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE_REMAINING	The struct member offsets.
static final int	VERSION	The struct member offsets.
static final int	WRITE_FILE	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_StorageInterface(ByteBuffer container)	Creates a SDL_StorageInterface instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static SDL_StorageInterface	calloc()	Returns a new SDL_StorageInterface instance allocated with memCalloc.
static SDL_StorageInterface.Buffer	calloc(int capacity)	Returns a new SDL_StorageInterface.Buffer instance allocated with memCalloc.
static SDL_StorageInterface.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new SDL_StorageInterface.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_StorageInterface	calloc(MemoryStack stack)	Returns a new SDL_StorageInterface instance allocated on the specified MemoryStack and initializes all its bits to zero.
@Nullable SDL_StorageInterfaceCloseCallback	close$()
SDL_StorageInterface	close$(@Nullable SDL_StorageInterfaceCloseCallbackI value)	Sets the specified value to the close field.
@Nullable SDL_StorageInterfaceCopyCallback	copy()
SDL_StorageInterface	copy(@Nullable SDL_StorageInterfaceCopyCallbackI value)	Sets the specified value to the copy field.
static SDL_StorageInterface	create()	Returns a new SDL_StorageInterface instance allocated with BufferUtils.
static SDL_StorageInterface.Buffer	create(int capacity)	Returns a new SDL_StorageInterface.Buffer instance allocated with BufferUtils.
static SDL_StorageInterface	create(long address)	Returns a new SDL_StorageInterface instance for the specified memory address.
static SDL_StorageInterface.Buffer	create(long address, int capacity)	Create a SDL_StorageInterface.Buffer instance at the specified memory.
static @Nullable SDL_StorageInterface	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SDL_StorageInterface.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
@Nullable SDL_StorageInterfaceEnumerateCallback	enumerate()
SDL_StorageInterface	enumerate(@Nullable SDL_StorageInterfaceEnumerateCallbackI value)	Sets the specified value to the enumerate field.
@Nullable SDL_StorageInterfaceInfoCallback	info()
SDL_StorageInterface	info(@Nullable SDL_StorageInterfaceInfoCallbackI value)	Sets the specified value to the info field.
static SDL_StorageInterface	malloc()	Returns a new SDL_StorageInterface instance allocated with memAlloc.
static SDL_StorageInterface.Buffer	malloc(int capacity)	Returns a new SDL_StorageInterface.Buffer instance allocated with memAlloc.
static SDL_StorageInterface.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new SDL_StorageInterface.Buffer instance allocated on the specified MemoryStack.
static SDL_StorageInterface	malloc(MemoryStack stack)	Returns a new SDL_StorageInterface instance allocated on the specified MemoryStack.
@Nullable SDL_StorageInterfaceMkdirCallback	mkdir()
SDL_StorageInterface	mkdir(@Nullable SDL_StorageInterfaceMkdirCallbackI value)	Sets the specified value to the mkdir field.
static @Nullable SDL_StorageInterfaceCloseCallback	nclose$(long struct)	Unsafe version of close$().
static void	nclose$(long struct, @Nullable SDL_StorageInterfaceCloseCallbackI value)	Unsafe version of close$.
static @Nullable SDL_StorageInterfaceCopyCallback	ncopy(long struct)	Unsafe version of copy().
static void	ncopy(long struct, @Nullable SDL_StorageInterfaceCopyCallbackI value)	Unsafe version of copy.
static @Nullable SDL_StorageInterfaceEnumerateCallback	nenumerate(long struct)	Unsafe version of enumerate().
static void	nenumerate(long struct, @Nullable SDL_StorageInterfaceEnumerateCallbackI value)	Unsafe version of enumerate.
static @Nullable SDL_StorageInterfaceInfoCallback	ninfo(long struct)	Unsafe version of info().
static void	ninfo(long struct, @Nullable SDL_StorageInterfaceInfoCallbackI value)	Unsafe version of info.
static @Nullable SDL_StorageInterfaceMkdirCallback	nmkdir(long struct)	Unsafe version of mkdir().
static void	nmkdir(long struct, @Nullable SDL_StorageInterfaceMkdirCallbackI value)	Unsafe version of mkdir.
static @Nullable SDL_StorageInterfaceReadFileCallback	nread_file(long struct)	Unsafe version of read_file().
static void	nread_file(long struct, @Nullable SDL_StorageInterfaceReadFileCallbackI value)	Unsafe version of read_file.
static @Nullable SDL_StorageInterfaceReadyCallback	nready(long struct)	Unsafe version of ready().
static void	nready(long struct, @Nullable SDL_StorageInterfaceReadyCallbackI value)	Unsafe version of ready.
static @Nullable SDL_StorageInterfaceRemoveCallback	nremove(long struct)	Unsafe version of remove().
static void	nremove(long struct, @Nullable SDL_StorageInterfaceRemoveCallbackI value)	Unsafe version of remove.
static @Nullable SDL_StorageInterfaceRenameCallback	nrename(long struct)	Unsafe version of rename().
static void	nrename(long struct, @Nullable SDL_StorageInterfaceRenameCallbackI value)	Unsafe version of rename.
static @Nullable SDL_StorageInterfaceSpaceRemainingCallback	nspace_remaining(long struct)	Unsafe version of space_remaining().
static void	nspace_remaining(long struct, @Nullable SDL_StorageInterfaceSpaceRemainingCallbackI value)	Unsafe version of space_remaining.
static int	nversion(long struct)	Unsafe version of version().
static void	nversion(long struct, int value)	Unsafe version of version.
static @Nullable SDL_StorageInterfaceWriteFileCallback	nwrite_file(long struct)	Unsafe version of write_file().
static void	nwrite_file(long struct, @Nullable SDL_StorageInterfaceWriteFileCallbackI value)	Unsafe version of write_file.
@Nullable SDL_StorageInterfaceReadFileCallback	read_file()
SDL_StorageInterface	read_file(@Nullable SDL_StorageInterfaceReadFileCallbackI value)	Sets the specified value to the read_file field.
@Nullable SDL_StorageInterfaceReadyCallback	ready()
SDL_StorageInterface	ready(@Nullable SDL_StorageInterfaceReadyCallbackI value)	Sets the specified value to the ready field.
@Nullable SDL_StorageInterfaceRemoveCallback	remove()
SDL_StorageInterface	remove(@Nullable SDL_StorageInterfaceRemoveCallbackI value)	Sets the specified value to the remove field.
@Nullable SDL_StorageInterfaceRenameCallback	rename()
SDL_StorageInterface	rename(@Nullable SDL_StorageInterfaceRenameCallbackI value)	Sets the specified value to the rename field.
SDL_StorageInterface	set(int version, SDL_StorageInterfaceCloseCallbackI close$, SDL_StorageInterfaceReadyCallbackI ready, SDL_StorageInterfaceEnumerateCallbackI enumerate, SDL_StorageInterfaceInfoCallbackI info, SDL_StorageInterfaceReadFileCallbackI read_file, SDL_StorageInterfaceWriteFileCallbackI write_file, SDL_StorageInterfaceMkdirCallbackI mkdir, SDL_StorageInterfaceRemoveCallbackI remove, SDL_StorageInterfaceRenameCallbackI rename, SDL_StorageInterfaceCopyCallbackI copy, SDL_StorageInterfaceSpaceRemainingCallbackI space_remaining)	Initializes this struct with the specified values.
SDL_StorageInterface	set(SDL_StorageInterface src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
@Nullable SDL_StorageInterfaceSpaceRemainingCallback	space_remaining()
SDL_StorageInterface	space_remaining(@Nullable SDL_StorageInterfaceSpaceRemainingCallbackI value)	Sets the specified value to the space_remaining field.
int	version()
SDL_StorageInterface	version(int value)	Sets the specified value to the version field.
@Nullable SDL_StorageInterfaceWriteFileCallback	write_file()
SDL_StorageInterface	write_file(@Nullable SDL_StorageInterfaceWriteFileCallbackI value)	Sets the specified value to the write_file 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.

CLOSE

public static final int CLOSE

The struct member offsets.

READY

public static final int READY

The struct member offsets.

ENUMERATE

public static final int ENUMERATE

The struct member offsets.

INFO

public static final int INFO

The struct member offsets.

READ_FILE

public static final int READ_FILE

The struct member offsets.

WRITE_FILE

public static final int WRITE_FILE

The struct member offsets.

MKDIR

public static final int MKDIR

The struct member offsets.

REMOVE

public static final int REMOVE

The struct member offsets.

RENAME

public static final int RENAME

The struct member offsets.

COPY

public static final int COPY

The struct member offsets.

SPACE_REMAINING

public static final int SPACE_REMAINING

The struct member offsets.

Constructor Details

SDL_StorageInterface

public SDL_StorageInterface(ByteBuffer container)

Creates a SDL_StorageInterface 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_StorageInterface>

version

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

Returns:

the value of the version field.

close$

@NativeType("bool (*) (void *)")
public @Nullable SDL_StorageInterfaceCloseCallback close$()

Returns:

the value of the close field.

ready

@NativeType("bool (*) (void *)")
public @Nullable SDL_StorageInterfaceReadyCallback ready()

Returns:

the value of the ready field.

enumerate

@NativeType("bool (*) (void *, char const *, SDL_EnumerateDirectoryCallback, void *)")
public @Nullable SDL_StorageInterfaceEnumerateCallback enumerate()

Returns:

the value of the enumerate field.

info

@NativeType("bool (*) (void *, char const *, SDL_PathInfo *)")
public @Nullable SDL_StorageInterfaceInfoCallback info()

Returns:

the value of the info field.

read_file

@NativeType("bool (*) (void *, char const *, void *, Uint64)")
public @Nullable SDL_StorageInterfaceReadFileCallback read_file()

Returns:

the value of the read_file field.

write_file

@NativeType("bool (*) (void *, char const *, void const *, Uint64)")
public @Nullable SDL_StorageInterfaceWriteFileCallback write_file()

Returns:

the value of the write_file field.

mkdir

@NativeType("bool (*) (void *, char const *)")
public @Nullable SDL_StorageInterfaceMkdirCallback mkdir()

Returns:

the value of the mkdir field.

remove

@NativeType("bool (*) (void *, char const *)")
public @Nullable SDL_StorageInterfaceRemoveCallback remove()

Returns:

the value of the remove field.

rename

@NativeType("bool (*) (void *, char const *, char const *)")
public @Nullable SDL_StorageInterfaceRenameCallback rename()

Returns:

the value of the rename field.

copy

@NativeType("bool (*) (void *, char const *, char const *)")
public @Nullable SDL_StorageInterfaceCopyCallback copy()

Returns:

the value of the copy field.

space_remaining

@NativeType("Uint64 (*) (void *)")
public @Nullable SDL_StorageInterfaceSpaceRemainingCallback space_remaining()

Returns:

the value of the space_remaining field.

version

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

Sets the specified value to the version field.

close$

public SDL_StorageInterface close$(@NativeType("bool (*) (void *)")
 @Nullable SDL_StorageInterfaceCloseCallbackI value)

Sets the specified value to the close field.

ready

public SDL_StorageInterface ready(@NativeType("bool (*) (void *)")
 @Nullable SDL_StorageInterfaceReadyCallbackI value)

Sets the specified value to the ready field.

enumerate

public SDL_StorageInterface enumerate(@NativeType("bool (*) (void *, char const *, SDL_EnumerateDirectoryCallback, void *)")
 @Nullable SDL_StorageInterfaceEnumerateCallbackI value)

Sets the specified value to the enumerate field.

info

public SDL_StorageInterface info(@NativeType("bool (*) (void *, char const *, SDL_PathInfo *)")
 @Nullable SDL_StorageInterfaceInfoCallbackI value)

Sets the specified value to the info field.

read_file

public SDL_StorageInterface read_file(@NativeType("bool (*) (void *, char const *, void *, Uint64)")
 @Nullable SDL_StorageInterfaceReadFileCallbackI value)

Sets the specified value to the read_file field.

write_file

public SDL_StorageInterface write_file(@NativeType("bool (*) (void *, char const *, void const *, Uint64)")
 @Nullable SDL_StorageInterfaceWriteFileCallbackI value)

Sets the specified value to the write_file field.

mkdir

public SDL_StorageInterface mkdir(@NativeType("bool (*) (void *, char const *)")
 @Nullable SDL_StorageInterfaceMkdirCallbackI value)

Sets the specified value to the mkdir field.

remove

public SDL_StorageInterface remove(@NativeType("bool (*) (void *, char const *)")
 @Nullable SDL_StorageInterfaceRemoveCallbackI value)

Sets the specified value to the remove field.

rename

public SDL_StorageInterface rename(@NativeType("bool (*) (void *, char const *, char const *)")
 @Nullable SDL_StorageInterfaceRenameCallbackI value)

Sets the specified value to the rename field.

copy

public SDL_StorageInterface copy(@NativeType("bool (*) (void *, char const *, char const *)")
 @Nullable SDL_StorageInterfaceCopyCallbackI value)

Sets the specified value to the copy field.

space_remaining

public SDL_StorageInterface space_remaining(@NativeType("Uint64 (*) (void *)")
 @Nullable SDL_StorageInterfaceSpaceRemainingCallbackI value)

Sets the specified value to the space_remaining field.

set

public SDL_StorageInterface set(int version,
 SDL_StorageInterfaceCloseCallbackI close$,
 SDL_StorageInterfaceReadyCallbackI ready,
 SDL_StorageInterfaceEnumerateCallbackI enumerate,
 SDL_StorageInterfaceInfoCallbackI info,
 SDL_StorageInterfaceReadFileCallbackI read_file,
 SDL_StorageInterfaceWriteFileCallbackI write_file,
 SDL_StorageInterfaceMkdirCallbackI mkdir,
 SDL_StorageInterfaceRemoveCallbackI remove,
 SDL_StorageInterfaceRenameCallbackI rename,
 SDL_StorageInterfaceCopyCallbackI copy,
 SDL_StorageInterfaceSpaceRemainingCallbackI space_remaining)

Initializes this struct with the specified values.

set

public SDL_StorageInterface set(SDL_StorageInterface src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_StorageInterface malloc()

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

calloc

public static SDL_StorageInterface calloc()

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

create

public static SDL_StorageInterface create()

Returns a new SDL_StorageInterface instance allocated with BufferUtils.

create

public static SDL_StorageInterface create(long address)

Returns a new SDL_StorageInterface instance for the specified memory address.

createSafe

public static @Nullable SDL_StorageInterface createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_StorageInterface.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static SDL_StorageInterface.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static SDL_StorageInterface.Buffer create(int capacity)

Returns a new SDL_StorageInterface.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a SDL_StorageInterface.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static SDL_StorageInterface malloc(MemoryStack stack)

Returns a new SDL_StorageInterface instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_StorageInterface calloc(MemoryStack stack)

Returns a new SDL_StorageInterface 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_StorageInterface.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new SDL_StorageInterface.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().

nclose$

public static @Nullable SDL_StorageInterfaceCloseCallback nclose$(long struct)

Unsafe version of close$().

nready

public static @Nullable SDL_StorageInterfaceReadyCallback nready(long struct)

Unsafe version of ready().

nenumerate

public static @Nullable SDL_StorageInterfaceEnumerateCallback nenumerate(long struct)

Unsafe version of enumerate().

ninfo

public static @Nullable SDL_StorageInterfaceInfoCallback ninfo(long struct)

Unsafe version of info().

nread_file

public static @Nullable SDL_StorageInterfaceReadFileCallback nread_file(long struct)

Unsafe version of read_file().

nwrite_file

public static @Nullable SDL_StorageInterfaceWriteFileCallback nwrite_file(long struct)

Unsafe version of write_file().

nmkdir

public static @Nullable SDL_StorageInterfaceMkdirCallback nmkdir(long struct)

Unsafe version of mkdir().

nremove

public static @Nullable SDL_StorageInterfaceRemoveCallback nremove(long struct)

Unsafe version of remove().

nrename

public static @Nullable SDL_StorageInterfaceRenameCallback nrename(long struct)

Unsafe version of rename().

ncopy

public static @Nullable SDL_StorageInterfaceCopyCallback ncopy(long struct)

Unsafe version of copy().

nspace_remaining

public static @Nullable SDL_StorageInterfaceSpaceRemainingCallback nspace_remaining(long struct)

Unsafe version of space_remaining().

nversion

public static void nversion(long struct,
 int value)

Unsafe version of version.

nclose$

public static void nclose$(long struct,
 @Nullable SDL_StorageInterfaceCloseCallbackI value)

Unsafe version of close$.

nready

public static void nready(long struct,
 @Nullable SDL_StorageInterfaceReadyCallbackI value)

Unsafe version of ready.

nenumerate

public static void nenumerate(long struct,
 @Nullable SDL_StorageInterfaceEnumerateCallbackI value)

Unsafe version of enumerate.

ninfo

public static void ninfo(long struct,
 @Nullable SDL_StorageInterfaceInfoCallbackI value)

Unsafe version of info.

nread_file

public static void nread_file(long struct,
 @Nullable SDL_StorageInterfaceReadFileCallbackI value)

Unsafe version of read_file.

nwrite_file

public static void nwrite_file(long struct,
 @Nullable SDL_StorageInterfaceWriteFileCallbackI value)

Unsafe version of write_file.

nmkdir

public static void nmkdir(long struct,
 @Nullable SDL_StorageInterfaceMkdirCallbackI value)

Unsafe version of mkdir.

nremove

public static void nremove(long struct,
 @Nullable SDL_StorageInterfaceRemoveCallbackI value)

Unsafe version of remove.

nrename

public static void nrename(long struct,
 @Nullable SDL_StorageInterfaceRenameCallbackI value)

Unsafe version of rename.

ncopy

public static void ncopy(long struct,
 @Nullable SDL_StorageInterfaceCopyCallbackI value)

Unsafe version of copy.

nspace_remaining

public static void nspace_remaining(long struct,
 @Nullable SDL_StorageInterfaceSpaceRemainingCallbackI value)

Unsafe version of space_remaining.