Top Description Inners Fields Constructors Methods
org.lwjgl.fmod

public Class FMOD_ASYNCREADINFO

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

FMOD structs

Layout


struct FMOD_ASYNCREADINFO {
    void * handle;
    unsigned int offset;
    unsigned int sizebytes;
    int priority;
    void * userdata;
    void * buffer;
    unsigned int bytesread;
    FMOD_FILE_ASYNCDONE_FUNC done;
}

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
BUFFER

The struct member offsets.

public static final int
BYTESREAD

The struct member offsets.

public static final int
DONE

The struct member offsets.

public static final int
HANDLE

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
PRIORITY

The struct member offsets.

public static final int
SIZEBYTES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
USERDATA

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FMOD_ASYNCREADINFO(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the buffer field.
buffer
()

public FMOD_ASYNCREADINFO
buffer(ByteBuffer value)

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

public int

Returns:

the value of the bytesread field.
bytesread
()

public static FMOD_ASYNCREADINFO
calloc()

Returns a new FMOD_ASYNCREADINFO instance allocated with memCalloc.

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

Returns a new FMOD_ASYNCREADINFO.Buffer instance allocated with memCalloc.

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

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

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

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

protected FMOD_ASYNCREADINFO
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 FMOD_ASYNCREADINFO
create()

Returns a new FMOD_ASYNCREADINFO instance allocated with BufferUtils.

public static FMOD_ASYNCREADINFO
create(long address)

Returns a new FMOD_ASYNCREADINFO instance for the specified memory address.

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

Returns a new FMOD_ASYNCREADINFO.Buffer instance allocated with BufferUtils.

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

Create a FMOD_ASYNCREADINFO.Buffer instance at the specified memory.

public static FMOD_ASYNCREADINFO
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public FMOD_FILE_ASYNCDONE_FUNC

Returns:

the value of the done field.
done
()

public FMOD_ASYNCREADINFO
done(FMOD_FILE_ASYNCDONE_FUNCI value)

Sets the specified value to the done field.

public long

Returns:

the value of the handle field.
handle
()

public FMOD_ASYNCREADINFO
handle(long value)

Sets the specified value to the handle field.

public static FMOD_ASYNCREADINFO
malloc()

Returns a new FMOD_ASYNCREADINFO instance allocated with memAlloc.

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

Returns a new FMOD_ASYNCREADINFO.Buffer instance allocated with memAlloc.

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

Returns a new FMOD_ASYNCREADINFO instance allocated on the specified MemoryStack.

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

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

public static ByteBuffer
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, ByteBuffer value)

Unsafe version of buffer.

public static int
nbytesread(long struct)

Unsafe version of bytesread.

public static void
nbytesread(long struct, int value)

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

public static FMOD_FILE_ASYNCDONE_FUNC
ndone(long struct)

Unsafe version of done.

public static void
ndone(long struct, FMOD_FILE_ASYNCDONE_FUNCI value)

Unsafe version of done.

public static long
nhandle(long struct)

Unsafe version of handle.

public static void
nhandle(long struct, long value)

Unsafe version of handle.

public static int
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, int value)

Unsafe version of offset.

public static int
npriority(long struct)

Unsafe version of priority.

public static void
npriority(long struct, int value)

Unsafe version of priority.

public static int
nsizebytes(long struct)

Unsafe version of sizebytes.

public static void
nsizebytes(long struct, int value)

Unsafe version of sizebytes.

public static long
nuserdata(long struct)

Unsafe version of userdata.

public static void
nuserdata(long struct, long value)

Unsafe version of userdata.

public int

Returns:

the value of the offset field.
offset
()

public FMOD_ASYNCREADINFO
offset(int value)

Sets the specified value to the offset field.

public int

Returns:

the value of the priority field.
priority
()

public FMOD_ASYNCREADINFO
priority(int value)

Sets the specified value to the priority field.

public FMOD_ASYNCREADINFO
set(long handle, int offset, int sizebytes, int priority, long userdata, ByteBuffer buffer, FMOD_FILE_ASYNCDONE_FUNCI done)

Initializes this struct with the specified values.

public FMOD_ASYNCREADINFO

Returns:

this struct
set
(FMOD_ASYNCREADINFO
the source struct
src
)

Copies the specified struct data to this struct.

public int

Returns:

the value of the sizebytes field.
sizebytes
()

public FMOD_ASYNCREADINFO
sizebytes(int value)

Sets the specified value to the sizebytes field.

public int
sizeof()

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

Returns sizeof(struct).
public long

Returns:

the value of the userdata field.
userdata
()

public FMOD_ASYNCREADINFO
userdata(long value)

Sets the specified value to the userdata 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.

BUFFERback to summary
public static final int BUFFER

The struct member offsets.

BYTESREADback to summary
public static final int BYTESREAD

The struct member offsets.

DONEback to summary
public static final int DONE

The struct member offsets.

HANDLEback to summary
public static final int HANDLE

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

PRIORITYback to summary
public static final int PRIORITY

The struct member offsets.

SIZEBYTESback to summary
public static final int SIZEBYTES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

USERDATAback to summary
public static final int USERDATA

The struct member offsets.

Constructor Detail

FMOD_ASYNCREADINFOback to summary
protected FMOD_ASYNCREADINFO(long address, ByteBuffer container)
FMOD_ASYNCREADINFOback to summary
public FMOD_ASYNCREADINFO(ByteBuffer container)

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

bufferback to summary
public ByteBuffer buffer()
Returns:ByteBuffer

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

Annotations
@NativeType:void *
bufferback to summary
public FMOD_ASYNCREADINFO buffer(ByteBuffer value)

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

bytesreadback to summary
public int bytesread()
Returns:int

the value of the bytesread field.

Annotations
@NativeType:unsigned int
callocback to summary
public static FMOD_ASYNCREADINFO calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FMOD_ASYNCREADINFO calloc(MemoryStack stack)

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

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

createback to summary
protected FMOD_ASYNCREADINFO 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 FMOD_ASYNCREADINFO create()

Returns a new FMOD_ASYNCREADINFO instance allocated with BufferUtils.

createback to summary
public static FMOD_ASYNCREADINFO create(long address)

Returns a new FMOD_ASYNCREADINFO instance for the specified memory address.

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

Returns a new FMOD_ASYNCREADINFO.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FMOD_ASYNCREADINFO.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FMOD_ASYNCREADINFO createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
doneback to summary
public FMOD_FILE_ASYNCDONE_FUNC done()
Returns:FMOD_FILE_ASYNCDONE_FUNC

the value of the done field.

doneback to summary
public FMOD_ASYNCREADINFO done(FMOD_FILE_ASYNCDONE_FUNCI value)

Sets the specified value to the done field.

handleback to summary
public long handle()
Returns:long

the value of the handle field.

Annotations
@NativeType:void *
handleback to summary
public FMOD_ASYNCREADINFO handle(long value)

Sets the specified value to the handle field.

mallocback to summary
public static FMOD_ASYNCREADINFO malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FMOD_ASYNCREADINFO malloc(MemoryStack stack)

Returns a new FMOD_ASYNCREADINFO instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbufferback to summary
public static ByteBuffer nbuffer(long struct)

Unsafe version of buffer.

nbufferback to summary
public static void nbuffer(long struct, ByteBuffer value)

Unsafe version of buffer.

nbytesreadback to summary
public static int nbytesread(long struct)

Unsafe version of bytesread.

nbytesreadback to summary
public static void nbytesread(long struct, int value)

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

ndoneback to summary
public static FMOD_FILE_ASYNCDONE_FUNC ndone(long struct)

Unsafe version of done.

ndoneback to summary
public static void ndone(long struct, FMOD_FILE_ASYNCDONE_FUNCI value)

Unsafe version of done.

nhandleback to summary
public static long nhandle(long struct)

Unsafe version of handle.

nhandleback to summary
public static void nhandle(long struct, long value)

Unsafe version of handle.

noffsetback to summary
public static int noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, int value)

Unsafe version of offset.

npriorityback to summary
public static int npriority(long struct)

Unsafe version of priority.

npriorityback to summary
public static void npriority(long struct, int value)

Unsafe version of priority.

nsizebytesback to summary
public static int nsizebytes(long struct)

Unsafe version of sizebytes.

nsizebytesback to summary
public static void nsizebytes(long struct, int value)

Unsafe version of sizebytes.

nuserdataback to summary
public static long nuserdata(long struct)

Unsafe version of userdata.

nuserdataback to summary
public static void nuserdata(long struct, long value)

Unsafe version of userdata.

offsetback to summary
public int offset()
Returns:int

the value of the offset field.

Annotations
@NativeType:unsigned int
offsetback to summary
public FMOD_ASYNCREADINFO offset(int value)

Sets the specified value to the offset field.

priorityback to summary
public int priority()
Returns:int

the value of the priority field.

priorityback to summary
public FMOD_ASYNCREADINFO priority(int value)

Sets the specified value to the priority field.

setback to summary
public FMOD_ASYNCREADINFO set(long handle, int offset, int sizebytes, int priority, long userdata, ByteBuffer buffer, FMOD_FILE_ASYNCDONE_FUNCI done)

Initializes this struct with the specified values.

setback to summary
public FMOD_ASYNCREADINFO set(FMOD_ASYNCREADINFO src)

Copies the specified struct data to this struct.

Parameters
src:FMOD_ASYNCREADINFO

the source struct

Returns:FMOD_ASYNCREADINFO

this struct

sizebytesback to summary
public int sizebytes()
Returns:int

the value of the sizebytes field.

Annotations
@NativeType:unsigned int
sizebytesback to summary
public FMOD_ASYNCREADINFO sizebytes(int value)

Sets the specified value to the sizebytes field.

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
userdataback to summary
public long userdata()
Returns:long

the value of the userdata field.

Annotations
@NativeType:void *
userdataback to summary
public FMOD_ASYNCREADINFO userdata(long value)

Sets the specified value to the userdata 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.fmod back to summary

public Class FMOD_ASYNCREADINFO.Buffer

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

An array of FMOD_ASYNCREADINFO structs.

Field Summary

Modifier and TypeField and Description
private static final FMOD_ASYNCREADINFO

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FMOD_ASYNCREADINFO.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 ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the buffer field.
buffer
()

public FMOD_ASYNCREADINFO.Buffer
buffer(ByteBuffer value)

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

public int

Returns:

the value of the bytesread field.
bytesread
()

public FMOD_FILE_ASYNCDONE_FUNC

Returns:

the value of the done field.
done
()

public FMOD_ASYNCREADINFO.Buffer
done(FMOD_FILE_ASYNCDONE_FUNCI value)

Sets the specified value to the done field.

protected FMOD_ASYNCREADINFO
public long

Returns:

the value of the handle field.
handle
()

public FMOD_ASYNCREADINFO.Buffer
handle(long value)

Sets the specified value to the handle field.

public int

Returns:

the value of the offset field.
offset
()

public FMOD_ASYNCREADINFO.Buffer
offset(int value)

Sets the specified value to the offset field.

public int

Returns:

the value of the priority field.
priority
()

public FMOD_ASYNCREADINFO.Buffer
priority(int value)

Sets the specified value to the priority field.

protected FMOD_ASYNCREADINFO.Buffer
public int

Returns:

the value of the sizebytes field.
sizebytes
()

public FMOD_ASYNCREADINFO.Buffer
sizebytes(int value)

Sets the specified value to the sizebytes field.

public long

Returns:

the value of the userdata field.
userdata
()

public FMOD_ASYNCREADINFO.Buffer
userdata(long value)

Sets the specified value to the userdata field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FMOD_ASYNCREADINFO ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new FMOD_ASYNCREADINFO.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 FMOD_ASYNCREADINFO#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

bufferback to summary
public ByteBuffer buffer()
Returns:ByteBuffer

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

Annotations
@NativeType:void *
bufferback to summary
public FMOD_ASYNCREADINFO.Buffer buffer(ByteBuffer value)

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

bytesreadback to summary
public int bytesread()
Returns:int

the value of the bytesread field.

Annotations
@NativeType:unsigned int
doneback to summary
public FMOD_FILE_ASYNCDONE_FUNC done()
Returns:FMOD_FILE_ASYNCDONE_FUNC

the value of the done field.

doneback to summary
public FMOD_ASYNCREADINFO.Buffer done(FMOD_FILE_ASYNCDONE_FUNCI value)

Sets the specified value to the done field.

getElementFactoryback to summary
protected FMOD_ASYNCREADINFO getElementFactory()

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

Annotations
@Override
handleback to summary
public long handle()
Returns:long

the value of the handle field.

Annotations
@NativeType:void *
handleback to summary
public FMOD_ASYNCREADINFO.Buffer handle(long value)

Sets the specified value to the handle field.

offsetback to summary
public int offset()
Returns:int

the value of the offset field.

Annotations
@NativeType:unsigned int
offsetback to summary
public FMOD_ASYNCREADINFO.Buffer offset(int value)

Sets the specified value to the offset field.

priorityback to summary
public int priority()
Returns:int

the value of the priority field.

priorityback to summary
public FMOD_ASYNCREADINFO.Buffer priority(int value)

Sets the specified value to the priority field.

selfback to summary
protected FMOD_ASYNCREADINFO.Buffer self()

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

Annotations
@Override
sizebytesback to summary
public int sizebytes()
Returns:int

the value of the sizebytes field.

Annotations
@NativeType:unsigned int
sizebytesback to summary
public FMOD_ASYNCREADINFO.Buffer sizebytes(int value)

Sets the specified value to the sizebytes field.

userdataback to summary
public long userdata()
Returns:long

the value of the userdata field.

Annotations
@NativeType:void *
userdataback to summary
public FMOD_ASYNCREADINFO.Buffer userdata(long value)

Sets the specified value to the userdata field.