Package org.lwjgl.openxr

Class XrEnvironmentDepthImageViewMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEnvironmentDepthImageViewMETA>

org.lwjgl.openxr.XrEnvironmentDepthImageViewMETA

All Implemented Interfaces:

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

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

XrEnvironmentDepthImageViewMETA.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to using XrEnvironmentDepthImageViewMETA
• type must be TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrEnvironmentDepthImageMETA, XrFovf, XrPosef

Layout

 struct XrEnvironmentDepthImageViewMETA {
     XrStructureType type();
     void const * next();
     XrFovf fov();
     XrPosef pose();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrEnvironmentDepthImageViewMETA	calloc()	Returns a new XrEnvironmentDepthImageViewMETA instance allocated with memCalloc.
static XrEnvironmentDepthImageViewMETA.Buffer	calloc(int capacity)	Returns a new XrEnvironmentDepthImageViewMETA.Buffer instance allocated with memCalloc.
static XrEnvironmentDepthImageViewMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageViewMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEnvironmentDepthImageViewMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageViewMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEnvironmentDepthImageViewMETA	create()	Returns a new XrEnvironmentDepthImageViewMETA instance allocated with BufferUtils.
static XrEnvironmentDepthImageViewMETA.Buffer	create(int capacity)	Returns a new XrEnvironmentDepthImageViewMETA.Buffer instance allocated with BufferUtils.
static XrEnvironmentDepthImageViewMETA	create(long address)	Returns a new XrEnvironmentDepthImageViewMETA instance for the specified memory address.
static XrEnvironmentDepthImageViewMETA.Buffer	create(long address, int capacity)	Create a XrEnvironmentDepthImageViewMETA.Buffer instance at the specified memory.
static @Nullable XrEnvironmentDepthImageViewMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEnvironmentDepthImageViewMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrFovf	fov()	an XrFovf specifying the field of view used to generate this view.
XrEnvironmentDepthImageViewMETA	fov(Consumer<XrFovf> consumer)	Passes the fov() field to the specified Consumer.
XrEnvironmentDepthImageViewMETA	fov(XrFovf value)	Copies the specified XrFovf to the fov() field.
static XrEnvironmentDepthImageViewMETA	malloc()	Returns a new XrEnvironmentDepthImageViewMETA instance allocated with memAlloc.
static XrEnvironmentDepthImageViewMETA.Buffer	malloc(int capacity)	Returns a new XrEnvironmentDepthImageViewMETA.Buffer instance allocated with memAlloc.
static XrEnvironmentDepthImageViewMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageViewMETA.Buffer instance allocated on the specified MemoryStack.
static XrEnvironmentDepthImageViewMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEnvironmentDepthImageViewMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEnvironmentDepthImageViewMETA	next(long value)	Sets the specified value to the next() field.
static XrFovf	nfov(long struct)	Unsafe version of fov().
static void	nfov(long struct, XrFovf value)	Unsafe version of fov.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrPosef	npose(long struct)	Unsafe version of pose().
static void	npose(long struct, XrPosef value)	Unsafe version of pose.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrPosef	pose()	an XrPosef specifying the pose from which the depth map was rendered.
XrEnvironmentDepthImageViewMETA	pose(Consumer<XrPosef> consumer)	Passes the pose() field to the specified Consumer.
XrEnvironmentDepthImageViewMETA	pose(XrPosef value)	Copies the specified XrPosef to the pose() field.
XrEnvironmentDepthImageViewMETA	set(int type, long next, XrFovf fov, XrPosef pose)	Initializes this struct with the specified values.
XrEnvironmentDepthImageViewMETA	set(XrEnvironmentDepthImageViewMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEnvironmentDepthImageViewMETA	type(int value)	Sets the specified value to the type() field.
XrEnvironmentDepthImageViewMETA	type$Default()	Sets the TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META value to the type() 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.

FOV

public static final int FOV

The struct member offsets.

POSE

public static final int POSE

The struct member offsets.

Constructor Details

XrEnvironmentDepthImageViewMETA

public XrEnvironmentDepthImageViewMETA(ByteBuffer container)

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

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.

fov

public XrFovf fov()

an XrFovf specifying the field of view used to generate this view. The view is never flipped horizontally nor vertically.

pose

public XrPosef pose()

an XrPosef specifying the pose from which the depth map was rendered. The reference frame is specified in XrEnvironmentDepthImageAcquireInfoMETA.

type

public XrEnvironmentDepthImageViewMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEnvironmentDepthImageViewMETA type$Default()

Sets the TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META value to the type() field.

next

public XrEnvironmentDepthImageViewMETA next(long value)

Sets the specified value to the next() field.

fov

public XrEnvironmentDepthImageViewMETA fov(XrFovf value)

Copies the specified XrFovf to the fov() field.

fov

public XrEnvironmentDepthImageViewMETA fov(Consumer<XrFovf> consumer)

Passes the fov() field to the specified Consumer.

pose

public XrEnvironmentDepthImageViewMETA pose(XrPosef value)

Copies the specified XrPosef to the pose() field.

pose

public XrEnvironmentDepthImageViewMETA pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

set

public XrEnvironmentDepthImageViewMETA set(int type,
 long next,
 XrFovf fov,
 XrPosef pose)

Initializes this struct with the specified values.

set

public XrEnvironmentDepthImageViewMETA set(XrEnvironmentDepthImageViewMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEnvironmentDepthImageViewMETA malloc()

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

calloc

public static XrEnvironmentDepthImageViewMETA calloc()

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

create

public static XrEnvironmentDepthImageViewMETA create()

Returns a new XrEnvironmentDepthImageViewMETA instance allocated with BufferUtils.

create

public static XrEnvironmentDepthImageViewMETA create(long address)

Returns a new XrEnvironmentDepthImageViewMETA instance for the specified memory address.

createSafe

public static @Nullable XrEnvironmentDepthImageViewMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEnvironmentDepthImageViewMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEnvironmentDepthImageViewMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEnvironmentDepthImageViewMETA.Buffer create(int capacity)

Returns a new XrEnvironmentDepthImageViewMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEnvironmentDepthImageViewMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEnvironmentDepthImageViewMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nfov

public static XrFovf nfov(long struct)

Unsafe version of fov().

npose

public static XrPosef npose(long struct)

Unsafe version of pose().

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.

nfov

public static void nfov(long struct,
 XrFovf value)

Unsafe version of fov.

npose

public static void npose(long struct,
 XrPosef value)

Unsafe version of pose.