LWJGL 3.3.3 · org.lwjgl.openxr.XrCompositionLayerEquirect2KHR

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

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;
}

Modifier and Type	Class and Description
public static class	XrCompositionLayerEquirect2KHR.Buffer An array of `XrCompositionLayerEquirect2KHR` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	CENTRALHORIZONTALANGLE The struct member offsets.
public static final int	EYEVISIBILITY The struct member offsets.
public static final int	LAYERFLAGS The struct member offsets.
public static final int	LOWERVERTICALANGLE The struct member offsets.
public static final int	NEXT The struct member offsets.
public static final int	POSE The struct member offsets.
public static final int	RADIUS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SPACE The struct member offsets.
public static final int	SUBIMAGE The struct member offsets.
public static final int	TYPE The struct member offsets.
public static final int	UPPERVERTICALANGLE The struct member offsets.

Access	Constructor and Description
protected	XrCompositionLayerEquirect2KHR(long address, ByteBuffer container)
public	XrCompositionLayerEquirect2KHR(ByteBuffer container) Creates a `XrCompositionLayerEquirect2KHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrCompositionLayerEquirect2KHR	calloc() Returns a new `XrCompositionLayerEquirect2KHR` instance allocated with `memCalloc`.
public static XrCompositionLayerEquirect2KHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrCompositionLayerEquirect2KHR.Buffer` instance allocated with `memCalloc`.
public static XrCompositionLayerEquirect2KHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerEquirect2KHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrCompositionLayerEquirect2KHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerEquirect2KHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public float	centralHorizontalAngle() defines the visible horizontal angle of the sphere, based at 0 radians, in the range of `[0, 2π]`.
public XrCompositionLayerEquirect2KHR	centralHorizontalAngle(float value) Sets the specified value to the `centralHorizontalAngle` field.
protected XrCompositionLayerEquirect2KHR	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static XrCompositionLayerEquirect2KHR	create() Returns a new `XrCompositionLayerEquirect2KHR` instance allocated with `BufferUtils`.
public static XrCompositionLayerEquirect2KHR	create(long address) Returns a new `XrCompositionLayerEquirect2KHR` instance for the specified memory address.
public static XrCompositionLayerEquirect2KHR	create(XrCompositionLayerBaseHeader value) Downcasts the specified `XrCompositionLayerBaseHeader` instance to `XrCompositionLayerEquirect2KHR`.
public static XrCompositionLayerEquirect2KHR.Buffer	create(int the buffer capacity capacity) Returns a new `XrCompositionLayerEquirect2KHR.Buffer` instance allocated with `BufferUtils`.
public static XrCompositionLayerEquirect2KHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrCompositionLayerEquirect2KHR.Buffer` instance at the specified memory.
public static XrCompositionLayerEquirect2KHR.Buffer	create(XrCompositionLayerBaseHeader.Buffer value) Downcasts the specified `XrCompositionLayerBaseHeader.Buffer` instance to `XrCompositionLayerEquirect2KHR.Buffer`.
public static XrCompositionLayerEquirect2KHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrCompositionLayerEquirect2KHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	eyeVisibility() the eye represented by this layer.
public XrCompositionLayerEquirect2KHR	eyeVisibility(int value) Sets the specified value to the `eyeVisibility` field.
public long	layerFlags() specifies options for the layer.
public XrCompositionLayerEquirect2KHR	layerFlags(long value) Sets the specified value to the `layerFlags` field.
public float	lowerVerticalAngle() defines the lower vertical angle of the visible portion of the sphere, in the range of `[-π/2, π/2]`.
public XrCompositionLayerEquirect2KHR	lowerVerticalAngle(float value) Sets the specified value to the `lowerVerticalAngle` field.
public static XrCompositionLayerEquirect2KHR	malloc() Returns a new `XrCompositionLayerEquirect2KHR` instance allocated with `memAlloc`.
public static XrCompositionLayerEquirect2KHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrCompositionLayerEquirect2KHR.Buffer` instance allocated with `memAlloc`.
public static XrCompositionLayerEquirect2KHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerEquirect2KHR` instance allocated on the specified `MemoryStack`.
public static XrCompositionLayerEquirect2KHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerEquirect2KHR.Buffer` instance allocated on the specified `MemoryStack`.
public static float	ncentralHorizontalAngle(long struct) Unsafe version of `centralHorizontalAngle`.
public static void	ncentralHorizontalAngle(long struct, float value) Unsafe version of `centralHorizontalAngle`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrCompositionLayerEquirect2KHR	next(long value) Sets the specified value to the `next` field.
public static int	neyeVisibility(long struct) Unsafe version of `eyeVisibility`.
public static void	neyeVisibility(long struct, int value) Unsafe version of `eyeVisibility`.
public static long	nlayerFlags(long struct) Unsafe version of `layerFlags`.
public static void	nlayerFlags(long struct, long value) Unsafe version of `layerFlags`.
public static float	nlowerVerticalAngle(long struct) Unsafe version of `lowerVerticalAngle`.
public static void	nlowerVerticalAngle(long struct, float value) Unsafe version of `lowerVerticalAngle`.
public static long	nnext(long struct) Unsafe version of `next`.
public static void	nnext(long struct, long value) Unsafe version of `next`.
public static XrPosef	npose(long struct) Unsafe version of `pose`.
public static void	npose(long struct, XrPosef value) Unsafe version of `pose`.
public static float	nradius(long struct) Unsafe version of `radius`.
public static void	nradius(long struct, float value) Unsafe version of `radius`.
public static long	nspace(long struct) Unsafe version of `space`.
public static void	nspace(long struct, XrSpace value) Unsafe version of `space`.
public static XrSwapchainSubImage	nsubImage(long struct) Unsafe version of `subImage`.
public static void	nsubImage(long struct, XrSwapchainSubImage value) Unsafe version of `subImage`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public static float	nupperVerticalAngle(long struct) Unsafe version of `upperVerticalAngle`.
public static void	nupperVerticalAngle(long struct, float value) Unsafe version of `upperVerticalAngle`.
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`.
public XrCompositionLayerEquirect2KHR	pose(XrPosef value) Copies the specified `XrPosef` to the `pose` field.
public XrCompositionLayerEquirect2KHR	pose(Consumer<XrPosef> consumer) Passes the `pose` field to the specified `Consumer`.
public float	radius() the non-negative radius of the sphere onto which the equirect image data is mapped.
public XrCompositionLayerEquirect2KHR	radius(float value) Sets the specified value to the `radius` field.
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.
public XrCompositionLayerEquirect2KHR	Returns: this struct set(XrCompositionLayerEquirect2KHR the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public long	space() the `XrSpace` in which the `pose` of the equirect layer is evaluated over time.
public XrCompositionLayerEquirect2KHR	space(XrSpace value) Sets the specified value to the `space` field.
public XrSwapchainSubImage	subImage() identifies the image `XrSwapchainSubImage` to use.
public XrCompositionLayerEquirect2KHR	subImage(XrSwapchainSubImage value) Copies the specified `XrSwapchainSubImage` to the `subImage` field.
public XrCompositionLayerEquirect2KHR	subImage(Consumer<XrSwapchainSubImage> consumer) Passes the `subImage` field to the specified `Consumer`.
public int	type() the `XrStructureType` of this structure.
public XrCompositionLayerEquirect2KHR	type(int value) Sets the specified value to the `type` field.
public XrCompositionLayerEquirect2KHR	type$Default() Sets the `TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR` value to the `type` field.
public float	upperVerticalAngle() defines the upper vertical angle of the visible portion of the sphere, in the range of `[-π/2, π/2]`.
public XrCompositionLayerEquirect2KHR	upperVerticalAngle(float value) Sets the specified value to the `upperVerticalAngle` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

public Class XrCompositionLayerEquirect2KHR

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary