Package org.lwjgl.openxr

Class XrRecommendedLayerResolutionGetInfoMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrRecommendedLayerResolutionGetInfoMETA>

org.lwjgl.openxr.XrRecommendedLayerResolutionGetInfoMETA

All Implemented Interfaces:

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

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

The structure provided by the application to the runtime, describing the information required for a recommendation to be made.

Description

If predictedDisplayTime is older than the predicted display time returned from most recent WaitFrame then, the runtime must return ERROR_TIME_INVALID.

Valid Usage (Implicit)

• The XR_META_recommended_layer_resolution extension must be enabled prior to using XrRecommendedLayerResolutionGetInfoMETA
• type must be TYPE_RECOMMENDED_LAYER_RESOLUTION_GET_INFO_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• layer must be a pointer to a valid XrCompositionLayerBaseHeader-based structure. See also: XrCompositionLayerCubeKHR, XrCompositionLayerCylinderKHR, XrCompositionLayerEquirect2KHR, XrCompositionLayerEquirectKHR, XrCompositionLayerPassthroughFB, XrCompositionLayerPassthroughHTC, XrCompositionLayerProjection, XrCompositionLayerQuad

See Also

XrCompositionLayerBaseHeader, GetRecommendedLayerResolutionMETA

Layout

 struct XrRecommendedLayerResolutionGetInfoMETA {
     XrStructureType type();
     void const * next();
     XrCompositionLayerBaseHeader const * layer();
     XrTime predictedDisplayTime();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrRecommendedLayerResolutionGetInfoMETA	calloc()	Returns a new XrRecommendedLayerResolutionGetInfoMETA instance allocated with memCalloc.
static XrRecommendedLayerResolutionGetInfoMETA.Buffer	calloc(int capacity)	Returns a new XrRecommendedLayerResolutionGetInfoMETA.Buffer instance allocated with memCalloc.
static XrRecommendedLayerResolutionGetInfoMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionGetInfoMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrRecommendedLayerResolutionGetInfoMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionGetInfoMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrRecommendedLayerResolutionGetInfoMETA	create()	Returns a new XrRecommendedLayerResolutionGetInfoMETA instance allocated with BufferUtils.
static XrRecommendedLayerResolutionGetInfoMETA.Buffer	create(int capacity)	Returns a new XrRecommendedLayerResolutionGetInfoMETA.Buffer instance allocated with BufferUtils.
static XrRecommendedLayerResolutionGetInfoMETA	create(long address)	Returns a new XrRecommendedLayerResolutionGetInfoMETA instance for the specified memory address.
static XrRecommendedLayerResolutionGetInfoMETA.Buffer	create(long address, int capacity)	Create a XrRecommendedLayerResolutionGetInfoMETA.Buffer instance at the specified memory.
static @Nullable XrRecommendedLayerResolutionGetInfoMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrRecommendedLayerResolutionGetInfoMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrCompositionLayerBaseHeader	layer()	a pointer to a structure based on XrCompositionLayerBaseHeader, describing the layer for which the application wants a runtime-recommended swapchain resolution.
XrRecommendedLayerResolutionGetInfoMETA	layer(XrCompositionLayerBaseHeader value)	Sets the address of the specified XrCompositionLayerBaseHeader to the layer() field.
static XrRecommendedLayerResolutionGetInfoMETA	malloc()	Returns a new XrRecommendedLayerResolutionGetInfoMETA instance allocated with memAlloc.
static XrRecommendedLayerResolutionGetInfoMETA.Buffer	malloc(int capacity)	Returns a new XrRecommendedLayerResolutionGetInfoMETA.Buffer instance allocated with memAlloc.
static XrRecommendedLayerResolutionGetInfoMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionGetInfoMETA.Buffer instance allocated on the specified MemoryStack.
static XrRecommendedLayerResolutionGetInfoMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrRecommendedLayerResolutionGetInfoMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrRecommendedLayerResolutionGetInfoMETA	next(long value)	Sets the specified value to the next() field.
static XrCompositionLayerBaseHeader	nlayer(long struct)	Unsafe version of layer().
static void	nlayer(long struct, XrCompositionLayerBaseHeader value)	Unsafe version of layer.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	npredictedDisplayTime(long struct)	Unsafe version of predictedDisplayTime().
static void	npredictedDisplayTime(long struct, long value)	Unsafe version of predictedDisplayTime.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	predictedDisplayTime()	the XrTime that the application intends to submit the layer for.
XrRecommendedLayerResolutionGetInfoMETA	predictedDisplayTime(long value)	Sets the specified value to the predictedDisplayTime() field.
XrRecommendedLayerResolutionGetInfoMETA	set(int type, long next, XrCompositionLayerBaseHeader layer, long predictedDisplayTime)	Initializes this struct with the specified values.
XrRecommendedLayerResolutionGetInfoMETA	set(XrRecommendedLayerResolutionGetInfoMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrRecommendedLayerResolutionGetInfoMETA	type(int value)	Sets the specified value to the type() field.
XrRecommendedLayerResolutionGetInfoMETA	type$Default()	Sets the TYPE_RECOMMENDED_LAYER_RESOLUTION_GET_INFO_META 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.

LAYER

public static final int LAYER

The struct member offsets.

PREDICTEDDISPLAYTIME

public static final int PREDICTEDDISPLAYTIME

The struct member offsets.

Constructor Details

XrRecommendedLayerResolutionGetInfoMETA

public XrRecommendedLayerResolutionGetInfoMETA(ByteBuffer container)

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

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.

layer

public XrCompositionLayerBaseHeader layer()

a pointer to a structure based on XrCompositionLayerBaseHeader, describing the layer for which the application wants a runtime-recommended swapchain resolution. Layers with multiple views may scale the views to match the scaled swapchain resolution.

predictedDisplayTime

public long predictedDisplayTime()

the XrTime that the application intends to submit the layer for.

type

public XrRecommendedLayerResolutionGetInfoMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrRecommendedLayerResolutionGetInfoMETA type$Default()

Sets the TYPE_RECOMMENDED_LAYER_RESOLUTION_GET_INFO_META value to the type() field.

next

public XrRecommendedLayerResolutionGetInfoMETA next(long value)

Sets the specified value to the next() field.

layer

public XrRecommendedLayerResolutionGetInfoMETA layer(XrCompositionLayerBaseHeader value)

Sets the address of the specified XrCompositionLayerBaseHeader to the layer() field.

predictedDisplayTime

public XrRecommendedLayerResolutionGetInfoMETA predictedDisplayTime(long value)

Sets the specified value to the predictedDisplayTime() field.

set

public XrRecommendedLayerResolutionGetInfoMETA set(int type,
 long next,
 XrCompositionLayerBaseHeader layer,
 long predictedDisplayTime)

Initializes this struct with the specified values.

set

public XrRecommendedLayerResolutionGetInfoMETA set(XrRecommendedLayerResolutionGetInfoMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrRecommendedLayerResolutionGetInfoMETA malloc()

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

calloc

public static XrRecommendedLayerResolutionGetInfoMETA calloc()

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

create

public static XrRecommendedLayerResolutionGetInfoMETA create()

Returns a new XrRecommendedLayerResolutionGetInfoMETA instance allocated with BufferUtils.

create

public static XrRecommendedLayerResolutionGetInfoMETA create(long address)

Returns a new XrRecommendedLayerResolutionGetInfoMETA instance for the specified memory address.

createSafe

public static @Nullable XrRecommendedLayerResolutionGetInfoMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrRecommendedLayerResolutionGetInfoMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrRecommendedLayerResolutionGetInfoMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrRecommendedLayerResolutionGetInfoMETA.Buffer create(int capacity)

Returns a new XrRecommendedLayerResolutionGetInfoMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrRecommendedLayerResolutionGetInfoMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrRecommendedLayerResolutionGetInfoMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlayer

public static XrCompositionLayerBaseHeader nlayer(long struct)

Unsafe version of layer().

npredictedDisplayTime

public static long npredictedDisplayTime(long struct)

Unsafe version of predictedDisplayTime().

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.

nlayer

public static void nlayer(long struct,
 XrCompositionLayerBaseHeader value)

Unsafe version of layer.

npredictedDisplayTime

public static void npredictedDisplayTime(long struct,
 long value)

Unsafe version of predictedDisplayTime.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate