Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHapticBaseHeader

extends Struct<XrHapticBaseHeader>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Base header for haptic feedback.
Valid Usage (Implicit)
See Also

XrHapticVibration, XrInteractionProfileAnalogThresholdVALVE, XrInteractionProfileDpadBindingEXT, ApplyHapticFeedback

Layout


struct XrHapticBaseHeader {
    XrStructureType type;
    void const * next;
}

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
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrHapticBaseHeader(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrHapticBaseHeader
calloc()

Returns a new XrHapticBaseHeader instance allocated with memCalloc.

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

Returns a new XrHapticBaseHeader.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrHapticBaseHeader
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 XrHapticBaseHeader
create()

Returns a new XrHapticBaseHeader instance allocated with BufferUtils.

public static XrHapticBaseHeader
create(long address)

Returns a new XrHapticBaseHeader instance for the specified memory address.

public static XrHapticBaseHeader
create(XrHapticVibration value)

Upcasts the specified XrHapticVibration instance to XrHapticBaseHeader.

public static XrHapticBaseHeader
create(XrHapticAmplitudeEnvelopeVibrationFB value)

Upcasts the specified XrHapticAmplitudeEnvelopeVibrationFB instance to XrHapticBaseHeader.

public static XrHapticBaseHeader
create(XrHapticPcmVibrationFB value)

Upcasts the specified XrHapticPcmVibrationFB instance to XrHapticBaseHeader.

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

Returns a new XrHapticBaseHeader.Buffer instance allocated with BufferUtils.

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

Create a XrHapticBaseHeader.Buffer instance at the specified memory.

public static XrHapticBaseHeader.Buffer
create(XrHapticVibration.Buffer value)

Upcasts the specified XrHapticVibration.Buffer instance to XrHapticBaseHeader.Buffer.

public static XrHapticBaseHeader.Buffer
create(XrHapticAmplitudeEnvelopeVibrationFB.Buffer value)

Upcasts the specified XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance to XrHapticBaseHeader.Buffer.

public static XrHapticBaseHeader.Buffer
create(XrHapticPcmVibrationFB.Buffer value)

Upcasts the specified XrHapticPcmVibrationFB.Buffer instance to XrHapticBaseHeader.Buffer.

public static XrHapticBaseHeader
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrHapticBaseHeader
malloc()

Returns a new XrHapticBaseHeader instance allocated with memAlloc.

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

Returns a new XrHapticBaseHeader.Buffer instance allocated with memAlloc.

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

Returns a new XrHapticBaseHeader instance allocated on the specified MemoryStack.

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

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

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrHapticBaseHeader
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrHapticBaseHeader
set(int type, long next)

Initializes this struct with the specified values.

public XrHapticBaseHeader

Returns:

this struct
set
(XrHapticBaseHeader
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
type()

the XrStructureType of this structure.

public XrHapticBaseHeader
type(int value)

Sets the specified value to the type field.

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.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrHapticBaseHeaderback to summary
protected XrHapticBaseHeader(long address, ByteBuffer container)
XrHapticBaseHeaderback to summary
public XrHapticBaseHeader(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHapticBaseHeader calloc(MemoryStack stack)

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

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

createback to summary
protected XrHapticBaseHeader 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 XrHapticBaseHeader create()

Returns a new XrHapticBaseHeader instance allocated with BufferUtils.

createback to summary
public static XrHapticBaseHeader create(long address)

Returns a new XrHapticBaseHeader instance for the specified memory address.

createback to summary
public static XrHapticBaseHeader create(XrHapticVibration value)

Upcasts the specified XrHapticVibration instance to XrHapticBaseHeader.

createback to summary
public static XrHapticBaseHeader create(XrHapticAmplitudeEnvelopeVibrationFB value)

Upcasts the specified XrHapticAmplitudeEnvelopeVibrationFB instance to XrHapticBaseHeader.

createback to summary
public static XrHapticBaseHeader create(XrHapticPcmVibrationFB value)

Upcasts the specified XrHapticPcmVibrationFB instance to XrHapticBaseHeader.

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

Returns a new XrHapticBaseHeader.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHapticBaseHeader.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createback to summary
public static XrHapticBaseHeader.Buffer create(XrHapticVibration.Buffer value)

Upcasts the specified XrHapticVibration.Buffer instance to XrHapticBaseHeader.Buffer.

createback to summary
public static XrHapticBaseHeader.Buffer create(XrHapticAmplitudeEnvelopeVibrationFB.Buffer value)

Upcasts the specified XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance to XrHapticBaseHeader.Buffer.

createback to summary
public static XrHapticBaseHeader.Buffer create(XrHapticPcmVibrationFB.Buffer value)

Upcasts the specified XrHapticPcmVibrationFB.Buffer instance to XrHapticBaseHeader.Buffer.

createSafeback to summary
public static XrHapticBaseHeader createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHapticBaseHeader malloc(MemoryStack stack)

Returns a new XrHapticBaseHeader instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

Annotations
@NativeType:void const *
nextback to summary
public XrHapticBaseHeader next(long value)

Sets the specified value to the next field.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public XrHapticBaseHeader set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrHapticBaseHeader set(XrHapticBaseHeader src)

Copies the specified struct data to this struct.

Parameters
src:XrHapticBaseHeader

the source struct

Returns:XrHapticBaseHeader

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
typeback to summary
public int type()

the XrStructureType of this structure. This base structure itself has no associated XrStructureType value.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrHapticBaseHeader type(int value)

Sets the specified value to the type field.

org.lwjgl.openxr back to summary

public Class XrHapticBaseHeader.Buffer

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

An array of XrHapticBaseHeader structs.

Field Summary

Modifier and TypeField and Description
private static final XrHapticBaseHeader

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHapticBaseHeader.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 XrHapticBaseHeader
public long

Returns:

the value of the XrHapticBaseHeader#next field.
next
()

public XrHapticBaseHeader.Buffer
next(long value)

Sets the specified value to the XrHapticBaseHeader#next field.

protected XrHapticBaseHeader.Buffer
public int

Returns:

the value of the XrHapticBaseHeader#type field.
type
()

public XrHapticBaseHeader.Buffer
type(int value)

Sets the specified value to the XrHapticBaseHeader#type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHapticBaseHeader ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrHapticBaseHeader#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrHapticBaseHeader.Buffer next(long value)

Sets the specified value to the XrHapticBaseHeader#next field.

selfback to summary
protected XrHapticBaseHeader.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrHapticBaseHeader#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrHapticBaseHeader.Buffer type(int value)

Sets the specified value to the XrHapticBaseHeader#type field.