Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrViveTrackerPathsHTCX

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

Struct contains two paths of VIVE tracker.
Description

The XrViveTrackerPathsHTCX structure contains two paths of VIVE tracker.

Valid Usage (Implicit)
See Also

XrEventDataViveTrackerConnectedHTCX, EnumerateViveTrackerPathsHTCX

Layout


struct XrViveTrackerPathsHTCX {
    XrStructureType type;
    void * next;
    XrPath persistentPath;
    XrPath rolePath;
}

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
PERSISTENTPATH

The struct member offsets.

public static final int
ROLEPATH

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
XrViveTrackerPathsHTCX(long address, ByteBuffer container)

public
XrViveTrackerPathsHTCX(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrViveTrackerPathsHTCX
calloc()

Returns a new XrViveTrackerPathsHTCX instance allocated with memCalloc.

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

Returns a new XrViveTrackerPathsHTCX.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrViveTrackerPathsHTCX instance allocated with BufferUtils.

public static XrViveTrackerPathsHTCX
create(long address)

Returns a new XrViveTrackerPathsHTCX instance for the specified memory address.

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

Returns a new XrViveTrackerPathsHTCX.Buffer instance allocated with BufferUtils.

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

Create a XrViveTrackerPathsHTCX.Buffer instance at the specified memory.

public static XrViveTrackerPathsHTCX
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrViveTrackerPathsHTCX
malloc()

Returns a new XrViveTrackerPathsHTCX instance allocated with memAlloc.

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

Returns a new XrViveTrackerPathsHTCX.Buffer instance allocated with memAlloc.

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

Returns a new XrViveTrackerPathsHTCX instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrViveTrackerPathsHTCX
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 long
npersistentPath(long struct)

Unsafe version of persistentPath.

public static long
nrolePath(long struct)

Unsafe version of rolePath.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public long
persistentPath()

the unique path of the VIVE tracker which is persistent over the lifetime of the hardware.

public long
rolePath()

the path of the VIVE tracker role.

public XrViveTrackerPathsHTCX
set(int type, long next)

Initializes this struct with the specified values.

public XrViveTrackerPathsHTCX

Returns:

this struct
set
(XrViveTrackerPathsHTCX
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 XrViveTrackerPathsHTCX
type(int value)

Sets the specified value to the type field.

public XrViveTrackerPathsHTCX
type$Default()

Sets the TYPE_VIVE_TRACKER_PATHS_HTCX 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.

PERSISTENTPATHback to summary
public static final int PERSISTENTPATH

The struct member offsets.

ROLEPATHback to summary
public static final int ROLEPATH

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

XrViveTrackerPathsHTCXback to summary
protected XrViveTrackerPathsHTCX(long address, ByteBuffer container)
XrViveTrackerPathsHTCXback to summary
public XrViveTrackerPathsHTCX(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrViveTrackerPathsHTCX calloc(MemoryStack stack)

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

Returns a new XrViveTrackerPathsHTCX.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 XrViveTrackerPathsHTCX 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 XrViveTrackerPathsHTCX create()

Returns a new XrViveTrackerPathsHTCX instance allocated with BufferUtils.

createback to summary
public static XrViveTrackerPathsHTCX create(long address)

Returns a new XrViveTrackerPathsHTCX instance for the specified memory address.

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

Returns a new XrViveTrackerPathsHTCX.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrViveTrackerPathsHTCX.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrViveTrackerPathsHTCX createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrViveTrackerPathsHTCX malloc(MemoryStack stack)

Returns a new XrViveTrackerPathsHTCX instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrViveTrackerPathsHTCX.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 or this extension.

Annotations
@NativeType:void *
nextback to summary
public XrViveTrackerPathsHTCX 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.

npersistentPathback to summary
public static long npersistentPath(long struct)

Unsafe version of persistentPath.

nrolePathback to summary
public static long nrolePath(long struct)

Unsafe version of rolePath.

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.

persistentPathback to summary
public long persistentPath()

the unique path of the VIVE tracker which is persistent over the lifetime of the hardware.

Annotations
@NativeType:XrPath
rolePathback to summary
public long rolePath()

the path of the VIVE tracker role. This may be NULL_PATH if the role is not assigned.

Annotations
@NativeType:XrPath
setback to summary
public XrViveTrackerPathsHTCX set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrViveTrackerPathsHTCX set(XrViveTrackerPathsHTCX src)

Copies the specified struct data to this struct.

Parameters
src:XrViveTrackerPathsHTCX

the source struct

Returns:XrViveTrackerPathsHTCX

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.

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

Sets the specified value to the type field.

type$Defaultback to summary
public XrViveTrackerPathsHTCX type$Default()

Sets the TYPE_VIVE_TRACKER_PATHS_HTCX value to the type field.

org.lwjgl.openxr back to summary

public Class XrViveTrackerPathsHTCX.Buffer

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

An array of XrViveTrackerPathsHTCX structs.

Field Summary

Modifier and TypeField and Description
private static final XrViveTrackerPathsHTCX

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public XrViveTrackerPathsHTCX.Buffer
next(long value)

Sets the specified value to the XrViveTrackerPathsHTCX#next field.

public long

Returns:

the value of the XrViveTrackerPathsHTCX#persistentPath field.
persistentPath
()

public long

Returns:

the value of the XrViveTrackerPathsHTCX#rolePath field.
rolePath
()

protected XrViveTrackerPathsHTCX.Buffer
public int

Returns:

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

public XrViveTrackerPathsHTCX.Buffer
type(int value)

Sets the specified value to the XrViveTrackerPathsHTCX#type field.

public XrViveTrackerPathsHTCX.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrViveTrackerPathsHTCX ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the XrViveTrackerPathsHTCX#next field.

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

Sets the specified value to the XrViveTrackerPathsHTCX#next field.

persistentPathback to summary
public long persistentPath()
Returns:long

the value of the XrViveTrackerPathsHTCX#persistentPath field.

Annotations
@NativeType:XrPath
rolePathback to summary
public long rolePath()
Returns:long

the value of the XrViveTrackerPathsHTCX#rolePath field.

Annotations
@NativeType:XrPath
selfback to summary
protected XrViveTrackerPathsHTCX.Buffer self()

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

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

the value of the XrViveTrackerPathsHTCX#type field.

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

Sets the specified value to the XrViveTrackerPathsHTCX#type field.

type$Defaultback to summary
public XrViveTrackerPathsHTCX.Buffer type$Default()

Sets the TYPE_VIVE_TRACKER_PATHS_HTCX value to the XrViveTrackerPathsHTCX#type field.