Package org.lwjgl.fmod

Class FMOD_STUDIO_BANK_INFO

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_STUDIO_BANK_INFO>

org.lwjgl.fmod.FMOD_STUDIO_BANK_INFO

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_STUDIO_BANK_INFO
extends Struct<FMOD_STUDIO_BANK_INFO>
implements NativeResource

 struct FMOD_STUDIO_BANK_INFO {
     int size;
     void * userdata;
     int userdatalength;
     {@link FMOD_FILE_OPEN_CALLBACKI FMOD_FILE_OPEN_CALLBACK} opencallback;
     {@link FMOD_FILE_CLOSE_CALLBACKI FMOD_FILE_CLOSE_CALLBACK} closecallback;
     {@link FMOD_FILE_READ_CALLBACKI FMOD_FILE_READ_CALLBACK} readcallback;
     {@link FMOD_FILE_SEEK_CALLBACKI FMOD_FILE_SEEK_CALLBACK} seekcallback;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FMOD_STUDIO_BANK_INFO.Buffer	An array of FMOD_STUDIO_BANK_INFO 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	CLOSECALLBACK	The struct member offsets.
static final int	OPENCALLBACK	The struct member offsets.
static final int	READCALLBACK	The struct member offsets.
static final int	SEEKCALLBACK	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	USERDATA	The struct member offsets.
static final int	USERDATALENGTH	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
FMOD_STUDIO_BANK_INFO(ByteBuffer container)	Creates a FMOD_STUDIO_BANK_INFO instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static FMOD_STUDIO_BANK_INFO	calloc()	Returns a new FMOD_STUDIO_BANK_INFO instance allocated with memCalloc.
static FMOD_STUDIO_BANK_INFO.Buffer	calloc(int capacity)	Returns a new FMOD_STUDIO_BANK_INFO.Buffer instance allocated with memCalloc.
static FMOD_STUDIO_BANK_INFO.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new FMOD_STUDIO_BANK_INFO.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_STUDIO_BANK_INFO	calloc(MemoryStack stack)	Returns a new FMOD_STUDIO_BANK_INFO instance allocated on the specified MemoryStack and initializes all its bits to zero.
FMOD_FILE_CLOSE_CALLBACK	closecallback()
FMOD_STUDIO_BANK_INFO	closecallback(FMOD_FILE_CLOSE_CALLBACKI value)	Sets the specified value to the closecallback field.
static FMOD_STUDIO_BANK_INFO	create()	Returns a new FMOD_STUDIO_BANK_INFO instance allocated with BufferUtils.
static FMOD_STUDIO_BANK_INFO.Buffer	create(int capacity)	Returns a new FMOD_STUDIO_BANK_INFO.Buffer instance allocated with BufferUtils.
static FMOD_STUDIO_BANK_INFO	create(long address)	Returns a new FMOD_STUDIO_BANK_INFO instance for the specified memory address.
static FMOD_STUDIO_BANK_INFO.Buffer	create(long address, int capacity)	Create a FMOD_STUDIO_BANK_INFO.Buffer instance at the specified memory.
static @Nullable FMOD_STUDIO_BANK_INFO	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_STUDIO_BANK_INFO.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static FMOD_STUDIO_BANK_INFO	malloc()	Returns a new FMOD_STUDIO_BANK_INFO instance allocated with memAlloc.
static FMOD_STUDIO_BANK_INFO.Buffer	malloc(int capacity)	Returns a new FMOD_STUDIO_BANK_INFO.Buffer instance allocated with memAlloc.
static FMOD_STUDIO_BANK_INFO.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new FMOD_STUDIO_BANK_INFO.Buffer instance allocated on the specified MemoryStack.
static FMOD_STUDIO_BANK_INFO	malloc(MemoryStack stack)	Returns a new FMOD_STUDIO_BANK_INFO instance allocated on the specified MemoryStack.
static FMOD_FILE_CLOSE_CALLBACK	nclosecallback(long struct)	Unsafe version of closecallback().
static void	nclosecallback(long struct, FMOD_FILE_CLOSE_CALLBACKI value)	Unsafe version of closecallback.
static FMOD_FILE_OPEN_CALLBACK	nopencallback(long struct)	Unsafe version of opencallback().
static void	nopencallback(long struct, FMOD_FILE_OPEN_CALLBACKI value)	Unsafe version of opencallback.
static FMOD_FILE_READ_CALLBACK	nreadcallback(long struct)	Unsafe version of readcallback().
static void	nreadcallback(long struct, FMOD_FILE_READ_CALLBACKI value)	Unsafe version of readcallback.
static FMOD_FILE_SEEK_CALLBACK	nseekcallback(long struct)	Unsafe version of seekcallback().
static void	nseekcallback(long struct, FMOD_FILE_SEEK_CALLBACKI value)	Unsafe version of seekcallback.
static int	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, int value)	Unsafe version of size.
static @Nullable ByteBuffer	nuserdata(long struct)	Unsafe version of userdata.
static void	nuserdata(long struct, @Nullable ByteBuffer value)	Unsafe version of userdata.
static int	nuserdatalength(long struct)	Unsafe version of userdatalength().
static void	nuserdatalength(long struct, int value)	Sets the specified value to the userdatalength field of the specified struct.
FMOD_FILE_OPEN_CALLBACK	opencallback()
FMOD_STUDIO_BANK_INFO	opencallback(FMOD_FILE_OPEN_CALLBACKI value)	Sets the specified value to the opencallback field.
FMOD_FILE_READ_CALLBACK	readcallback()
FMOD_STUDIO_BANK_INFO	readcallback(FMOD_FILE_READ_CALLBACKI value)	Sets the specified value to the readcallback field.
FMOD_FILE_SEEK_CALLBACK	seekcallback()
FMOD_STUDIO_BANK_INFO	seekcallback(FMOD_FILE_SEEK_CALLBACKI value)	Sets the specified value to the seekcallback field.
FMOD_STUDIO_BANK_INFO	set(int size, @Nullable ByteBuffer userdata, int userdatalength, FMOD_FILE_OPEN_CALLBACKI opencallback, FMOD_FILE_CLOSE_CALLBACKI closecallback, FMOD_FILE_READ_CALLBACKI readcallback, FMOD_FILE_SEEK_CALLBACKI seekcallback)	Initializes this struct with the specified values.
FMOD_STUDIO_BANK_INFO	set(FMOD_STUDIO_BANK_INFO src)	Copies the specified struct data to this struct.
int	size()
FMOD_STUDIO_BANK_INFO	size(int value)	Sets the specified value to the size field.
int	sizeof()	Returns sizeof(struct).
@Nullable ByteBuffer	userdata()
FMOD_STUDIO_BANK_INFO	userdata(@Nullable ByteBuffer value)	Sets the address of the specified ByteBuffer to the userdata field.
int	userdatalength()
FMOD_STUDIO_BANK_INFO	userdatalength(int value)	Sets the specified value to the userdatalength 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, 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.

SIZE

public static final int SIZE

The struct member offsets.

USERDATA

public static final int USERDATA

The struct member offsets.

USERDATALENGTH

public static final int USERDATALENGTH

The struct member offsets.

OPENCALLBACK

public static final int OPENCALLBACK

The struct member offsets.

CLOSECALLBACK

public static final int CLOSECALLBACK

The struct member offsets.

READCALLBACK

public static final int READCALLBACK

The struct member offsets.

SEEKCALLBACK

public static final int SEEKCALLBACK

The struct member offsets.

Constructor Details

FMOD_STUDIO_BANK_INFO

public FMOD_STUDIO_BANK_INFO(ByteBuffer container)

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

size

public int size()

Returns:

the value of the size field.

userdata

public @Nullable ByteBuffer userdata()

Returns:

a ByteBuffer view of the data pointed to by the userdata field.

userdatalength

public int userdatalength()

Returns:

the value of the userdatalength field.

opencallback

public FMOD_FILE_OPEN_CALLBACK opencallback()

Returns:

the value of the opencallback field.

closecallback

public FMOD_FILE_CLOSE_CALLBACK closecallback()

Returns:

the value of the closecallback field.

readcallback

public FMOD_FILE_READ_CALLBACK readcallback()

Returns:

the value of the readcallback field.

seekcallback

public FMOD_FILE_SEEK_CALLBACK seekcallback()

Returns:

the value of the seekcallback field.

size

public FMOD_STUDIO_BANK_INFO size(int value)

Sets the specified value to the size field.

userdata

