LWJGL 3.3.3 · org.lwjgl.openxr.XrCompositionLayerCylinderKHR

Cylindrical layer composition info.

Description

XrCompositionLayerCylinderKHR contains the information needed to render a texture onto a cylinder when calling EndFrame. XrCompositionLayerCylinderKHR is an alias type for the base struct XrCompositionLayerBaseHeader used in XrFrameEndInfo.

Valid Usage (Implicit)

The XR_KHR_composition_layer_cylinder extension must be enabled prior to using XrCompositionLayerCylinderKHR
type must be TYPE_COMPOSITION_LAYER_CYLINDER_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 XrCompositionLayerCylinderKHR {
    XrStructureType type;
    void const * next;
    XrCompositionLayerFlags layerFlags;
    XrSpace space;
    XrEyeVisibility eyeVisibility;
    XrSwapchainSubImage subImage;
    XrPosef pose;
    float radius;
    float centralAngle;
    float aspectRatio;
}

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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ASPECTRATIO The struct member offsets.
public static final int	CENTRALANGLE 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	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.

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

Method Summary

Modifier and Type	Method and Description
public float	aspectRatio() the ratio of the visible cylinder section `width / height`.
public XrCompositionLayerCylinderKHR	aspectRatio(float value) Sets the specified value to the `aspectRatio` field.
public static XrCompositionLayerCylinderKHR	calloc() Returns a new `XrCompositionLayerCylinderKHR` instance allocated with `memCalloc`.
public static XrCompositionLayerCylinderKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrCompositionLayerCylinderKHR.Buffer` instance allocated with `memCalloc`.
public static XrCompositionLayerCylinderKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerCylinderKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrCompositionLayerCylinderKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerCylinderKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public float	centralAngle() the angle of the visible section of the cylinder, based at 0 radians, in the range of `[0, 2π)`.
public XrCompositionLayerCylinderKHR	centralAngle(float value) Sets the specified value to the `centralAngle` field.
protected XrCompositionLayerCylinderKHR	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 XrCompositionLayerCylinderKHR	create() Returns a new `XrCompositionLayerCylinderKHR` instance allocated with `BufferUtils`.
public static XrCompositionLayerCylinderKHR	create(long address) Returns a new `XrCompositionLayerCylinderKHR` instance for the specified memory address.
public static XrCompositionLayerCylinderKHR	create(XrCompositionLayerBaseHeader value) Downcasts the specified `XrCompositionLayerBaseHeader` instance to `XrCompositionLayerCylinderKHR`.
public static XrCompositionLayerCylinderKHR.Buffer	create(int the buffer capacity capacity) Returns a new `XrCompositionLayerCylinderKHR.Buffer` instance allocated with `BufferUtils`.
public static XrCompositionLayerCylinderKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrCompositionLayerCylinderKHR.Buffer` instance at the specified memory.
public static XrCompositionLayerCylinderKHR.Buffer	create(XrCompositionLayerBaseHeader.Buffer value) Downcasts the specified `XrCompositionLayerBaseHeader.Buffer` instance to `XrCompositionLayerCylinderKHR.Buffer`.
public static XrCompositionLayerCylinderKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrCompositionLayerCylinderKHR.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 XrCompositionLayerCylinderKHR	eyeVisibility(int value) Sets the specified value to the `eyeVisibility` field.
public long	layerFlags() specifies options for the layer.
public XrCompositionLayerCylinderKHR	layerFlags(long value) Sets the specified value to the `layerFlags` field.
public static XrCompositionLayerCylinderKHR	malloc() Returns a new `XrCompositionLayerCylinderKHR` instance allocated with `memAlloc`.
public static XrCompositionLayerCylinderKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrCompositionLayerCylinderKHR.Buffer` instance allocated with `memAlloc`.
public static XrCompositionLayerCylinderKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerCylinderKHR` instance allocated on the specified `MemoryStack`.
public static XrCompositionLayerCylinderKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerCylinderKHR.Buffer` instance allocated on the specified `MemoryStack`.
public static float	naspectRatio(long struct) Unsafe version of `aspectRatio`.
public static void	naspectRatio(long struct, float value) Unsafe version of `aspectRatio`.
public static float	ncentralAngle(long struct) Unsafe version of `centralAngle`.
public static void	ncentralAngle(long struct, float value) Unsafe version of `centralAngle`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrCompositionLayerCylinderKHR	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 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 XrPosef	pose() an `XrPosef` defining the position and orientation of the center point of the view of the cylinder within the reference frame of the `space`.
public XrCompositionLayerCylinderKHR	pose(XrPosef value) Copies the specified `XrPosef` to the `pose` field.
public XrCompositionLayerCylinderKHR	pose(Consumer<XrPosef> consumer) Passes the `pose` field to the specified `Consumer`.
public float	radius() the non-negative radius of the cylinder.
public XrCompositionLayerCylinderKHR	radius(float value) Sets the specified value to the `radius` field.
public XrCompositionLayerCylinderKHR	set(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchainSubImage subImage, XrPosef pose, float radius, float centralAngle, float aspectRatio) Initializes this struct with the specified values.
public XrCompositionLayerCylinderKHR	Returns: this struct set(XrCompositionLayerCylinderKHR 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 cylinder layer is evaluated over time.
public XrCompositionLayerCylinderKHR	space(XrSpace value) Sets the specified value to the `space` field.
public XrSwapchainSubImage	subImage() identifies the image `XrSwapchainSubImage` to use.
public XrCompositionLayerCylinderKHR	subImage(XrSwapchainSubImage value) Copies the specified `XrSwapchainSubImage` to the `subImage` field.
public XrCompositionLayerCylinderKHR	subImage(Consumer<XrSwapchainSubImage> consumer) Passes the `subImage` field to the specified `Consumer`.
public int	type() the `XrStructureType` of this structure.
public XrCompositionLayerCylinderKHR	type(int value) Sets the specified value to the `type` field.
public XrCompositionLayerCylinderKHR	type$Default() Sets the `TYPE_COMPOSITION_LAYER_CYLINDER_KHR` value to the `type` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

public Class XrCompositionLayerCylinderKHR

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary