Package org.lwjgl.openxr

Class XrVector3f

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVector3f>

org.lwjgl.openxr.XrVector3f

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrVector3f
extends org.lwjgl.system.Struct<XrVector3f>
implements org.lwjgl.system.NativeResource

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, XrSpaceTriangleMeshMETA, XrSpaceVelocity, XrSpaceVelocityData, XrSpatialAnchorsQueryInfoRadiusML, XrTriangleMeshCreateInfoFB, XrVector2f, XrVector4f, XrWorldMeshBlockML, TriangleMeshGetVertexBufferFB

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrVector3f.Buffer	An array of XrVector3f structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	SIZEOF	The struct size in bytes.
static final int	X	The struct member offsets.
static final int	Y	The struct member offsets.
static final int	Z	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
XrVector3f(ByteBuffer container)	Creates a XrVector3f instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrVector3f	calloc()	Returns a new XrVector3f instance allocated with memCalloc.
static XrVector3f.Buffer	calloc(int capacity)	Returns a new XrVector3f.Buffer instance allocated with memCalloc.
static XrVector3f.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVector3f.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVector3f	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVector3f instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVector3f	create()	Returns a new XrVector3f instance allocated with BufferUtils.
static XrVector3f.Buffer	create(int capacity)	Returns a new XrVector3f.Buffer instance allocated with BufferUtils.
static XrVector3f	create(long address)	Returns a new XrVector3f instance for the specified memory address.
static XrVector3f.Buffer	create(long address, int capacity)	Create a XrVector3f.Buffer instance at the specified memory.
static @Nullable XrVector3f	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVector3f.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrVector3f	malloc()	Returns a new XrVector3f instance allocated with memAlloc.
static XrVector3f.Buffer	malloc(int capacity)	Returns a new XrVector3f.Buffer instance allocated with memAlloc.
static XrVector3f.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVector3f.Buffer instance allocated on the specified MemoryStack.
static XrVector3f	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVector3f instance allocated on the specified MemoryStack.
static float	nx(long struct)	Unsafe version of x().
static void	nx(long struct, float value)	Unsafe version of x.
static float	ny(long struct)	Unsafe version of y().
static void	ny(long struct, float value)	Unsafe version of y.
static float	nz(long struct)	Unsafe version of z().
static void	nz(long struct, float value)	Unsafe version of z.
XrVector3f	set(float x, float y, float z)	Initializes this struct with the specified values.
XrVector3f	set(XrVector3f src)	Copies the specified struct data to this struct.
int	sizeof()
float	x()	the x coordinate of the vector.
XrVector3f	x(float value)	Sets the specified value to the x() field.
float	y()	the y coordinate of the vector.
XrVector3f	y(float value)	Sets the specified value to the y() field.
float	z()	the z coordinate of the vector.
XrVector3f	z(float value)	Sets the specified value to the z() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

X

public static final int X

The struct member offsets.

Y

public static final int Y

The struct member offsets.

Z

public static final int Z

The struct member offsets.

Constructor Details

XrVector3f

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrVector3f>

x

public float x()

the x coordinate of the vector.

y

public float y()

the y coordinate of the vector.

z

public float z()

the z coordinate of the vector.

x

public XrVector3f x(float value)

Sets the specified value to the x() field.

y

public XrVector3f y(float value)

Sets the specified value to the y() field.

z

public XrVector3f z(float value)

Sets the specified value to the z() field.

set

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

Initializes this struct with the specified values.

set

public XrVector3f set(XrVector3f src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVector3f malloc()

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

calloc

public static XrVector3f calloc()

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

create

public static XrVector3f create()

Returns a new XrVector3f instance allocated with BufferUtils.

create

public static XrVector3f create(long address)

Returns a new XrVector3f instance for the specified memory address.

createSafe

public static @Nullable XrVector3f createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVector3f.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVector3f.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVector3f.Buffer create(int capacity)

Returns a new XrVector3f.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrVector3f.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrVector3f malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrVector3f instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrVector3f calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrVector3f.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrVector3f.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nx

public static float nx(long struct)

Unsafe version of x().

ny

public static float ny(long struct)

Unsafe version of y().

nz

public static float nz(long struct)

Unsafe version of z().

nx

public static void nx(long struct,
 float value)

Unsafe version of x.

ny

public static void ny(long struct,
 float value)

Unsafe version of y.

nz

public static void nz(long struct,
 float value)

Unsafe version of z.