Package org.lwjgl.openxr

Class XrExtent3Df

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrExtent3Df>

org.lwjgl.openxr.XrExtent3Df

All Implemented Interfaces:

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

Direct Known Subclasses:

XrExtent3DfEXT, XrExtent3DfFB, XrExtent3DfKHR

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

Represents the dimensions of an axis-aligned rectangular prism.

Description

This structure is used for component values that may be real numbers, represented with single-precision floating point.

If used to represent physical distances, values must be in meters. The width, height, and depth values must be non-negative.

See Also

XrBoxf, XrExtent2Df, XrExtent2Di

Layout

 struct XrExtent3Df {
     float width();
     float height();
     float depth();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrExtent3Df.Buffer	An array of XrExtent3Df 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	DEPTH	The struct member offsets.
static final int	HEIGHT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	WIDTH	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
XrExtent3Df(ByteBuffer container)	Creates a XrExtent3Df instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrExtent3Df	calloc()	Returns a new XrExtent3Df instance allocated with memCalloc.
static XrExtent3Df.Buffer	calloc(int capacity)	Returns a new XrExtent3Df.Buffer instance allocated with memCalloc.
static XrExtent3Df.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrExtent3Df.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrExtent3Df	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrExtent3Df instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrExtent3Df	create()	Returns a new XrExtent3Df instance allocated with BufferUtils.
static XrExtent3Df.Buffer	create(int capacity)	Returns a new XrExtent3Df.Buffer instance allocated with BufferUtils.
static XrExtent3Df	create(long address)	Returns a new XrExtent3Df instance for the specified memory address.
static XrExtent3Df.Buffer	create(long address, int capacity)	Create a XrExtent3Df.Buffer instance at the specified memory.
static @Nullable XrExtent3Df	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrExtent3Df.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	depth()	the floating-point depth of the extent (z).
XrExtent3Df	depth(float value)	Sets the specified value to the depth() field.
float	height()	the floating-point height of the extent (y).
XrExtent3Df	height(float value)	Sets the specified value to the height() field.
static XrExtent3Df	malloc()	Returns a new XrExtent3Df instance allocated with memAlloc.
static XrExtent3Df.Buffer	malloc(int capacity)	Returns a new XrExtent3Df.Buffer instance allocated with memAlloc.
static XrExtent3Df.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrExtent3Df.Buffer instance allocated on the specified MemoryStack.
static XrExtent3Df	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrExtent3Df instance allocated on the specified MemoryStack.
static float	ndepth(long struct)	Unsafe version of depth().
static void	ndepth(long struct, float value)	Unsafe version of depth.
static float	nheight(long struct)	Unsafe version of height().
static void	nheight(long struct, float value)	Unsafe version of height.
static float	nwidth(long struct)	Unsafe version of width().
static void	nwidth(long struct, float value)	Unsafe version of width.
XrExtent3Df	set(float width, float height, float depth)	Initializes this struct with the specified values.
XrExtent3Df	set(XrExtent3Df src)	Copies the specified struct data to this struct.
int	sizeof()
float	width()	the floating-point width of the extent (x).
XrExtent3Df	width(float value)	Sets the specified value to the width() 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.

WIDTH

public static final int WIDTH

The struct member offsets.

HEIGHT

public static final int HEIGHT

The struct member offsets.

DEPTH

public static final int DEPTH

The struct member offsets.

Constructor Details

XrExtent3Df

public XrExtent3Df(ByteBuffer container)

Creates a XrExtent3Df 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<XrExtent3Df>

width

public float width()

the floating-point width of the extent (x).

height

public float height()

the floating-point height of the extent (y).

depth

public float depth()

the floating-point depth of the extent (z).

width

public XrExtent3Df width(float value)

Sets the specified value to the width() field.

height

public XrExtent3Df height(float value)

Sets the specified value to the height() field.

depth

public XrExtent3Df depth(float value)

Sets the specified value to the depth() field.

set

public XrExtent3Df set(float width,
 float height,
 float depth)

Initializes this struct with the specified values.

set

public XrExtent3Df set(XrExtent3Df src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrExtent3Df malloc()

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

calloc

public static XrExtent3Df calloc()

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

create

public static XrExtent3Df create()

Returns a new XrExtent3Df instance allocated with BufferUtils.

create

public static XrExtent3Df create(long address)

Returns a new XrExtent3Df instance for the specified memory address.

createSafe

public static @Nullable XrExtent3Df createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrExtent3Df.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrExtent3Df.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrExtent3Df.Buffer create(int capacity)

Returns a new XrExtent3Df.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrExtent3Df.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrExtent3Df instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nwidth

public static float nwidth(long struct)

Unsafe version of width().

nheight

public static float nheight(long struct)

Unsafe version of height().

ndepth

public static float ndepth(long struct)

Unsafe version of depth().

nwidth

public static void nwidth(long struct,
 float value)

Unsafe version of width.

nheight

public static void nheight(long struct,
 float value)

Unsafe version of height.

ndepth

public static void ndepth(long struct,
 float value)

Unsafe version of depth.