Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRHapticsClip

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

Store a full Haptics clip, which can be used as data source for multiple OVRHapticsBuffer.

Layout


struct ovrHapticsClip {
    void const * Samples;
    int SamplesCount;
}

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
OVRHapticsClip(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRHapticsClip
calloc()

Returns a new OVRHapticsClip instance allocated with memCalloc.

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

Returns a new OVRHapticsClip.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRHapticsClip
callocStack()

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

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

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

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

Returns a new OVRHapticsClip instance allocated with BufferUtils.

public static OVRHapticsClip
create(long address)

Returns a new OVRHapticsClip instance for the specified memory address.

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

Returns a new OVRHapticsClip.Buffer instance allocated with BufferUtils.

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

Create a OVRHapticsClip.Buffer instance at the specified memory.

public static OVRHapticsClip
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static OVRHapticsClip
malloc()

Returns a new OVRHapticsClip instance allocated with memAlloc.

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

Returns a new OVRHapticsClip.Buffer instance allocated with memAlloc.

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

Returns a new OVRHapticsClip instance allocated on the specified MemoryStack.

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

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

public static OVRHapticsClip
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHapticsClip.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 int
nSamplesCount(long struct)

Unsafe version of SamplesCount.

public ByteBuffer

Returns:

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

public int
SamplesCount()

number of samples

public int
sizeof()

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

Returns sizeof(struct).
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.

Constructor Detail

OVRHapticsClipback to summary
protected OVRHapticsClip(long address, ByteBuffer container)
OVRHapticsClipback to summary
public OVRHapticsClip(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRHapticsClip calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new OVRHapticsClip instance allocated with BufferUtils.

createback to summary
public static OVRHapticsClip create(long address)

Returns a new OVRHapticsClip instance for the specified memory address.

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

Returns a new OVRHapticsClip.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRHapticsClip.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRHapticsClip createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRHapticsClip malloc(MemoryStack stack)

Returns a new OVRHapticsClip instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static OVRHapticsClip.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.

nSamplesCountback to summary
public static int nSamplesCount(long struct)

Unsafe version of SamplesCount.

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 const *
SamplesCountback to summary
public int SamplesCount()

number of samples

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
org.lwjgl.ovr back to summary

public Class OVRHapticsClip.Buffer

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

An array of OVRHapticsClip structs.

Field Summary

Modifier and TypeField and Description
private static final OVRHapticsClip

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public int

Returns:

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

protected OVRHapticsClip.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRHapticsClip ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new OVRHapticsClip.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 OVRHapticsClip#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 OVRHapticsClip 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 OVRHapticsClip#Samples field.

Annotations
@NativeType:void const *
SamplesCountback to summary
public int SamplesCount()
Returns:int

the value of the OVRHapticsClip#SamplesCount field.

selfback to summary
protected OVRHapticsClip.Buffer self()

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

Annotations
@Override