Package org.lwjgl.ovr

Class OVRAudioChannelData

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<OVRAudioChannelData>

org.lwjgl.ovr.OVRAudioChannelData

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class OVRAudioChannelData
extends Struct<OVRAudioChannelData>
implements NativeResource

Store audio PCM data (as 32b float samples) for an audio channel.

Note: needs to be released with _ReleaseAudioChannelData to avoid memory leak.

Layout

 struct ovrAudioChannelData {
     float const * Samples();
     int SamplesCount();
     int Frequency();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OVRAudioChannelData.Buffer	An array of OVRAudioChannelData 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	FREQUENCY	The struct member offsets.
static final int	SAMPLES	The struct member offsets.
static final int	SAMPLESCOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OVRAudioChannelData	calloc()	Returns a new OVRAudioChannelData instance allocated with memCalloc.
static OVRAudioChannelData.Buffer	calloc(int capacity)	Returns a new OVRAudioChannelData.Buffer instance allocated with memCalloc.
static OVRAudioChannelData.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new OVRAudioChannelData.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static OVRAudioChannelData	calloc(MemoryStack stack)	Returns a new OVRAudioChannelData instance allocated on the specified MemoryStack and initializes all its bits to zero.
static OVRAudioChannelData	callocStack()	Deprecated.
static OVRAudioChannelData.Buffer	callocStack(int capacity)	Deprecated.
static OVRAudioChannelData.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static OVRAudioChannelData	callocStack(MemoryStack stack)	Deprecated.
static OVRAudioChannelData	create()	Returns a new OVRAudioChannelData instance allocated with BufferUtils.
static OVRAudioChannelData.Buffer	create(int capacity)	Returns a new OVRAudioChannelData.Buffer instance allocated with BufferUtils.
static OVRAudioChannelData	create(long address)	Returns a new OVRAudioChannelData instance for the specified memory address.
static OVRAudioChannelData.Buffer	create(long address, int capacity)	Create a OVRAudioChannelData.Buffer instance at the specified memory.
static OVRAudioChannelData	createSafe(long address)	Like create, but returns null if address is NULL.
static OVRAudioChannelData.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	Frequency()	frequency (e.g.
static OVRAudioChannelData	malloc()	Returns a new OVRAudioChannelData instance allocated with memAlloc.
static OVRAudioChannelData.Buffer	malloc(int capacity)	Returns a new OVRAudioChannelData.Buffer instance allocated with memAlloc.
static OVRAudioChannelData.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new OVRAudioChannelData.Buffer instance allocated on the specified MemoryStack.
static OVRAudioChannelData	malloc(MemoryStack stack)	Returns a new OVRAudioChannelData instance allocated on the specified MemoryStack.
static OVRAudioChannelData	mallocStack()	Deprecated.
static OVRAudioChannelData.Buffer	mallocStack(int capacity)	Deprecated.
static OVRAudioChannelData.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static OVRAudioChannelData	mallocStack(MemoryStack stack)	Deprecated.
static int	nFrequency(long struct)	Unsafe version of Frequency().
static FloatBuffer	nSamples(long struct)	Unsafe version of Samples.
static int	nSamplesCount(long struct)	Unsafe version of SamplesCount().
FloatBuffer	Samples()	samples stored as floats [-1.0f, 1.0f]
int	SamplesCount()	number of samples
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

SAMPLES

public static final int SAMPLES

The struct member offsets.

SAMPLESCOUNT

public static final int SAMPLESCOUNT

The struct member offsets.

FREQUENCY

public static final int FREQUENCY

The struct member offsets.

Constructor Details

OVRAudioChannelData

public OVRAudioChannelData(ByteBuffer container)

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

Samples

public FloatBuffer Samples()

samples stored as floats [-1.0f, 1.0f]

SamplesCount

public int SamplesCount()

number of samples

Frequency

public int Frequency()

frequency (e.g. 44100)

malloc

public static OVRAudioChannelData malloc()

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

calloc

public static OVRAudioChannelData calloc()

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

create

public static OVRAudioChannelData create()

Returns a new OVRAudioChannelData instance allocated with BufferUtils.

create

public static OVRAudioChannelData create(long address)

Returns a new OVRAudioChannelData instance for the specified memory address.

createSafe

@Nullable
public static OVRAudioChannelData createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static OVRAudioChannelData.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static OVRAudioChannelData.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static OVRAudioChannelData.Buffer create(int capacity)

Returns a new OVRAudioChannelData.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a OVRAudioChannelData.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static OVRAudioChannelData mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static OVRAudioChannelData callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static OVRAudioChannelData mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static OVRAudioChannelData callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static OVRAudioChannelData.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static OVRAudioChannelData.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static OVRAudioChannelData.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static OVRAudioChannelData.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static OVRAudioChannelData malloc(MemoryStack stack)

Returns a new OVRAudioChannelData instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static OVRAudioChannelData calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nSamples

public static FloatBuffer nSamples(long struct)

Unsafe version of Samples.

nSamplesCount

public static int nSamplesCount(long struct)

Unsafe version of SamplesCount().

nFrequency

public static int nFrequency(long struct)

Unsafe version of Frequency().