Package org.lwjgl.openxr

Class XrRecommendedLayerResolutionMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrRecommendedLayerResolutionMETA>

org.lwjgl.openxr.XrRecommendedLayerResolutionMETA

All Implemented Interfaces:

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

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

The structure returned by the runtime, containing resolution and whether the recommendation is valid.

Description

If the runtime does not wish to make a recommendation, isValid must be FALSE and recommendedImageDimensions must be {0,0}.

Valid Usage (Implicit)

• The XR_META_recommended_layer_resolution extension must be enabled prior to using XrRecommendedLayerResolutionMETA
• type must be TYPE_RECOMMENDED_LAYER_RESOLUTION_META
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrExtent2Di, GetRecommendedLayerResolutionMETA

Layout

 struct XrRecommendedLayerResolutionMETA {
     XrStructureType type();
     void * next();
     XrExtent2Di recommendedImageDimensions();
     XrBool32 isValid();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrRecommendedLayerResolutionMETA	calloc()	Returns a new XrRecommendedLayerResolutionMETA instance allocated with memCalloc.
static XrRecommendedLayerResolutionMETA.Buffer	calloc(int capacity)	Returns a new XrRecommendedLayerResolutionMETA.Buffer instance allocated with memCalloc.
static XrRecommendedLayerResolutionMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrRecommendedLayerResolutionMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrRecommendedLayerResolutionMETA	create()	Returns a new XrRecommendedLayerResolutionMETA instance allocated with BufferUtils.
static XrRecommendedLayerResolutionMETA.Buffer	create(int capacity)	Returns a new XrRecommendedLayerResolutionMETA.Buffer instance allocated with BufferUtils.
static XrRecommendedLayerResolutionMETA	create(long address)	Returns a new XrRecommendedLayerResolutionMETA instance for the specified memory address.
static XrRecommendedLayerResolutionMETA.Buffer	create(long address, int capacity)	Create a XrRecommendedLayerResolutionMETA.Buffer instance at the specified memory.
static @Nullable XrRecommendedLayerResolutionMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrRecommendedLayerResolutionMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	isValid()	the XrBool32 boolean returned by the runtime which indicates whether the runtime returned a valid recommendation or does not have any recommendations to make.
static XrRecommendedLayerResolutionMETA	malloc()	Returns a new XrRecommendedLayerResolutionMETA instance allocated with memAlloc.
static XrRecommendedLayerResolutionMETA.Buffer	malloc(int capacity)	Returns a new XrRecommendedLayerResolutionMETA.Buffer instance allocated with memAlloc.
static XrRecommendedLayerResolutionMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionMETA.Buffer instance allocated on the specified MemoryStack.
static XrRecommendedLayerResolutionMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrRecommendedLayerResolutionMETA	next(long value)	Sets the specified value to the next() field.
static int	nisValid(long struct)	Unsafe version of isValid().
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrExtent2Di	nrecommendedImageDimensions(long struct)	Unsafe version of recommendedImageDimensions().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrExtent2Di	recommendedImageDimensions()	the XrExtent2Di recommended image dimensions of the layer.
XrRecommendedLayerResolutionMETA	set(int type, long next)	Initializes this struct with the specified values.
XrRecommendedLayerResolutionMETA	set(XrRecommendedLayerResolutionMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrRecommendedLayerResolutionMETA	type(int value)	Sets the specified value to the type() field.
XrRecommendedLayerResolutionMETA	type$Default()	Sets the TYPE_RECOMMENDED_LAYER_RESOLUTION_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.

RECOMMENDEDIMAGEDIMENSIONS

public static final int RECOMMENDEDIMAGEDIMENSIONS

The struct member offsets.

ISVALID

public static final int ISVALID

The struct member offsets.

Constructor Details

XrRecommendedLayerResolutionMETA

public XrRecommendedLayerResolutionMETA(ByteBuffer container)

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

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.

recommendedImageDimensions

public XrExtent2Di recommendedImageDimensions()

the XrExtent2Di recommended image dimensions of the layer.

isValid

public boolean isValid()

the XrBool32 boolean returned by the runtime which indicates whether the runtime returned a valid recommendation or does not have any recommendations to make.

type

public XrRecommendedLayerResolutionMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrRecommendedLayerResolutionMETA type$Default()

Sets the TYPE_RECOMMENDED_LAYER_RESOLUTION_META value to the type() field.

next

public XrRecommendedLayerResolutionMETA next(long value)

Sets the specified value to the next() field.

set

public XrRecommendedLayerResolutionMETA set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrRecommendedLayerResolutionMETA set(XrRecommendedLayerResolutionMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrRecommendedLayerResolutionMETA malloc()

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

calloc

public static XrRecommendedLayerResolutionMETA calloc()

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

create

public static XrRecommendedLayerResolutionMETA create()

Returns a new XrRecommendedLayerResolutionMETA instance allocated with BufferUtils.

create

public static XrRecommendedLayerResolutionMETA create(long address)

Returns a new XrRecommendedLayerResolutionMETA instance for the specified memory address.

createSafe

public static @Nullable XrRecommendedLayerResolutionMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrRecommendedLayerResolutionMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrRecommendedLayerResolutionMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrRecommendedLayerResolutionMETA.Buffer create(int capacity)

Returns a new XrRecommendedLayerResolutionMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrRecommendedLayerResolutionMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrRecommendedLayerResolutionMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nrecommendedImageDimensions

public static XrExtent2Di nrecommendedImageDimensions(long struct)

Unsafe version of recommendedImageDimensions().

nisValid

public static int nisValid(long struct)

Unsafe version of isValid().

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.