Package org.lwjgl.openxr

Class XrEnvironmentDepthImageMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEnvironmentDepthImageMETA>

org.lwjgl.openxr.XrEnvironmentDepthImageMETA

All Implemented Interfaces:

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

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

XrEnvironmentDepthImageMETA.

Description

Depth is provided as textures in the same format as described in the XR_KHR_composition_layer_depth extension.

The frustum’s Z-planes are placed at nearZ and farZ meters. When farZ is less than nearZ, an infinite projection matrix is used.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to using XrEnvironmentDepthImageMETA
• type must be TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• Any given element of views must be a valid XrEnvironmentDepthImageViewMETA structure

See Also

XrEnvironmentDepthImageViewMETA, AcquireEnvironmentDepthImageMETA

Layout

 struct XrEnvironmentDepthImageMETA {
     XrStructureType type();
     void const * next();
     uint32_t swapchainIndex();
     float nearZ();
     float farZ();
     XrEnvironmentDepthImageViewMETA views()[2];
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrEnvironmentDepthImageMETA.Buffer	An array of XrEnvironmentDepthImageMETA 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	FARZ	The struct member offsets.
static final int	NEARZ	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SWAPCHAININDEX	The struct member offsets.
static final int	TYPE	The struct member offsets.
static final int	VIEWS	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
XrEnvironmentDepthImageMETA(ByteBuffer container)	Creates a XrEnvironmentDepthImageMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrEnvironmentDepthImageMETA	calloc()	Returns a new XrEnvironmentDepthImageMETA instance allocated with memCalloc.
static XrEnvironmentDepthImageMETA.Buffer	calloc(int capacity)	Returns a new XrEnvironmentDepthImageMETA.Buffer instance allocated with memCalloc.
static XrEnvironmentDepthImageMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEnvironmentDepthImageMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEnvironmentDepthImageMETA	create()	Returns a new XrEnvironmentDepthImageMETA instance allocated with BufferUtils.
static XrEnvironmentDepthImageMETA.Buffer	create(int capacity)	Returns a new XrEnvironmentDepthImageMETA.Buffer instance allocated with BufferUtils.
static XrEnvironmentDepthImageMETA	create(long address)	Returns a new XrEnvironmentDepthImageMETA instance for the specified memory address.
static XrEnvironmentDepthImageMETA.Buffer	create(long address, int capacity)	Create a XrEnvironmentDepthImageMETA.Buffer instance at the specified memory.
static @Nullable XrEnvironmentDepthImageMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEnvironmentDepthImageMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	farZ()	the distance to the far Z plane in meters.
XrEnvironmentDepthImageMETA	farZ(float value)	Sets the specified value to the farZ() field.
static XrEnvironmentDepthImageMETA	malloc()	Returns a new XrEnvironmentDepthImageMETA instance allocated with memAlloc.
static XrEnvironmentDepthImageMETA.Buffer	malloc(int capacity)	Returns a new XrEnvironmentDepthImageMETA.Buffer instance allocated with memAlloc.
static XrEnvironmentDepthImageMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageMETA.Buffer instance allocated on the specified MemoryStack.
static XrEnvironmentDepthImageMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageMETA instance allocated on the specified MemoryStack.
float	nearZ()	the distance to the near Z plane in meters.
XrEnvironmentDepthImageMETA	nearZ(float value)	Sets the specified value to the nearZ() field.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEnvironmentDepthImageMETA	next(long value)	Sets the specified value to the next() field.
static float	nfarZ(long struct)	Unsafe version of farZ().
static void	nfarZ(long struct, float value)	Unsafe version of farZ.
static float	nnearZ(long struct)	Unsafe version of nearZ().
static void	nnearZ(long struct, float value)	Unsafe version of nearZ.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nswapchainIndex(long struct)	Unsafe version of swapchainIndex().
static void	nswapchainIndex(long struct, int value)	Unsafe version of swapchainIndex.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static XrEnvironmentDepthImageViewMETA.Buffer	nviews(long struct)	Unsafe version of views().
static XrEnvironmentDepthImageViewMETA	nviews(long struct, int index)	Unsafe version of views.
static void	nviews(long struct, int index, XrEnvironmentDepthImageViewMETA value)	Unsafe version of views.
static void	nviews(long struct, XrEnvironmentDepthImageViewMETA.Buffer value)	Unsafe version of views.
XrEnvironmentDepthImageMETA	set(int type, long next, int swapchainIndex, float nearZ, float farZ, XrEnvironmentDepthImageViewMETA.Buffer views)	Initializes this struct with the specified values.
XrEnvironmentDepthImageMETA	set(XrEnvironmentDepthImageMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	swapchainIndex()	the index of the acquired texture in the depth swapchain.
XrEnvironmentDepthImageMETA	swapchainIndex(int value)	Sets the specified value to the swapchainIndex() field.
int	type()	the XrStructureType of this structure.
XrEnvironmentDepthImageMETA	type(int value)	Sets the specified value to the type() field.
XrEnvironmentDepthImageMETA	type$Default()	Sets the TYPE_ENVIRONMENT_DEPTH_IMAGE_META value to the type() field.
XrEnvironmentDepthImageViewMETA.Buffer	views()	an array of two XrEnvironmentDepthImageViewMETA, one for each eye, where index 0 is left eye and index 1 is the right eye.
XrEnvironmentDepthImageViewMETA	views(int index)	an array of two XrEnvironmentDepthImageViewMETA, one for each eye, where index 0 is left eye and index 1 is the right eye.
XrEnvironmentDepthImageMETA	views(int index, Consumer<XrEnvironmentDepthImageViewMETA> consumer)	Passes the element at index of the views() field to the specified Consumer.
XrEnvironmentDepthImageMETA	views(int index, XrEnvironmentDepthImageViewMETA value)	Copies the specified XrEnvironmentDepthImageViewMETA at the specified index of the views() field.
XrEnvironmentDepthImageMETA	views(Consumer<XrEnvironmentDepthImageViewMETA.Buffer> consumer)	Passes the views() field to the specified Consumer.
XrEnvironmentDepthImageMETA	views(XrEnvironmentDepthImageViewMETA.Buffer value)	Copies the specified XrEnvironmentDepthImageViewMETA.Buffer to the views() 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.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

SWAPCHAININDEX

public static final int SWAPCHAININDEX

The struct member offsets.

NEARZ

public static final int NEARZ

The struct member offsets.

FARZ

public static final int FARZ

The struct member offsets.

VIEWS

public static final int VIEWS

The struct member offsets.

Constructor Details

XrEnvironmentDepthImageMETA

public XrEnvironmentDepthImageMETA(ByteBuffer container)

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

type

public int type()

the XrStructureType of this structure.

next

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.

swapchainIndex

public int swapchainIndex()

the index of the acquired texture in the depth swapchain.

nearZ

public float nearZ()

the distance to the near Z plane in meters.

farZ

public float farZ()

the distance to the far Z plane in meters.

views

public XrEnvironmentDepthImageViewMETA.Buffer views()

an array of two XrEnvironmentDepthImageViewMETA, one for each eye, where index 0 is left eye and index 1 is the right eye.

views

public XrEnvironmentDepthImageViewMETA views(int index)

an array of two XrEnvironmentDepthImageViewMETA, one for each eye, where index 0 is left eye and index 1 is the right eye.

type

public XrEnvironmentDepthImageMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEnvironmentDepthImageMETA type$Default()

Sets the TYPE_ENVIRONMENT_DEPTH_IMAGE_META value to the type() field.

next

public XrEnvironmentDepthImageMETA next(long value)

Sets the specified value to the next() field.

swapchainIndex

public XrEnvironmentDepthImageMETA swapchainIndex(int value)

Sets the specified value to the swapchainIndex() field.

nearZ

public XrEnvironmentDepthImageMETA nearZ(float value)

Sets the specified value to the nearZ() field.

farZ

public XrEnvironmentDepthImageMETA farZ(float value)

Sets the specified value to the farZ() field.

views

public XrEnvironmentDepthImageMETA views(XrEnvironmentDepthImageViewMETA.Buffer value)

Copies the specified XrEnvironmentDepthImageViewMETA.Buffer to the views() field.

views

public XrEnvironmentDepthImageMETA views(int index,
 XrEnvironmentDepthImageViewMETA value)

Copies the specified XrEnvironmentDepthImageViewMETA at the specified index of the views() field.

views

public XrEnvironmentDepthImageMETA views(Consumer<XrEnvironmentDepthImageViewMETA.Buffer> consumer)

Passes the views() field to the specified Consumer.

views

public XrEnvironmentDepthImageMETA views(int index,
 Consumer<XrEnvironmentDepthImageViewMETA> consumer)

Passes the element at index of the views() field to the specified Consumer.

set

public XrEnvironmentDepthImageMETA set(int type,
 long next,
 int swapchainIndex,
 float nearZ,
 float farZ,
 XrEnvironmentDepthImageViewMETA.Buffer views)

Initializes this struct with the specified values.

set

public XrEnvironmentDepthImageMETA set(XrEnvironmentDepthImageMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEnvironmentDepthImageMETA malloc()

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

calloc

public static XrEnvironmentDepthImageMETA calloc()

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

create

public static XrEnvironmentDepthImageMETA create()

Returns a new XrEnvironmentDepthImageMETA instance allocated with BufferUtils.

create

public static XrEnvironmentDepthImageMETA create(long address)

Returns a new XrEnvironmentDepthImageMETA instance for the specified memory address.

createSafe

public static @Nullable XrEnvironmentDepthImageMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEnvironmentDepthImageMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEnvironmentDepthImageMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEnvironmentDepthImageMETA.Buffer create(int capacity)

Returns a new XrEnvironmentDepthImageMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEnvironmentDepthImageMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEnvironmentDepthImageMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nswapchainIndex

public static int nswapchainIndex(long struct)

Unsafe version of swapchainIndex().

nnearZ

public static float nnearZ(long struct)

Unsafe version of nearZ().

nfarZ

public static float nfarZ(long struct)

Unsafe version of farZ().

nviews

public static XrEnvironmentDepthImageViewMETA.Buffer nviews(long struct)

Unsafe version of views().

nviews

public static XrEnvironmentDepthImageViewMETA nviews(long struct,
 int index)

Unsafe version of views.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nswapchainIndex

public static void nswapchainIndex(long struct,
 int value)

Unsafe version of swapchainIndex.

nnearZ

public static void nnearZ(long struct,
 float value)

Unsafe version of nearZ.

nfarZ

public static void nfarZ(long struct,
 float value)

Unsafe version of farZ.

nviews

public static void nviews(long struct,
 XrEnvironmentDepthImageViewMETA.Buffer value)

Unsafe version of views.

nviews

public static void nviews(long struct,
 int index,
 XrEnvironmentDepthImageViewMETA value)

Unsafe version of views.