Package org.lwjgl.openxr

Class XrCompositionLayerDepthInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerDepthInfoKHR>

org.lwjgl.openxr.XrCompositionLayerDepthInfoKHR

All Implemented Interfaces:

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

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

Depth map layer info.

Description

Note

The window space depth values minDepth and maxDepth are akin to the parameters of glDepthRange that specify the mapping from normalized device coordinates into window space.

Note

A reversed mapping of depth, such that points closer to the view have a window space depth that is greater than points further away can be achieved by making nearZ > farZ.

XrCompositionLayerDepthInfoKHR contains the information needed to associate depth with the color information in a projection layer. When submitting depth images along with projection layers, add the XrCompositionLayerDepthInfoKHR to the next chain for all XrCompositionLayerProjectionView structures in the given layer.

The homogeneous transform from view space z to window space depth is given by the following matrix, where a = minDepth, b = maxDepth, n = nearZ, and f = farZ.

Homogeneous values are constructed from real values by appending a w component with value 1.0.

General homogeneous values are projected back to real space by dividing by the w component.

Valid Usage (Implicit)

• The XR_KHR_composition_layer_depth extension must be enabled prior to using XrCompositionLayerDepthInfoKHR
• type must be TYPE_COMPOSITION_LAYER_DEPTH_INFO_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• subImage must be a valid XrSwapchainSubImage structure

See Also

XrCompositionLayerBaseHeader, XrCompositionLayerProjection, XrCompositionLayerProjectionView, XrFrameEndInfo, XrSwapchainSubImage, EndFrame

Layout

 struct XrCompositionLayerDepthInfoKHR {
     XrStructureType type();
     void const * next();
     XrSwapchainSubImage subImage();
     float minDepth();
     float maxDepth();
     float nearZ();
     float farZ();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerDepthInfoKHR.Buffer	An array of XrCompositionLayerDepthInfoKHR 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	MAXDEPTH	The struct member offsets.
static final int	MINDEPTH	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	SUBIMAGE	The struct member offsets.
static final int	TYPE	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
XrCompositionLayerDepthInfoKHR(ByteBuffer container)	Creates a XrCompositionLayerDepthInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerDepthInfoKHR	calloc()	Returns a new XrCompositionLayerDepthInfoKHR instance allocated with memCalloc.
static XrCompositionLayerDepthInfoKHR.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerDepthInfoKHR.Buffer instance allocated with memCalloc.
static XrCompositionLayerDepthInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerDepthInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerDepthInfoKHR	create()	Returns a new XrCompositionLayerDepthInfoKHR instance allocated with BufferUtils.
static XrCompositionLayerDepthInfoKHR.Buffer	create(int capacity)	Returns a new XrCompositionLayerDepthInfoKHR.Buffer instance allocated with BufferUtils.
static XrCompositionLayerDepthInfoKHR	create(long address)	Returns a new XrCompositionLayerDepthInfoKHR instance for the specified memory address.
static XrCompositionLayerDepthInfoKHR.Buffer	create(long address, int capacity)	Create a XrCompositionLayerDepthInfoKHR.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerDepthInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerDepthInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	farZ()	see nearZ
XrCompositionLayerDepthInfoKHR	farZ(float value)	Sets the specified value to the farZ() field.
static XrCompositionLayerDepthInfoKHR	malloc()	Returns a new XrCompositionLayerDepthInfoKHR instance allocated with memAlloc.
static XrCompositionLayerDepthInfoKHR.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerDepthInfoKHR.Buffer instance allocated with memAlloc.
static XrCompositionLayerDepthInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthInfoKHR.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerDepthInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthInfoKHR instance allocated on the specified MemoryStack.
float	maxDepth()	see minDepth
XrCompositionLayerDepthInfoKHR	maxDepth(float value)	Sets the specified value to the maxDepth() field.
float	minDepth()	minDepth and maxDepth are the window space depths that correspond to the near and far frustum planes, respectively.
XrCompositionLayerDepthInfoKHR	minDepth(float value)	Sets the specified value to the minDepth() field.
float	nearZ()	nearZ and farZ are the positive distances in meters to the near and far frustum planes, respectively.
XrCompositionLayerDepthInfoKHR	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.
XrCompositionLayerDepthInfoKHR	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	nmaxDepth(long struct)	Unsafe version of maxDepth().
static void	nmaxDepth(long struct, float value)	Unsafe version of maxDepth.
static float	nminDepth(long struct)	Unsafe version of minDepth().
static void	nminDepth(long struct, float value)	Unsafe version of minDepth.
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 XrSwapchainSubImage	nsubImage(long struct)	Unsafe version of subImage().
static void	nsubImage(long struct, XrSwapchainSubImage value)	Unsafe version of subImage.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrCompositionLayerDepthInfoKHR	set(int type, long next, XrSwapchainSubImage subImage, float minDepth, float maxDepth, float nearZ, float farZ)	Initializes this struct with the specified values.
XrCompositionLayerDepthInfoKHR	set(XrCompositionLayerDepthInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
XrSwapchainSubImage	subImage()	identifies the depth image XrSwapchainSubImage to be associated with the color swapchain.
XrCompositionLayerDepthInfoKHR	subImage(Consumer<XrSwapchainSubImage> consumer)	Passes the subImage() field to the specified Consumer.
XrCompositionLayerDepthInfoKHR	subImage(XrSwapchainSubImage value)	Copies the specified XrSwapchainSubImage to the subImage() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerDepthInfoKHR	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerDepthInfoKHR	type$Default()	Sets the TYPE_COMPOSITION_LAYER_DEPTH_INFO_KHR value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

SUBIMAGE

public static final int SUBIMAGE

The struct member offsets.

MINDEPTH

public static final int MINDEPTH

The struct member offsets.

MAXDEPTH

public static final int MAXDEPTH

The struct member offsets.

NEARZ

public static final int NEARZ

The struct member offsets.

FARZ

public static final int FARZ

The struct member offsets.

Constructor Details

XrCompositionLayerDepthInfoKHR

public XrCompositionLayerDepthInfoKHR(ByteBuffer container)

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

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.

subImage

public XrSwapchainSubImage subImage()

identifies the depth image XrSwapchainSubImage to be associated with the color swapchain. The swapchain must have been created with a XrSwapchainCreateInfo::faceCount of 1.

minDepth

public float minDepth()

minDepth and maxDepth are the window space depths that correspond to the near and far frustum planes, respectively. minDepth must be less than maxDepth. minDepth and maxDepth must be in the range [0, 1].

maxDepth

public float maxDepth()

see minDepth

nearZ

public float nearZ()

nearZ and farZ are the positive distances in meters to the near and far frustum planes, respectively. nearZ and farZ must not be equal. nearZ and farZ must be in the range (0, +infinity].

farZ

public float farZ()

see nearZ

type

public XrCompositionLayerDepthInfoKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerDepthInfoKHR type$Default()

Sets the TYPE_COMPOSITION_LAYER_DEPTH_INFO_KHR value to the type() field.

next

public XrCompositionLayerDepthInfoKHR next(long value)

Sets the specified value to the next() field.

subImage

public XrCompositionLayerDepthInfoKHR subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the subImage() field.

subImage

public XrCompositionLayerDepthInfoKHR subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the subImage() field to the specified Consumer.

minDepth

public XrCompositionLayerDepthInfoKHR minDepth(float value)

Sets the specified value to the minDepth() field.

maxDepth

public XrCompositionLayerDepthInfoKHR maxDepth(float value)

Sets the specified value to the maxDepth() field.

nearZ

public XrCompositionLayerDepthInfoKHR nearZ(float value)

Sets the specified value to the nearZ() field.

farZ

public XrCompositionLayerDepthInfoKHR farZ(float value)

Sets the specified value to the farZ() field.

set

public XrCompositionLayerDepthInfoKHR set(int type,
 long next,
 XrSwapchainSubImage subImage,
 float minDepth,
 float maxDepth,
 float nearZ,
 float farZ)

Initializes this struct with the specified values.

set

public XrCompositionLayerDepthInfoKHR set(XrCompositionLayerDepthInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerDepthInfoKHR malloc()

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

calloc

public static XrCompositionLayerDepthInfoKHR calloc()

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

create

public static XrCompositionLayerDepthInfoKHR create()

Returns a new XrCompositionLayerDepthInfoKHR instance allocated with BufferUtils.

create

public static XrCompositionLayerDepthInfoKHR create(long address)

Returns a new XrCompositionLayerDepthInfoKHR instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerDepthInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerDepthInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerDepthInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerDepthInfoKHR.Buffer create(int capacity)

Returns a new XrCompositionLayerDepthInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerDepthInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerDepthInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsubImage

public static XrSwapchainSubImage nsubImage(long struct)

Unsafe version of subImage().

nminDepth

public static float nminDepth(long struct)

Unsafe version of minDepth().

nmaxDepth

public static float nmaxDepth(long struct)

Unsafe version of maxDepth().

nnearZ

public static float nnearZ(long struct)

Unsafe version of nearZ().

nfarZ

public static float nfarZ(long struct)

Unsafe version of farZ().

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.

nsubImage

public static void nsubImage(long struct,
 XrSwapchainSubImage value)

Unsafe version of subImage.

nminDepth

public static void nminDepth(long struct,
 float value)

Unsafe version of minDepth.

nmaxDepth

public static void nmaxDepth(long struct,
 float value)

Unsafe version of maxDepth.

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.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate