Top Description Inners Fields Constructors Methods
org.lwjgl.fmod

public Class FMOD_STUDIO_BUFFER_USAGE

extends Struct<FMOD_STUDIO_BUFFER_USAGE>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct FMOD_STUDIO_BUFFER_USAGE {
    FMOD_STUDIO_BUFFER_INFO studiocommandqueue;
    FMOD_STUDIO_BUFFER_INFO studiohandle;
}

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
SIZEOF

The struct size in bytes.

public static final int
STUDIOCOMMANDQUEUE

The struct member offsets.

public static final int
STUDIOHANDLE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FMOD_STUDIO_BUFFER_USAGE(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static FMOD_STUDIO_BUFFER_USAGE
calloc()

Returns a new FMOD_STUDIO_BUFFER_USAGE instance allocated with memCalloc.

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

Returns a new FMOD_STUDIO_BUFFER_USAGE.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new FMOD_STUDIO_BUFFER_USAGE instance allocated with BufferUtils.

public static FMOD_STUDIO_BUFFER_USAGE
create(long address)

Returns a new FMOD_STUDIO_BUFFER_USAGE instance for the specified memory address.

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

Returns a new FMOD_STUDIO_BUFFER_USAGE.Buffer instance allocated with BufferUtils.

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

Create a FMOD_STUDIO_BUFFER_USAGE.Buffer instance at the specified memory.

public static FMOD_STUDIO_BUFFER_USAGE
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static FMOD_STUDIO_BUFFER_USAGE
malloc()

Returns a new FMOD_STUDIO_BUFFER_USAGE instance allocated with memAlloc.

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

Returns a new FMOD_STUDIO_BUFFER_USAGE.Buffer instance allocated with memAlloc.

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

Returns a new FMOD_STUDIO_BUFFER_USAGE instance allocated on the specified MemoryStack.

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

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

public static FMOD_STUDIO_BUFFER_INFO
nstudiocommandqueue(long struct)

Unsafe version of studiocommandqueue.

public static void
nstudiocommandqueue(long struct, FMOD_STUDIO_BUFFER_INFO value)

Unsafe version of studiocommandqueue.

public static FMOD_STUDIO_BUFFER_INFO
nstudiohandle(long struct)

Unsafe version of studiohandle.

public static void
nstudiohandle(long struct, FMOD_STUDIO_BUFFER_INFO value)

Unsafe version of studiohandle.

public FMOD_STUDIO_BUFFER_USAGE
set(FMOD_STUDIO_BUFFER_INFO studiocommandqueue, FMOD_STUDIO_BUFFER_INFO studiohandle)

Initializes this struct with the specified values.

public FMOD_STUDIO_BUFFER_USAGE

Returns:

this struct
set
(FMOD_STUDIO_BUFFER_USAGE
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 FMOD_STUDIO_BUFFER_INFO

Returns:

a FMOD_STUDIO_BUFFER_INFO view of the studiocommandqueue field.
studiocommandqueue
()

public FMOD_STUDIO_BUFFER_USAGE
studiocommandqueue(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiocommandqueue field.

public FMOD_STUDIO_BUFFER_USAGE
studiocommandqueue(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiocommandqueue field to the specified Consumer.

public FMOD_STUDIO_BUFFER_INFO

Returns:

a FMOD_STUDIO_BUFFER_INFO view of the studiohandle field.
studiohandle
()

public FMOD_STUDIO_BUFFER_USAGE
studiohandle(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiohandle field.

public FMOD_STUDIO_BUFFER_USAGE
studiohandle(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiohandle field to the specified Consumer.

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.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STUDIOCOMMANDQUEUEback to summary
public static final int STUDIOCOMMANDQUEUE

The struct member offsets.

STUDIOHANDLEback to summary
public static final int STUDIOHANDLE

The struct member offsets.

Constructor Detail

FMOD_STUDIO_BUFFER_USAGEback to summary
protected FMOD_STUDIO_BUFFER_USAGE(long address, ByteBuffer container)
FMOD_STUDIO_BUFFER_USAGEback to summary
public FMOD_STUDIO_BUFFER_USAGE(ByteBuffer container)

Creates a FMOD_STUDIO_BUFFER_USAGE 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 FMOD_STUDIO_BUFFER_USAGE calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FMOD_STUDIO_BUFFER_USAGE calloc(MemoryStack stack)

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

Returns a new FMOD_STUDIO_BUFFER_USAGE.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_STUDIO_BUFFER_USAGE 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_STUDIO_BUFFER_USAGE create()

Returns a new FMOD_STUDIO_BUFFER_USAGE instance allocated with BufferUtils.

createback to summary
public static FMOD_STUDIO_BUFFER_USAGE create(long address)

Returns a new FMOD_STUDIO_BUFFER_USAGE instance for the specified memory address.

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

Returns a new FMOD_STUDIO_BUFFER_USAGE.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FMOD_STUDIO_BUFFER_USAGE.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FMOD_STUDIO_BUFFER_USAGE createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static FMOD_STUDIO_BUFFER_USAGE malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FMOD_STUDIO_BUFFER_USAGE malloc(MemoryStack stack)

Returns a new FMOD_STUDIO_BUFFER_USAGE instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nstudiocommandqueueback to summary
public static FMOD_STUDIO_BUFFER_INFO nstudiocommandqueue(long struct)

Unsafe version of studiocommandqueue.

nstudiocommandqueueback to summary
public static void nstudiocommandqueue(long struct, FMOD_STUDIO_BUFFER_INFO value)

Unsafe version of studiocommandqueue.

nstudiohandleback to summary
public static FMOD_STUDIO_BUFFER_INFO nstudiohandle(long struct)

Unsafe version of studiohandle.

nstudiohandleback to summary
public static void nstudiohandle(long struct, FMOD_STUDIO_BUFFER_INFO value)

Unsafe version of studiohandle.

setback to summary
public FMOD_STUDIO_BUFFER_USAGE set(FMOD_STUDIO_BUFFER_INFO studiocommandqueue, FMOD_STUDIO_BUFFER_INFO studiohandle)

Initializes this struct with the specified values.

setback to summary
public FMOD_STUDIO_BUFFER_USAGE set(FMOD_STUDIO_BUFFER_USAGE src)

Copies the specified struct data to this struct.

Parameters
src:FMOD_STUDIO_BUFFER_USAGE

the source struct

Returns:FMOD_STUDIO_BUFFER_USAGE

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
studiocommandqueueback to summary
public FMOD_STUDIO_BUFFER_INFO studiocommandqueue()
Returns:FMOD_STUDIO_BUFFER_INFO

a FMOD_STUDIO_BUFFER_INFO view of the studiocommandqueue field.

studiocommandqueueback to summary
public FMOD_STUDIO_BUFFER_USAGE studiocommandqueue(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiocommandqueue field.

studiocommandqueueback to summary
public FMOD_STUDIO_BUFFER_USAGE studiocommandqueue(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiocommandqueue field to the specified Consumer.

studiohandleback to summary
public FMOD_STUDIO_BUFFER_INFO studiohandle()
Returns:FMOD_STUDIO_BUFFER_INFO

a FMOD_STUDIO_BUFFER_INFO view of the studiohandle field.

studiohandleback to summary
public FMOD_STUDIO_BUFFER_USAGE studiohandle(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiohandle field.

studiohandleback to summary
public FMOD_STUDIO_BUFFER_USAGE studiohandle(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiohandle field to the specified Consumer.

org.lwjgl.fmod back to summary

public Class FMOD_STUDIO_BUFFER_USAGE.Buffer

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

An array of FMOD_STUDIO_BUFFER_USAGE structs.

Field Summary

Modifier and TypeField and Description
private static final FMOD_STUDIO_BUFFER_USAGE

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FMOD_STUDIO_BUFFER_USAGE.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
protected FMOD_STUDIO_BUFFER_USAGE
protected FMOD_STUDIO_BUFFER_USAGE.Buffer
public FMOD_STUDIO_BUFFER_INFO

Returns:

a FMOD_STUDIO_BUFFER_INFO view of the studiocommandqueue field.
studiocommandqueue
()

public FMOD_STUDIO_BUFFER_USAGE.Buffer
studiocommandqueue(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiocommandqueue field.

public FMOD_STUDIO_BUFFER_USAGE.Buffer
studiocommandqueue(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiocommandqueue field to the specified Consumer.

public FMOD_STUDIO_BUFFER_INFO

Returns:

a FMOD_STUDIO_BUFFER_INFO view of the studiohandle field.
studiohandle
()

public FMOD_STUDIO_BUFFER_USAGE.Buffer
studiohandle(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiohandle field.

public FMOD_STUDIO_BUFFER_USAGE.Buffer
studiohandle(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiohandle field to the specified Consumer.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FMOD_STUDIO_BUFFER_USAGE ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected FMOD_STUDIO_BUFFER_USAGE getElementFactory()

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

Annotations
@Override
selfback to summary
protected FMOD_STUDIO_BUFFER_USAGE.Buffer self()

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

Annotations
@Override
studiocommandqueueback to summary
public FMOD_STUDIO_BUFFER_INFO studiocommandqueue()
Returns:FMOD_STUDIO_BUFFER_INFO

a FMOD_STUDIO_BUFFER_INFO view of the studiocommandqueue field.

studiocommandqueueback to summary
public FMOD_STUDIO_BUFFER_USAGE.Buffer studiocommandqueue(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiocommandqueue field.

studiocommandqueueback to summary
public FMOD_STUDIO_BUFFER_USAGE.Buffer studiocommandqueue(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiocommandqueue field to the specified Consumer.

studiohandleback to summary
public FMOD_STUDIO_BUFFER_INFO studiohandle()
Returns:FMOD_STUDIO_BUFFER_INFO

a FMOD_STUDIO_BUFFER_INFO view of the studiohandle field.

studiohandleback to summary
public FMOD_STUDIO_BUFFER_USAGE.Buffer studiohandle(FMOD_STUDIO_BUFFER_INFO value)

Copies the specified FMOD_STUDIO_BUFFER_INFO to the studiohandle field.

studiohandleback to summary
public FMOD_STUDIO_BUFFER_USAGE.Buffer studiohandle(Consumer<FMOD_STUDIO_BUFFER_INFO> consumer)

Passes the studiohandle field to the specified Consumer.