public FMOD_STUDIO_BANK_INFO userdata(@Nullable ByteBuffer value)

Sets the address of the specified ByteBuffer to the userdata field.

userdatalength

public FMOD_STUDIO_BANK_INFO userdatalength(int value)

Sets the specified value to the userdatalength field.

opencallback

public FMOD_STUDIO_BANK_INFO opencallback(FMOD_FILE_OPEN_CALLBACKI value)

Sets the specified value to the opencallback field.

closecallback

public FMOD_STUDIO_BANK_INFO closecallback(FMOD_FILE_CLOSE_CALLBACKI value)

Sets the specified value to the closecallback field.

readcallback

public FMOD_STUDIO_BANK_INFO readcallback(FMOD_FILE_READ_CALLBACKI value)

Sets the specified value to the readcallback field.

seekcallback

public FMOD_STUDIO_BANK_INFO seekcallback(FMOD_FILE_SEEK_CALLBACKI value)

Sets the specified value to the seekcallback field.

set

public FMOD_STUDIO_BANK_INFO set(int size,
 @Nullable ByteBuffer userdata,
 int userdatalength,
 FMOD_FILE_OPEN_CALLBACKI opencallback,
 FMOD_FILE_CLOSE_CALLBACKI closecallback,
 FMOD_FILE_READ_CALLBACKI readcallback,
 FMOD_FILE_SEEK_CALLBACKI seekcallback)

Initializes this struct with the specified values.

set

public FMOD_STUDIO_BANK_INFO set(FMOD_STUDIO_BANK_INFO src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_STUDIO_BANK_INFO malloc()

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

calloc

public static FMOD_STUDIO_BANK_INFO calloc()

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

create

public static FMOD_STUDIO_BANK_INFO create()

Returns a new FMOD_STUDIO_BANK_INFO instance allocated with BufferUtils.

create

public static FMOD_STUDIO_BANK_INFO create(long address)

Returns a new FMOD_STUDIO_BANK_INFO instance for the specified memory address.

createSafe

public static @Nullable FMOD_STUDIO_BANK_INFO createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static FMOD_STUDIO_BANK_INFO.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static FMOD_STUDIO_BANK_INFO.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static FMOD_STUDIO_BANK_INFO.Buffer create(int capacity)

Returns a new FMOD_STUDIO_BANK_INFO.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a FMOD_STUDIO_BANK_INFO.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static FMOD_STUDIO_BANK_INFO malloc(MemoryStack stack)

Returns a new FMOD_STUDIO_BANK_INFO instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static FMOD_STUDIO_BANK_INFO calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsize

public static int nsize(long struct)

Unsafe version of size().

nuserdata

public static @Nullable ByteBuffer nuserdata(long struct)

Unsafe version of userdata.

nuserdatalength

public static int nuserdatalength(long struct)

Unsafe version of userdatalength().

nopencallback

public static FMOD_FILE_OPEN_CALLBACK nopencallback(long struct)

Unsafe version of opencallback().

nclosecallback

public static FMOD_FILE_CLOSE_CALLBACK nclosecallback(long struct)

Unsafe version of closecallback().

nreadcallback

public static FMOD_FILE_READ_CALLBACK nreadcallback(long struct)

Unsafe version of readcallback().

nseekcallback

public static FMOD_FILE_SEEK_CALLBACK nseekcallback(long struct)

Unsafe version of seekcallback().

nsize

public static void nsize(long struct,
 int value)

Unsafe version of size.

nuserdata

public static void nuserdata(long struct,
 @Nullable ByteBuffer value)

Unsafe version of userdata.

nuserdatalength

public static void nuserdatalength(long struct,
 int value)

Sets the specified value to the userdatalength field of the specified struct.

nopencallback

public static void nopencallback(long struct,
 FMOD_FILE_OPEN_CALLBACKI value)

Unsafe version of opencallback.

nclosecallback

public static void nclosecallback(long struct,
 FMOD_FILE_CLOSE_CALLBACKI value)

Unsafe version of closecallback.

nreadcallback

public static void nreadcallback(long struct,
 FMOD_FILE_READ_CALLBACKI value)

Unsafe version of readcallback.

nseekcallback

public static void nseekcallback(long struct,
 FMOD_FILE_SEEK_CALLBACKI value)

Unsafe version of seekcallback.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate