Package org.lwjgl.openxr

Class XrSystemEnvironmentDepthPropertiesMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemEnvironmentDepthPropertiesMETA>

org.lwjgl.openxr.XrSystemEnvironmentDepthPropertiesMETA

All Implemented Interfaces:

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

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

System property for environment depth.

Description

An application can inspect whether the system is capable of supporting environment depth by extending the XrSystemProperties with XrSystemEnvironmentDepthPropertiesMETA structure when calling GetSystemProperties.

If and only if a runtime returns FALSE for supportsEnvironmentDepth, the runtime must return ERROR_FEATURE_UNSUPPORTED from CreateEnvironmentDepthProviderMETA.

If and only if a runtime returns FALSE for supportsHandRemoval, the runtime must return ERROR_FEATURE_UNSUPPORTED from SetEnvironmentDepthHandRemovalMETA.

Valid Usage (Implicit)

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

Layout

 struct XrSystemEnvironmentDepthPropertiesMETA {
     XrStructureType type();
     void * next();
     XrBool32 supportsEnvironmentDepth();
     XrBool32 supportsHandRemoval();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSystemEnvironmentDepthPropertiesMETA	calloc()	Returns a new XrSystemEnvironmentDepthPropertiesMETA instance allocated with memCalloc.
static XrSystemEnvironmentDepthPropertiesMETA.Buffer	calloc(int capacity)	Returns a new XrSystemEnvironmentDepthPropertiesMETA.Buffer instance allocated with memCalloc.
static XrSystemEnvironmentDepthPropertiesMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemEnvironmentDepthPropertiesMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemEnvironmentDepthPropertiesMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemEnvironmentDepthPropertiesMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemEnvironmentDepthPropertiesMETA	create()	Returns a new XrSystemEnvironmentDepthPropertiesMETA instance allocated with BufferUtils.
static XrSystemEnvironmentDepthPropertiesMETA.Buffer	create(int capacity)	Returns a new XrSystemEnvironmentDepthPropertiesMETA.Buffer instance allocated with BufferUtils.
static XrSystemEnvironmentDepthPropertiesMETA	create(long address)	Returns a new XrSystemEnvironmentDepthPropertiesMETA instance for the specified memory address.
static XrSystemEnvironmentDepthPropertiesMETA.Buffer	create(long address, int capacity)	Create a XrSystemEnvironmentDepthPropertiesMETA.Buffer instance at the specified memory.
static @Nullable XrSystemEnvironmentDepthPropertiesMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSystemEnvironmentDepthPropertiesMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSystemEnvironmentDepthPropertiesMETA	malloc()	Returns a new XrSystemEnvironmentDepthPropertiesMETA instance allocated with memAlloc.
static XrSystemEnvironmentDepthPropertiesMETA.Buffer	malloc(int capacity)	Returns a new XrSystemEnvironmentDepthPropertiesMETA.Buffer instance allocated with memAlloc.
static XrSystemEnvironmentDepthPropertiesMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemEnvironmentDepthPropertiesMETA.Buffer instance allocated on the specified MemoryStack.
static XrSystemEnvironmentDepthPropertiesMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemEnvironmentDepthPropertiesMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSystemEnvironmentDepthPropertiesMETA	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nsupportsEnvironmentDepth(long struct)	Unsafe version of supportsEnvironmentDepth().
static int	nsupportsHandRemoval(long struct)	Unsafe version of supportsHandRemoval().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSystemEnvironmentDepthPropertiesMETA	set(int type, long next)	Initializes this struct with the specified values.
XrSystemEnvironmentDepthPropertiesMETA	set(XrSystemEnvironmentDepthPropertiesMETA src)	Copies the specified struct data to this struct.
int	sizeof()
boolean	supportsEnvironmentDepth()	an XrBool32 indicating if current system supports environment depth.
boolean	supportsHandRemoval()	an XrBool32 indicating if current system supports hand removal.
int	type()	the XrStructureType of this structure.
XrSystemEnvironmentDepthPropertiesMETA	type(int value)	Sets the specified value to the type() field.
XrSystemEnvironmentDepthPropertiesMETA	type$Default()	Sets the TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_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.

SUPPORTSENVIRONMENTDEPTH

public static final int SUPPORTSENVIRONMENTDEPTH

The struct member offsets.

SUPPORTSHANDREMOVAL

public static final int SUPPORTSHANDREMOVAL

The struct member offsets.

Constructor Details

XrSystemEnvironmentDepthPropertiesMETA

public XrSystemEnvironmentDepthPropertiesMETA(ByteBuffer container)

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

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.

supportsEnvironmentDepth

public boolean supportsEnvironmentDepth()

an XrBool32 indicating if current system supports environment depth.

supportsHandRemoval

public boolean supportsHandRemoval()

an XrBool32 indicating if current system supports hand removal.

type

public XrSystemEnvironmentDepthPropertiesMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemEnvironmentDepthPropertiesMETA type$Default()

Sets the TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META value to the type() field.

next

public XrSystemEnvironmentDepthPropertiesMETA next(long value)

Sets the specified value to the next() field.

set

public XrSystemEnvironmentDepthPropertiesMETA set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemEnvironmentDepthPropertiesMETA set(XrSystemEnvironmentDepthPropertiesMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemEnvironmentDepthPropertiesMETA malloc()

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

calloc

public static XrSystemEnvironmentDepthPropertiesMETA calloc()

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

create

public static XrSystemEnvironmentDepthPropertiesMETA create()

Returns a new XrSystemEnvironmentDepthPropertiesMETA instance allocated with BufferUtils.

create

public static XrSystemEnvironmentDepthPropertiesMETA create(long address)

Returns a new XrSystemEnvironmentDepthPropertiesMETA instance for the specified memory address.

createSafe

public static @Nullable XrSystemEnvironmentDepthPropertiesMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemEnvironmentDepthPropertiesMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemEnvironmentDepthPropertiesMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemEnvironmentDepthPropertiesMETA.Buffer create(int capacity)

Returns a new XrSystemEnvironmentDepthPropertiesMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemEnvironmentDepthPropertiesMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemEnvironmentDepthPropertiesMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsEnvironmentDepth

public static int nsupportsEnvironmentDepth(long struct)

Unsafe version of supportsEnvironmentDepth().

nsupportsHandRemoval

public static int nsupportsHandRemoval(long struct)

Unsafe version of supportsHandRemoval().

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.