Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRHapticsBuffer

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

Haptics buffer descriptor, contains amplitude samples used for Touch vibration.

Layout


struct ovrHapticsBuffer {
    void * Samples;
    int SamplesCount;
    ovrHapticsBufferSubmitMode SubmitMode;
}

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
SAMPLES

The struct member offsets.

public static final int
SAMPLESCOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBMITMODE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
OVRHapticsBuffer(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRHapticsBuffer
calloc()

Returns a new OVRHapticsBuffer instance allocated with memCalloc.

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

Returns a new OVRHapticsBuffer.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRHapticsBuffer
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHapticsBuffer
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHapticsBuffer.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHapticsBuffer.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected OVRHapticsBuffer
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 OVRHapticsBuffer
create()

Returns a new OVRHapticsBuffer instance allocated with BufferUtils.

public static OVRHapticsBuffer
create(long address)

Returns a new OVRHapticsBuffer instance for the specified memory address.

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

Returns a new OVRHapticsBuffer.Buffer instance allocated with BufferUtils.

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

Create a OVRHapticsBuffer.Buffer instance at the specified memory.

public static OVRHapticsBuffer
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static OVRHapticsBuffer
malloc()

Returns a new OVRHapticsBuffer instance allocated with memAlloc.

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

Returns a new OVRHapticsBuffer.Buffer instance allocated with memAlloc.

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

Returns a new OVRHapticsBuffer instance allocated on the specified MemoryStack.

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

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

public static OVRHapticsBuffer
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHapticsBuffer
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHapticsBuffer.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHapticsBuffer.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
nSamples(long struct, int capacity)

Unsafe version of Samples.

public static void
nSamples(long struct, ByteBuffer value)

Unsafe version of Samples.

public static int
nSamplesCount(long struct)

Unsafe version of SamplesCount.

public static void
nSamplesCount(long struct, int value)

Unsafe version of SamplesCount.

public static int
nSubmitMode(long struct)

Unsafe version of SubmitMode.

public static void
nSubmitMode(long struct, int value)

Unsafe version of SubmitMode.

public ByteBuffer

Returns:

samples stored in opaque format
Samples
(int
the number of elements in the returned buffer
capacity
)

public OVRHapticsBuffer
Samples(ByteBuffer value)

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

public int
public OVRHapticsBuffer
SamplesCount(int value)

Sets the specified value to the SamplesCount field.

public OVRHapticsBuffer
set(ByteBuffer Samples, int SamplesCount, int SubmitMode)

Initializes this struct with the specified values.

public OVRHapticsBuffer

Returns:

this struct
set
(OVRHapticsBuffer
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 int
SubmitMode()

how samples are submitted to the hardware.

public OVRHapticsBuffer
SubmitMode(int value)

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

SAMPLESback to summary
public static final int SAMPLES

The struct member offsets.

SAMPLESCOUNTback to summary
public static final int SAMPLESCOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBMITMODEback to summary
public static final int SUBMITMODE

The struct member offsets.

Constructor Detail

OVRHapticsBufferback to summary
protected OVRHapticsBuffer(long address, ByteBuffer container)
OVRHapticsBufferback to summary
public OVRHapticsBuffer(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRHapticsBuffer calloc(MemoryStack stack)

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

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

callocStackback to summary
public static OVRHapticsBuffer callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static OVRHapticsBuffer callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static OVRHapticsBuffer.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static OVRHapticsBuffer.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected OVRHapticsBuffer 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 OVRHapticsBuffer create()

Returns a new OVRHapticsBuffer instance allocated with BufferUtils.

createback to summary
public static OVRHapticsBuffer create(long address)

Returns a new OVRHapticsBuffer instance for the specified memory address.

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

Returns a new OVRHapticsBuffer.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRHapticsBuffer.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRHapticsBuffer createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRHapticsBuffer malloc(MemoryStack stack)

Returns a new OVRHapticsBuffer instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static OVRHapticsBuffer mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static OVRHapticsBuffer mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static OVRHapticsBuffer.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static OVRHapticsBuffer.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nSamplesback to summary
public static ByteBuffer nSamples(long struct, int capacity)

Unsafe version of Samples.

nSamplesback to summary
public static void nSamples(long struct, ByteBuffer value)

Unsafe version of Samples.

nSamplesCountback to summary
public static int nSamplesCount(long struct)

Unsafe version of SamplesCount.

nSamplesCountback to summary
public static void nSamplesCount(long struct, int value)

Unsafe version of SamplesCount.

nSubmitModeback to summary
public static int nSubmitMode(long struct)

Unsafe version of SubmitMode.

nSubmitModeback to summary
public static void nSubmitMode(long struct, int value)

Unsafe version of SubmitMode.

Samplesback to summary
public ByteBuffer Samples(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

samples stored in opaque format

Annotations
@NativeType:void *
Samplesback to summary
public OVRHapticsBuffer Samples(ByteBuffer value)

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

SamplesCountback to summary
public int SamplesCount()

number of samples (up to OVR#OVR_HAPTICS_BUFFER_SAMPLES_MAX)

SamplesCountback to summary
public OVRHapticsBuffer SamplesCount(int value)

Sets the specified value to the SamplesCount field.

setback to summary
public OVRHapticsBuffer set(ByteBuffer Samples, int SamplesCount, int SubmitMode)

Initializes this struct with the specified values.

setback to summary
public OVRHapticsBuffer set(OVRHapticsBuffer src)

Copies the specified struct data to this struct.

Parameters
src:OVRHapticsBuffer

the source struct

Returns:OVRHapticsBuffer

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
SubmitModeback to summary
public int SubmitMode()

how samples are submitted to the hardware. Must be:

HapticsBufferSubmit_Enqueue
Annotations
@NativeType:ovrHapticsBufferSubmitMode
SubmitModeback to summary
public OVRHapticsBuffer SubmitMode(int value)

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

public Class OVRHapticsBuffer.Buffer

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

An array of OVRHapticsBuffer structs.

Field Summary

Modifier and TypeField and Description
private static final OVRHapticsBuffer

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

a ByteBuffer view of the data pointed to by the OVRHapticsBuffer#Samples field.
Samples
(int
the number of elements in the returned buffer
capacity
)

public OVRHapticsBuffer.Buffer
Samples(ByteBuffer value)

Sets the address of the specified ByteBuffer to the OVRHapticsBuffer#Samples field.

public int

Returns:

the value of the OVRHapticsBuffer#SamplesCount field.
SamplesCount
()

public OVRHapticsBuffer.Buffer
SamplesCount(int value)

Sets the specified value to the OVRHapticsBuffer#SamplesCount field.

protected OVRHapticsBuffer.Buffer
public int

Returns:

the value of the OVRHapticsBuffer#SubmitMode field.
SubmitMode
()

public OVRHapticsBuffer.Buffer
SubmitMode(int value)

Sets the specified value to the OVRHapticsBuffer#SubmitMode field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRHapticsBuffer ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new OVRHapticsBuffer.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 OVRHapticsBuffer#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 OVRHapticsBuffer getElementFactory()

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

Annotations
@Override
Samplesback to summary
public ByteBuffer Samples(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the OVRHapticsBuffer#Samples field.

Annotations
@NativeType:void *
Samplesback to summary
public OVRHapticsBuffer.Buffer Samples(ByteBuffer value)

Sets the address of the specified ByteBuffer to the OVRHapticsBuffer#Samples field.

SamplesCountback to summary
public int SamplesCount()
Returns:int

the value of the OVRHapticsBuffer#SamplesCount field.

SamplesCountback to summary
public OVRHapticsBuffer.Buffer SamplesCount(int value)

Sets the specified value to the OVRHapticsBuffer#SamplesCount field.

selfback to summary
protected OVRHapticsBuffer.Buffer self()

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

Annotations
@Override
SubmitModeback to summary
public int SubmitMode()
Returns:int

the value of the OVRHapticsBuffer#SubmitMode field.

Annotations
@NativeType:ovrHapticsBufferSubmitMode
SubmitModeback to summary
public OVRHapticsBuffer.Buffer SubmitMode(int value)

Sets the specified value to the OVRHapticsBuffer#SubmitMode field.