Package org.lwjgl.openxr

Class XrCompositionLayerEquirect2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerEquirect2KHR>

org.lwjgl.openxr.XrCompositionLayerEquirect2KHR

All Implemented Interfaces:

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

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

Equirectangular layer composition info.

Description

XrCompositionLayerEquirect2KHR contains the information needed to render an equirectangular image onto a sphere when calling EndFrame. XrCompositionLayerEquirect2KHR is an alias type for the base struct XrCompositionLayerBaseHeader used in XrFrameEndInfo.

Valid Usage (Implicit)

• The XR_KHR_composition_layer_equirect2 extension must be enabled prior to using XrCompositionLayerEquirect2KHR
• type must be TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values
• space must be a valid XrSpace handle
• eyeVisibility must be a valid XrEyeVisibility value
• subImage must be a valid XrSwapchainSubImage structure

See Also

XrCompositionLayerBaseHeader, XrFrameEndInfo, XrPosef, XrSwapchainSubImage, EndFrame

Layout

 struct XrCompositionLayerEquirect2KHR {
     XrStructureType type();
     void const * next();
     XrCompositionLayerFlags layerFlags();
     XrSpace space();
     XrEyeVisibility eyeVisibility();
     XrSwapchainSubImage subImage();
     XrPosef pose();
     float radius();
     float centralHorizontalAngle();
     float upperVerticalAngle();
     float lowerVerticalAngle();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerEquirect2KHR.Buffer	An array of XrCompositionLayerEquirect2KHR 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	CENTRALHORIZONTALANGLE	The struct member offsets.
static final int	EYEVISIBILITY	The struct member offsets.
static final int	LAYERFLAGS	The struct member offsets.
static final int	LOWERVERTICALANGLE	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	POSE	The struct member offsets.
static final int	RADIUS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE	The struct member offsets.
static final int	SUBIMAGE	The struct member offsets.
static final int	TYPE	The struct member offsets.
static final int	UPPERVERTICALANGLE	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
XrCompositionLayerEquirect2KHR(ByteBuffer container)	Creates a XrCompositionLayerEquirect2KHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerEquirect2KHR	calloc()	Returns a new XrCompositionLayerEquirect2KHR instance allocated with memCalloc.
static XrCompositionLayerEquirect2KHR.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerEquirect2KHR.Buffer instance allocated with memCalloc.
static XrCompositionLayerEquirect2KHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerEquirect2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerEquirect2KHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerEquirect2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
float	centralHorizontalAngle()	defines the visible horizontal angle of the sphere, based at 0 radians, in the range of [0, 2π].
XrCompositionLayerEquirect2KHR	centralHorizontalAngle(float value)	Sets the specified value to the centralHorizontalAngle() field.
static XrCompositionLayerEquirect2KHR	create()	Returns a new XrCompositionLayerEquirect2KHR instance allocated with BufferUtils.
static XrCompositionLayerEquirect2KHR.Buffer	create(int capacity)	Returns a new XrCompositionLayerEquirect2KHR.Buffer instance allocated with BufferUtils.
static XrCompositionLayerEquirect2KHR	create(long address)	Returns a new XrCompositionLayerEquirect2KHR instance for the specified memory address.
static XrCompositionLayerEquirect2KHR.Buffer	create(long address, int capacity)	Create a XrCompositionLayerEquirect2KHR.Buffer instance at the specified memory.
static XrCompositionLayerEquirect2KHR	create(XrCompositionLayerBaseHeader value)	Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerEquirect2KHR.
static XrCompositionLayerEquirect2KHR.Buffer	create(XrCompositionLayerBaseHeader.Buffer value)	Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerEquirect2KHR.Buffer.
static @Nullable XrCompositionLayerEquirect2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerEquirect2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	eyeVisibility()	the eye represented by this layer.
XrCompositionLayerEquirect2KHR	eyeVisibility(int value)	Sets the specified value to the eyeVisibility() field.
long	layerFlags()	specifies options for the layer.
XrCompositionLayerEquirect2KHR	layerFlags(long value)	Sets the specified value to the layerFlags() field.
float	lowerVerticalAngle()	defines the lower vertical angle of the visible portion of the sphere, in the range of [-π/2, π/2].
XrCompositionLayerEquirect2KHR	lowerVerticalAngle(float value)	Sets the specified value to the lowerVerticalAngle() field.
static XrCompositionLayerEquirect2KHR	malloc()	Returns a new XrCompositionLayerEquirect2KHR instance allocated with memAlloc.
static XrCompositionLayerEquirect2KHR.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerEquirect2KHR.Buffer instance allocated with memAlloc.
static XrCompositionLayerEquirect2KHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerEquirect2KHR.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerEquirect2KHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerEquirect2KHR instance allocated on the specified MemoryStack.
static float	ncentralHorizontalAngle(long struct)	Unsafe version of centralHorizontalAngle().
static void	ncentralHorizontalAngle(long struct, float value)	Unsafe version of centralHorizontalAngle.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerEquirect2KHR	next(long value)	Sets the specified value to the next() field.
static int	neyeVisibility(long struct)	Unsafe version of eyeVisibility().
static void	neyeVisibility(long struct, int value)	Unsafe version of eyeVisibility.
static long	nlayerFlags(long struct)	Unsafe version of layerFlags().
static void	nlayerFlags(long struct, long value)	Unsafe version of layerFlags.
static float	nlowerVerticalAngle(long struct)	Unsafe version of lowerVerticalAngle().
static void	nlowerVerticalAngle(long struct, float value)	Unsafe version of lowerVerticalAngle.
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 float	nradius(long struct)	Unsafe version of radius().
static void	nradius(long struct, float value)	Unsafe version of radius.
static long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
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.
static float	nupperVerticalAngle(long struct)	Unsafe version of upperVerticalAngle().
static void	nupperVerticalAngle(long struct, float value)	Unsafe version of upperVerticalAngle.
XrPosef	pose()	an XrPosef defining the position and orientation of the center point of the sphere onto which the equirect image data is mapped, relative to the reference frame of the space.
XrCompositionLayerEquirect2KHR	pose(Consumer<XrPosef> consumer)	Passes the pose() field to the specified Consumer.
XrCompositionLayerEquirect2KHR	pose(XrPosef value)	Copies the specified XrPosef to the pose() field.
float	radius()	the non-negative radius of the sphere onto which the equirect image data is mapped.
XrCompositionLayerEquirect2KHR	radius(float value)	Sets the specified value to the radius() field.
XrCompositionLayerEquirect2KHR	set(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchainSubImage subImage, XrPosef pose, float radius, float centralHorizontalAngle, float upperVerticalAngle, float lowerVerticalAngle)	Initializes this struct with the specified values.
XrCompositionLayerEquirect2KHR	set(XrCompositionLayerEquirect2KHR src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace in which the pose of the equirect layer is evaluated over time.
XrCompositionLayerEquirect2KHR	space(XrSpace value)	Sets the specified value to the space() field.
XrSwapchainSubImage	subImage()	identifies the image XrSwapchainSubImage to use.
XrCompositionLayerEquirect2KHR	subImage(Consumer<XrSwapchainSubImage> consumer)	Passes the subImage() field to the specified Consumer.
XrCompositionLayerEquirect2KHR	subImage(XrSwapchainSubImage value)	Copies the specified XrSwapchainSubImage to the subImage() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerEquirect2KHR	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerEquirect2KHR	type$Default()	Sets the TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR value to the type() field.
float	upperVerticalAngle()	defines the upper vertical angle of the visible portion of the sphere, in the range of [-π/2, π/2].
XrCompositionLayerEquirect2KHR	upperVerticalAngle(float value)	Sets the specified value to the upperVerticalAngle() 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.

LAYERFLAGS

public static final int LAYERFLAGS

The struct member offsets.

SPACE

public static final int SPACE

The struct member offsets.

EYEVISIBILITY

public static final int EYEVISIBILITY

The struct member offsets.

SUBIMAGE

public static final int SUBIMAGE

The struct member offsets.

POSE

public static final int POSE

The struct member offsets.

RADIUS

public static final int RADIUS

The struct member offsets.

CENTRALHORIZONTALANGLE

public static final int CENTRALHORIZONTALANGLE

The struct member offsets.

UPPERVERTICALANGLE

public static final int UPPERVERTICALANGLE

The struct member offsets.

LOWERVERTICALANGLE

public static final int LOWERVERTICALANGLE

The struct member offsets.

Constructor Details

XrCompositionLayerEquirect2KHR

public XrCompositionLayerEquirect2KHR(ByteBuffer container)

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

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.

layerFlags

public long layerFlags()

specifies options for the layer.

space

public long space()

the XrSpace in which the pose of the equirect layer is evaluated over time.

eyeVisibility

public int eyeVisibility()

the eye represented by this layer.

subImage

public XrSwapchainSubImage subImage()

identifies the image XrSwapchainSubImage to use. The swapchain must have been created with a XrSwapchainCreateInfo::faceCount of 1.

pose

public XrPosef pose()

an XrPosef defining the position and orientation of the center point of the sphere onto which the equirect image data is mapped, relative to the reference frame of the space.

radius

public float radius()

the non-negative radius of the sphere onto which the equirect image data is mapped. Values of zero or floating point positive infinity are treated as an infinite sphere.

centralHorizontalAngle

public float centralHorizontalAngle()

defines the visible horizontal angle of the sphere, based at 0 radians, in the range of [0, 2π]. It grows symmetrically around the 0 radian angle.

upperVerticalAngle

public float upperVerticalAngle()

defines the upper vertical angle of the visible portion of the sphere, in the range of [-π/2, π/2].

lowerVerticalAngle

public float lowerVerticalAngle()

defines the lower vertical angle of the visible portion of the sphere, in the range of [-π/2, π/2].

type

public XrCompositionLayerEquirect2KHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerEquirect2KHR type$Default()

Sets the TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR value to the type() field.

next

public XrCompositionLayerEquirect2KHR next(long value)

Sets the specified value to the next() field.

layerFlags

public XrCompositionLayerEquirect2KHR layerFlags(long value)

Sets the specified value to the layerFlags() field.

space

public XrCompositionLayerEquirect2KHR space(XrSpace value)

Sets the specified value to the space() field.

eyeVisibility

public XrCompositionLayerEquirect2KHR eyeVisibility(int value)

Sets the specified value to the eyeVisibility() field.

subImage

public XrCompositionLayerEquirect2KHR subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the subImage() field.

subImage

public XrCompositionLayerEquirect2KHR subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the subImage() field to the specified Consumer.

pose

public XrCompositionLayerEquirect2KHR pose(XrPosef value)

Copies the specified XrPosef to the pose() field.

pose

public XrCompositionLayerEquirect2KHR pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

radius

public XrCompositionLayerEquirect2KHR radius(float value)

Sets the specified value to the radius() field.

centralHorizontalAngle

public XrCompositionLayerEquirect2KHR centralHorizontalAngle(float value)

Sets the specified value to the centralHorizontalAngle() field.

upperVerticalAngle

public XrCompositionLayerEquirect2KHR upperVerticalAngle(float value)

Sets the specified value to the upperVerticalAngle() field.

lowerVerticalAngle

public XrCompositionLayerEquirect2KHR lowerVerticalAngle(float value)

Sets the specified value to the lowerVerticalAngle() field.

set

public XrCompositionLayerEquirect2KHR set(int type,
 long next,
 long layerFlags,
 XrSpace space,
 int eyeVisibility,
 XrSwapchainSubImage subImage,
 XrPosef pose,
 float radius,
 float centralHorizontalAngle,
 float upperVerticalAngle,
 float lowerVerticalAngle)

Initializes this struct with the specified values.

set

public XrCompositionLayerEquirect2KHR set(XrCompositionLayerEquirect2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerEquirect2KHR malloc()

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

calloc

public static XrCompositionLayerEquirect2KHR calloc()

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

create

public static XrCompositionLayerEquirect2KHR create()

Returns a new XrCompositionLayerEquirect2KHR instance allocated with BufferUtils.

create

public static XrCompositionLayerEquirect2KHR create(long address)

Returns a new XrCompositionLayerEquirect2KHR instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerEquirect2KHR createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerEquirect2KHR create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerEquirect2KHR.

malloc

public static XrCompositionLayerEquirect2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerEquirect2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerEquirect2KHR.Buffer create(int capacity)

Returns a new XrCompositionLayerEquirect2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerEquirect2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerEquirect2KHR.Buffer create(XrCompositionLayerBaseHeader.Buffer value)

Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerEquirect2KHR.Buffer.

malloc

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

Returns a new XrCompositionLayerEquirect2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlayerFlags

public static long nlayerFlags(long struct)

Unsafe version of layerFlags().

nspace

public static long nspace(long struct)

Unsafe version of space().

neyeVisibility

public static int neyeVisibility(long struct)

Unsafe version of eyeVisibility().

nsubImage

public static XrSwapchainSubImage nsubImage(long struct)

Unsafe version of subImage().

npose

public static XrPosef npose(long struct)

Unsafe version of pose().

nradius

public static float nradius(long struct)

Unsafe version of radius().

ncentralHorizontalAngle

public static float ncentralHorizontalAngle(long struct)

Unsafe version of centralHorizontalAngle().

nupperVerticalAngle

public static float nupperVerticalAngle(long struct)

Unsafe version of upperVerticalAngle().

nlowerVerticalAngle

public static float nlowerVerticalAngle(long struct)

Unsafe version of lowerVerticalAngle().

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.

nlayerFlags

public static void nlayerFlags(long struct,
 long value)

Unsafe version of layerFlags.

nspace

public static void nspace(long struct,
 XrSpace value)

Unsafe version of space.

neyeVisibility

public static void neyeVisibility(long struct,
 int value)

Unsafe version of eyeVisibility.

nsubImage

public static void nsubImage(long struct,
 XrSwapchainSubImage value)

Unsafe version of subImage.

npose

public static void npose(long struct,
 XrPosef value)

Unsafe version of pose.

nradius

public static void nradius(long struct,
 float value)

Unsafe version of radius.

ncentralHorizontalAngle

public static void ncentralHorizontalAngle(long struct,
 float value)

Unsafe version of centralHorizontalAngle.

nupperVerticalAngle

public static void nupperVerticalAngle(long struct,
 float value)

Unsafe version of upperVerticalAngle.

nlowerVerticalAngle

public static void nlowerVerticalAngle(long struct,
 float value)

Unsafe version of lowerVerticalAngle.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate