java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.ovr.OVRTouchHapticsDesc

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class OVRTouchHapticsDesc
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Describes the Touch Haptics engine.
Member documentation
- SampleRateHz – Haptics engine frequency/sample-rate, sample time in seconds equals 1.0/sampleRateHz
- SampleSizeInBytes – Size of each Haptics sample, sample value range is [0, 2^(Bytes*8)-1]
- QueueMinSizeToAvoidStarvation – Queue size that would guarantee Haptics engine would not starve for data. Make sure size doesn't drop below it for best results.
- SubmitMinSamples – Minimum number of samples that can be sent to Haptics through SubmitControllerVibration
- SubmitMaxSamples – Maximum number of samples that can be sent to Haptics through SubmitControllerVibration
- SubmitOptimalSamples – Optimal number of samples that can be sent to Haptics through SubmitControllerVibration
Layout
```
 struct ovrTouchHapticsDesc {
     int SampleRateHz;
     int SampleSizeInBytes;
     int QueueMinSizeToAvoidStarvation;
     int SubmitMinSamples;
     int SubmitMaxSamples;
     int SubmitOptimalSamples;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OVRTouchHapticsDesc.Buffer
An array of OVRTouchHapticsDesc structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`QUEUEMINSIZETOAVOIDSTARVATION SAMPLERATEHZ SAMPLESIZEINBYTES`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`SUBMITMAXSAMPLES SUBMITMINSAMPLES SUBMITOPTIMALSAMPLES`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`OVRTouchHapticsDesc(java.nio.ByteBuffer container)`	Creates a `OVRTouchHapticsDesc` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static OVRTouchHapticsDesc`	`calloc()`	Returns a new `OVRTouchHapticsDesc` instance allocated with `memCalloc`.
`static OVRTouchHapticsDesc.Buffer`	`calloc(int capacity)`	Returns a new `OVRTouchHapticsDesc.Buffer` instance allocated with `memCalloc`.
`static OVRTouchHapticsDesc`	`callocStack()`	Returns a new `OVRTouchHapticsDesc` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static OVRTouchHapticsDesc.Buffer`	`callocStack(int capacity)`	Returns a new `OVRTouchHapticsDesc.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static OVRTouchHapticsDesc.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRTouchHapticsDesc.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static OVRTouchHapticsDesc`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRTouchHapticsDesc` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static OVRTouchHapticsDesc`	`create()`	Returns a new `OVRTouchHapticsDesc` instance allocated with `BufferUtils`.
`static OVRTouchHapticsDesc.Buffer`	`create(int capacity)`	Returns a new `OVRTouchHapticsDesc.Buffer` instance allocated with `BufferUtils`.
`static OVRTouchHapticsDesc`	`create(long address)`	Returns a new `OVRTouchHapticsDesc` instance for the specified memory address.
`static OVRTouchHapticsDesc.Buffer`	`create(long address, int capacity)`	Create a `OVRTouchHapticsDesc.Buffer` instance at the specified memory.
`static OVRTouchHapticsDesc`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static OVRTouchHapticsDesc.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`static OVRTouchHapticsDesc`	`malloc()`	Returns a new `OVRTouchHapticsDesc` instance allocated with `memAlloc`.
`static OVRTouchHapticsDesc.Buffer`	`malloc(int capacity)`	Returns a new `OVRTouchHapticsDesc.Buffer` instance allocated with `memAlloc`.
`static OVRTouchHapticsDesc`	`mallocStack()`	Returns a new `OVRTouchHapticsDesc` instance allocated on the thread-local `MemoryStack`.
`static OVRTouchHapticsDesc.Buffer`	`mallocStack(int capacity)`	Returns a new `OVRTouchHapticsDesc.Buffer` instance allocated on the thread-local `MemoryStack`.
`static OVRTouchHapticsDesc.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRTouchHapticsDesc.Buffer` instance allocated on the specified `MemoryStack`.
`static OVRTouchHapticsDesc`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRTouchHapticsDesc` instance allocated on the specified `MemoryStack`.
`static int`	`nQueueMinSizeToAvoidStarvation(long struct)`	Unsafe version of `QueueMinSizeToAvoidStarvation()`.
`static int`	`nSampleRateHz(long struct)`	Unsafe version of `SampleRateHz()`.
`static int`	`nSampleSizeInBytes(long struct)`	Unsafe version of `SampleSizeInBytes()`.
`static int`	`nSubmitMaxSamples(long struct)`	Unsafe version of `SubmitMaxSamples()`.
`static int`	`nSubmitMinSamples(long struct)`	Unsafe version of `SubmitMinSamples()`.
`static int`	`nSubmitOptimalSamples(long struct)`	Unsafe version of `SubmitOptimalSamples()`.
`int`	`QueueMinSizeToAvoidStarvation()`	Returns the value of the `QueueMinSizeToAvoidStarvation` field.
`int`	`SampleRateHz()`	Returns the value of the `SampleRateHz` field.
`int`	`SampleSizeInBytes()`	Returns the value of the `SampleSizeInBytes` field.
`int`	`sizeof()`
`int`	`SubmitMaxSamples()`	Returns the value of the `SubmitMaxSamples` field.
`int`	`SubmitMinSamples()`	Returns the value of the `SubmitMinSamples` field.
`int`	`SubmitOptimalSamples()`	Returns the value of the `SubmitOptimalSamples` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - SAMPLERATEHZ, SAMPLESIZEINBYTES, QUEUEMINSIZETOAVOIDSTARVATION, SUBMITMINSAMPLES, SUBMITMAXSAMPLES, SUBMITOPTIMALSAMPLES
    
    The struct member offsets.
- Constructor Detail
  - OVRTouchHapticsDesc
```
public OVRTouchHapticsDesc(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - SampleRateHz
```
public int SampleRateHz()
```
    Returns the value of the SampleRateHz field.
  - SampleSizeInBytes
```
public int SampleSizeInBytes()
```
    Returns the value of the SampleSizeInBytes field.
  - QueueMinSizeToAvoidStarvation
```
public int QueueMinSizeToAvoidStarvation()
```
    Returns the value of the QueueMinSizeToAvoidStarvation field.
  - SubmitMinSamples
```
public int SubmitMinSamples()
```
    Returns the value of the SubmitMinSamples field.
  - SubmitMaxSamples
```
public int SubmitMaxSamples()
```
    Returns the value of the SubmitMaxSamples field.
  - SubmitOptimalSamples
```
public int SubmitOptimalSamples()
```
    Returns the value of the SubmitOptimalSamples field.
  - malloc
```
public static OVRTouchHapticsDesc malloc()
```
    Returns a new OVRTouchHapticsDesc instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static OVRTouchHapticsDesc calloc()
```
    Returns a new OVRTouchHapticsDesc instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static OVRTouchHapticsDesc create()
```
    Returns a new OVRTouchHapticsDesc instance allocated with BufferUtils.
  - create
```
public static OVRTouchHapticsDesc create(long address)
```
    Returns a new OVRTouchHapticsDesc instance for the specified memory address.
  - createSafe
```
@Nullable
public static OVRTouchHapticsDesc createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static OVRTouchHapticsDesc.Buffer malloc(int capacity)
```
    Returns a new OVRTouchHapticsDesc.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static OVRTouchHapticsDesc.Buffer calloc(int capacity)
```
    Returns a new OVRTouchHapticsDesc.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static OVRTouchHapticsDesc.Buffer create(int capacity)
```
    Returns a new OVRTouchHapticsDesc.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static OVRTouchHapticsDesc.Buffer create(long address,
                                                int capacity)
```
    Create a OVRTouchHapticsDesc.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static OVRTouchHapticsDesc.Buffer createSafe(long address,
                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static OVRTouchHapticsDesc mallocStack()
```
    Returns a new OVRTouchHapticsDesc instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static OVRTouchHapticsDesc callocStack()
```
    Returns a new OVRTouchHapticsDesc instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static OVRTouchHapticsDesc mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRTouchHapticsDesc instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static OVRTouchHapticsDesc callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRTouchHapticsDesc instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static OVRTouchHapticsDesc.Buffer mallocStack(int capacity)
```
    Returns a new OVRTouchHapticsDesc.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static OVRTouchHapticsDesc.Buffer callocStack(int capacity)
```
    Returns a new OVRTouchHapticsDesc.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static OVRTouchHapticsDesc.Buffer mallocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRTouchHapticsDesc.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static OVRTouchHapticsDesc.Buffer callocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRTouchHapticsDesc.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nSampleRateHz
```
public static int nSampleRateHz(long struct)
```
    Unsafe version of SampleRateHz().
  - nSampleSizeInBytes
```
public static int nSampleSizeInBytes(long struct)
```
    Unsafe version of SampleSizeInBytes().
  - nQueueMinSizeToAvoidStarvation
```
public static int nQueueMinSizeToAvoidStarvation(long struct)
```
    Unsafe version of QueueMinSizeToAvoidStarvation().
  - nSubmitMinSamples
```
public static int nSubmitMinSamples(long struct)
```
    Unsafe version of SubmitMinSamples().
  - nSubmitMaxSamples
```
public static int nSubmitMaxSamples(long struct)
```
    Unsafe version of SubmitMaxSamples().
  - nSubmitOptimalSamples
```
public static int nSubmitOptimalSamples(long struct)
```
    Unsafe version of SubmitOptimalSamples().

Class OVRTouchHapticsDesc

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

SAMPLERATEHZ, SAMPLESIZEINBYTES, QUEUEMINSIZETOAVOIDSTARVATION, SUBMITMINSAMPLES, SUBMITMAXSAMPLES, SUBMITOPTIMALSAMPLES

Constructor Detail

OVRTouchHapticsDesc

Method Detail

sizeof

SampleRateHz

SampleSizeInBytes

QueueMinSizeToAvoidStarvation

SubmitMinSamples

SubmitMaxSamples

SubmitOptimalSamples

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nSampleRateHz

nSampleSizeInBytes

nQueueMinSizeToAvoidStarvation

nSubmitMinSamples

nSubmitMaxSamples

nSubmitOptimalSamples