Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRTouchHapticsDesc

extends Struct<OVRTouchHapticsDesc>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ovrTouchHapticsDesc
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Describes the Touch Haptics engine.

Layout


struct ovrTouchHapticsDesc {
    int SampleRateHz;
    int SampleSizeInBytes;
    int QueueMinSizeToAvoidStarvation;
    int SubmitMinSamples;
    int SubmitMaxSamples;
    int SubmitOptimalSamples;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
OVRTouchHapticsDesc.Buffer

An array of OVRTouchHapticsDesc structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
QUEUEMINSIZETOAVOIDSTARVATION

The struct member offsets.

public static final int
SAMPLERATEHZ

The struct member offsets.

public static final int
SAMPLESIZEINBYTES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBMITMAXSAMPLES

The struct member offsets.

public static final int
SUBMITMINSAMPLES

The struct member offsets.

public static final int
SUBMITOPTIMALSAMPLES

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
OVRTouchHapticsDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRTouchHapticsDesc
calloc()

Returns a new OVRTouchHapticsDesc instance allocated with memCalloc.

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

Returns a new OVRTouchHapticsDesc.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRTouchHapticsDesc
callocStack()

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

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

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

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

Returns a new OVRTouchHapticsDesc instance allocated with BufferUtils.

public static OVRTouchHapticsDesc
create(long address)

Returns a new OVRTouchHapticsDesc instance for the specified memory address.

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

Returns a new OVRTouchHapticsDesc.Buffer instance allocated with BufferUtils.

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

Create a OVRTouchHapticsDesc.Buffer instance at the specified memory.

public static OVRTouchHapticsDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static OVRTouchHapticsDesc
malloc()

Returns a new OVRTouchHapticsDesc instance allocated with memAlloc.

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

Returns a new OVRTouchHapticsDesc.Buffer instance allocated with memAlloc.

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

Returns a new OVRTouchHapticsDesc instance allocated on the specified MemoryStack.

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

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

public static OVRTouchHapticsDesc
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
nQueueMinSizeToAvoidStarvation(long struct)

Unsafe version of QueueMinSizeToAvoidStarvation.

public static int
nSampleRateHz(long struct)

Unsafe version of SampleRateHz.

public static int
nSampleSizeInBytes(long struct)

Unsafe version of SampleSizeInBytes.

public static int
nSubmitMaxSamples(long struct)

Unsafe version of SubmitMaxSamples.

public static int
nSubmitMinSamples(long struct)

Unsafe version of SubmitMinSamples.

public static int
nSubmitOptimalSamples(long struct)

Unsafe version of SubmitOptimalSamples.

public int
QueueMinSizeToAvoidStarvation()

Queue size that would guarantee Haptics engine would not starve for data.

public int
SampleRateHz()

Haptics engine frequency/sample-rate, sample time in seconds equals 1.0/sampleRateHz

public int
SampleSizeInBytes()

Size of each Haptics sample, sample value range is [0, 2^(Bytes*8)-1]

public int
sizeof()

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

Returns sizeof(struct).
public int
SubmitMaxSamples()

Maximum number of samples that can be sent to Haptics through SubmitControllerVibration

public int
SubmitMinSamples()

Minimum number of samples that can be sent to Haptics through SubmitControllerVibration

public int
SubmitOptimalSamples()

Optimal number of samples that can be sent to Haptics through SubmitControllerVibration

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.

QUEUEMINSIZETOAVOIDSTARVATIONback to summary
public static final int QUEUEMINSIZETOAVOIDSTARVATION

The struct member offsets.

SAMPLERATEHZback to summary
public static final int SAMPLERATEHZ

The struct member offsets.

SAMPLESIZEINBYTESback to summary
public static final int SAMPLESIZEINBYTES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBMITMAXSAMPLESback to summary
public static final int SUBMITMAXSAMPLES

The struct member offsets.

SUBMITMINSAMPLESback to summary
public static final int SUBMITMINSAMPLES

The struct member offsets.

SUBMITOPTIMALSAMPLESback to summary
public static final int SUBMITOPTIMALSAMPLES

The struct member offsets.

Constructor Detail

OVRTouchHapticsDescback to summary
protected OVRTouchHapticsDesc(long address, ByteBuffer container)
OVRTouchHapticsDescback to summary
public OVRTouchHapticsDesc(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRTouchHapticsDesc calloc(MemoryStack stack)

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

Returns a new OVRTouchHapticsDesc.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 OVRTouchHapticsDesc callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static OVRTouchHapticsDesc.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 OVRTouchHapticsDesc 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 OVRTouchHapticsDesc create()

Returns a new OVRTouchHapticsDesc instance allocated with BufferUtils.

createback to summary
public static OVRTouchHapticsDesc create(long address)

Returns a new OVRTouchHapticsDesc instance for the specified memory address.

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

Returns a new OVRTouchHapticsDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRTouchHapticsDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRTouchHapticsDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRTouchHapticsDesc malloc(MemoryStack stack)

Returns a new OVRTouchHapticsDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new OVRTouchHapticsDesc.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 OVRTouchHapticsDesc mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nQueueMinSizeToAvoidStarvationback to summary
public static int nQueueMinSizeToAvoidStarvation(long struct)

Unsafe version of QueueMinSizeToAvoidStarvation.

nSampleRateHzback to summary
public static int nSampleRateHz(long struct)

Unsafe version of SampleRateHz.

nSampleSizeInBytesback to summary
public static int nSampleSizeInBytes(long struct)

Unsafe version of SampleSizeInBytes.

nSubmitMaxSamplesback to summary
public static int nSubmitMaxSamples(long struct)

Unsafe version of SubmitMaxSamples.

nSubmitMinSamplesback to summary
public static int nSubmitMinSamples(long struct)

Unsafe version of SubmitMinSamples.

nSubmitOptimalSamplesback to summary
public static int nSubmitOptimalSamples(long struct)

Unsafe version of SubmitOptimalSamples.

QueueMinSizeToAvoidStarvationback to summary
public int QueueMinSizeToAvoidStarvation()

Queue size that would guarantee Haptics engine would not starve for data. Make sure size doesn't drop below it for best results.

SampleRateHzback to summary
public int SampleRateHz()

Haptics engine frequency/sample-rate, sample time in seconds equals 1.0/sampleRateHz

SampleSizeInBytesback to summary
public int SampleSizeInBytes()

Size of each Haptics sample, sample value range is [0, 2^(Bytes*8)-1]

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
SubmitMaxSamplesback to summary
public int SubmitMaxSamples()

Maximum number of samples that can be sent to Haptics through SubmitControllerVibration

SubmitMinSamplesback to summary
public int SubmitMinSamples()

Minimum number of samples that can be sent to Haptics through SubmitControllerVibration

SubmitOptimalSamplesback to summary
public int SubmitOptimalSamples()

Optimal number of samples that can be sent to Haptics through SubmitControllerVibration

org.lwjgl.ovr back to summary

public Class OVRTouchHapticsDesc.Buffer

extends StructBuffer<OVRTouchHapticsDesc, OVRTouchHapticsDesc.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of OVRTouchHapticsDesc structs.

Field Summary

Modifier and TypeField and Description
private static final OVRTouchHapticsDesc
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public int

Returns:

the value of the OVRTouchHapticsDesc#QueueMinSizeToAvoidStarvation field.
QueueMinSizeToAvoidStarvation()

public int

Returns:

the value of the OVRTouchHapticsDesc#SampleRateHz field.
SampleRateHz()

public int

Returns:

the value of the OVRTouchHapticsDesc#SampleSizeInBytes field.
SampleSizeInBytes()

protected OVRTouchHapticsDesc.Buffer
self()

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

public int

Returns:

the value of the OVRTouchHapticsDesc#SubmitMaxSamples field.
SubmitMaxSamples()

public int

Returns:

the value of the OVRTouchHapticsDesc#SubmitMinSamples field.
SubmitMinSamples()

public int

Returns:

the value of the OVRTouchHapticsDesc#SubmitOptimalSamples field.
SubmitOptimalSamples()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRTouchHapticsDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
QueueMinSizeToAvoidStarvationback to summary
public int QueueMinSizeToAvoidStarvation()
Returns:int

the value of the OVRTouchHapticsDesc#QueueMinSizeToAvoidStarvation field.

SampleRateHzback to summary
public int SampleRateHz()
Returns:int

the value of the OVRTouchHapticsDesc#SampleRateHz field.

SampleSizeInBytesback to summary
public int SampleSizeInBytes()
Returns:int

the value of the OVRTouchHapticsDesc#SampleSizeInBytes field.

selfback to summary
protected OVRTouchHapticsDesc.Buffer self()

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

Annotations
@Override
SubmitMaxSamplesback to summary
public int SubmitMaxSamples()
Returns:int

the value of the OVRTouchHapticsDesc#SubmitMaxSamples field.

SubmitMinSamplesback to summary
public int SubmitMinSamples()
Returns:int

the value of the OVRTouchHapticsDesc#SubmitMinSamples field.

SubmitOptimalSamplesback to summary
public int SubmitOptimalSamples()
Returns:int

the value of the OVRTouchHapticsDesc#SubmitOptimalSamples field.