Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrVector3f

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

Three-dimensional vector.
Description

If used to represent physical distances (rather than e.g. velocity or angular velocity) and not otherwise specified, values must be in meters.

See Also

XrCompositionLayerReprojectionPlaneOverrideMSFT, XrGeometryInstanceCreateInfoFB, XrGeometryInstanceTransformFB, XrHandCapsuleFB, XrHandJointVelocityEXT, XrHandMeshVertexMSFT, XrHandTrackingMeshFB, XrKeyboardTrackingDescriptionFB, XrPassthroughMeshTransformInfoHTC, XrPosef, XrQuaternionf, XrSceneMeshVertexBufferMSFT, XrSceneOrientedBoxBoundMSFT, XrSceneSphereBoundMSFT, XrSpaceVelocity, XrTriangleMeshCreateInfoFB, XrVector2f, XrVector4f, TriangleMeshGetVertexBufferFB

Layout


struct XrVector3f {
    float x;
    float y;
    float z;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrVector3f.Buffer

An array of XrVector3f structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
SIZEOF

The struct size in bytes.

public static final int
X

The struct member offsets.

public static final int
Y

The struct member offsets.

public static final int
Z

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrVector3f(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrVector3f
calloc()

Returns a new XrVector3f instance allocated with memCalloc.

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

Returns a new XrVector3f.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrVector3f instance allocated with BufferUtils.

public static XrVector3f
create(long address)

Returns a new XrVector3f instance for the specified memory address.

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

Returns a new XrVector3f.Buffer instance allocated with BufferUtils.

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

Create a XrVector3f.Buffer instance at the specified memory.

public static XrVector3f
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrVector3f
malloc()

Returns a new XrVector3f instance allocated with memAlloc.

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

Returns a new XrVector3f.Buffer instance allocated with memAlloc.

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

Returns a new XrVector3f instance allocated on the specified MemoryStack.

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

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

public static float
nx(long struct)

Unsafe version of x.

public static void
nx(long struct, float value)

Unsafe version of x.

public static float
ny(long struct)

Unsafe version of y.

public static void
ny(long struct, float value)

Unsafe version of y.

public static float
nz(long struct)

Unsafe version of z.

public static void
nz(long struct, float value)

Unsafe version of z.

public XrVector3f
set(float x, float y, float z)

Initializes this struct with the specified values.

public XrVector3f

Returns:

this struct
set
(XrVector3f
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 float
x()

the x coordinate of the vector.

public XrVector3f
x(float value)

Sets the specified value to the x field.

public float
y()

the y coordinate of the vector.

public XrVector3f
y(float value)

Sets the specified value to the y field.

public float
z()

the z coordinate of the vector.

public XrVector3f
z(float value)

Sets the specified value to the z 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.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Xback to summary
public static final int X

The struct member offsets.

Yback to summary
public static final int Y

The struct member offsets.

Zback to summary
public static final int Z

The struct member offsets.

Constructor Detail

XrVector3fback to summary
protected XrVector3f(long address, ByteBuffer container)
XrVector3fback to summary
public XrVector3f(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrVector3f calloc(MemoryStack stack)

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

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

Returns a new XrVector3f instance allocated with BufferUtils.

createback to summary
public static XrVector3f create(long address)

Returns a new XrVector3f instance for the specified memory address.

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

Returns a new XrVector3f.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrVector3f.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrVector3f createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrVector3f malloc(MemoryStack stack)

Returns a new XrVector3f instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nxback to summary
public static float nx(long struct)

Unsafe version of x.

nxback to summary
public static void nx(long struct, float value)

Unsafe version of x.

nyback to summary
public static float ny(long struct)

Unsafe version of y.

nyback to summary
public static void ny(long struct, float value)

Unsafe version of y.

nzback to summary
public static float nz(long struct)

Unsafe version of z.

nzback to summary
public static void nz(long struct, float value)

Unsafe version of z.

setback to summary
public XrVector3f set(float x, float y, float z)

Initializes this struct with the specified values.

setback to summary
public XrVector3f set(XrVector3f src)

Copies the specified struct data to this struct.

Parameters
src:XrVector3f

the source struct

Returns:XrVector3f

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
xback to summary
public float x()

the x coordinate of the vector.

xback to summary
public XrVector3f x(float value)

Sets the specified value to the x field.

yback to summary
public float y()

the y coordinate of the vector.

yback to summary
public XrVector3f y(float value)

Sets the specified value to the y field.

zback to summary
public float z()

the z coordinate of the vector.

zback to summary
public XrVector3f z(float value)

Sets the specified value to the z field.

org.lwjgl.openxr back to summary

public Class XrVector3f.Buffer

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

An array of XrVector3f structs.

Field Summary

Modifier and TypeField and Description
private static final XrVector3f

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrVector3f.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 XrVector3f
protected XrVector3f.Buffer
public float

Returns:

the value of the XrVector3f#x field.
x
()

public XrVector3f.Buffer
x(float value)

Sets the specified value to the XrVector3f#x field.

public float

Returns:

the value of the XrVector3f#y field.
y
()

public XrVector3f.Buffer
y(float value)

Sets the specified value to the XrVector3f#y field.

public float

Returns:

the value of the XrVector3f#z field.
z
()

public XrVector3f.Buffer
z(float value)

Sets the specified value to the XrVector3f#z field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrVector3f ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
selfback to summary
protected XrVector3f.Buffer self()

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

Annotations
@Override
xback to summary
public float x()
Returns:float

the value of the XrVector3f#x field.

xback to summary
public XrVector3f.Buffer x(float value)

Sets the specified value to the XrVector3f#x field.

yback to summary
public float y()
Returns:float

the value of the XrVector3f#y field.

yback to summary
public XrVector3f.Buffer y(float value)

Sets the specified value to the XrVector3f#y field.

zback to summary
public float z()
Returns:float

the value of the XrVector3f#z field.

zback to summary
public XrVector3f.Buffer z(float value)

Sets the specified value to the XrVector3f#z field.