java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerCylinderKHR>

org.lwjgl.openxr.XrCompositionLayerCylinderKHR

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

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

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

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

XrCompositionLayerCylinderKHR.Buffer

An array of XrCompositionLayerCylinderKHR 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

ASPECTRATIO

The struct member offsets.

static final int

CENTRALANGLE

The struct member offsets.

static final int

EYEVISIBILITY

The struct member offsets.

static final int

LAYERFLAGS

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.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

XrCompositionLayerCylinderKHR(ByteBuffer container)

Creates a XrCompositionLayerCylinderKHR instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

float

aspectRatio()

the ratio of the visible cylinder section width / height.

XrCompositionLayerCylinderKHR

aspectRatio(float value)

Sets the specified value to the aspectRatio() field.

static XrCompositionLayerCylinderKHR

calloc()

Returns a new XrCompositionLayerCylinderKHR instance allocated with memCalloc.

static XrCompositionLayerCylinderKHR.Buffer

calloc(int capacity)

Returns a new XrCompositionLayerCylinderKHR.Buffer instance allocated with memCalloc.

static XrCompositionLayerCylinderKHR.Buffer

calloc(int capacity, org.lwjgl.system.MemoryStack stack)

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

static XrCompositionLayerCylinderKHR

calloc(org.lwjgl.system.MemoryStack stack)

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

float

centralAngle()

the angle of the visible section of the cylinder, based at 0 radians, in the range of [0, 2π).

XrCompositionLayerCylinderKHR

centralAngle(float value)

Sets the specified value to the centralAngle() field.

static XrCompositionLayerCylinderKHR

create()

Returns a new XrCompositionLayerCylinderKHR instance allocated with BufferUtils.

static XrCompositionLayerCylinderKHR.Buffer

create(int capacity)

Returns a new XrCompositionLayerCylinderKHR.Buffer instance allocated with BufferUtils.

static XrCompositionLayerCylinderKHR

create(long address)

Returns a new XrCompositionLayerCylinderKHR instance for the specified memory address.

static XrCompositionLayerCylinderKHR.Buffer

create(long address, int capacity)

Create a XrCompositionLayerCylinderKHR.Buffer instance at the specified memory.

static XrCompositionLayerCylinderKHR

create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerCylinderKHR.

static XrCompositionLayerCylinderKHR.Buffer

create(XrCompositionLayerBaseHeader.Buffer value)

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

static @Nullable XrCompositionLayerCylinderKHR

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable XrCompositionLayerCylinderKHR.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

eyeVisibility()

the eye represented by this layer.

XrCompositionLayerCylinderKHR

eyeVisibility(int value)

Sets the specified value to the eyeVisibility() field.

long

layerFlags()

specifies options for the layer.

XrCompositionLayerCylinderKHR

layerFlags(long value)

Sets the specified value to the layerFlags() field.

static XrCompositionLayerCylinderKHR

malloc()

Returns a new XrCompositionLayerCylinderKHR instance allocated with memAlloc.

static XrCompositionLayerCylinderKHR.Buffer

malloc(int capacity)

Returns a new XrCompositionLayerCylinderKHR.Buffer instance allocated with memAlloc.

static XrCompositionLayerCylinderKHR.Buffer

malloc(int capacity, org.lwjgl.system.MemoryStack stack)

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

static XrCompositionLayerCylinderKHR

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrCompositionLayerCylinderKHR instance allocated on the specified MemoryStack.

static float

naspectRatio(long struct)

Unsafe version of aspectRatio().

static void

naspectRatio(long struct, float value)

Unsafe version of aspectRatio.

static float

ncentralAngle(long struct)

Unsafe version of centralAngle().

static void

ncentralAngle(long struct, float value)

Unsafe version of centralAngle.

long

next()

NULL or a pointer to the next structure in a structure chain.

XrCompositionLayerCylinderKHR

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 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.

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.

XrCompositionLayerCylinderKHR

pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

XrCompositionLayerCylinderKHR

pose(XrPosef value)

Copies the specified XrPosef to the pose() field.

float

radius()

the non-negative radius of the cylinder.

XrCompositionLayerCylinderKHR

radius(float value)

Sets the specified value to the radius() field.

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.

XrCompositionLayerCylinderKHR

set(XrCompositionLayerCylinderKHR src)

Copies the specified struct data to this struct.

int

sizeof()

long

space()

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

XrCompositionLayerCylinderKHR

space(XrSpace value)

Sets the specified value to the space() field.

XrSwapchainSubImage

subImage()

identifies the image XrSwapchainSubImage to use.

XrCompositionLayerCylinderKHR

subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the subImage() field to the specified Consumer.

XrCompositionLayerCylinderKHR

subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the subImage() field.

int

type()

the XrStructureType of this structure.

XrCompositionLayerCylinderKHR

type(int value)

Sets the specified value to the type() field.

XrCompositionLayerCylinderKHR

type$Default()

Sets the TYPE_COMPOSITION_LAYER_CYLINDER_KHR 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.
- 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.
- CENTRALANGLE
  
  public static final int CENTRALANGLE
  
  The struct member offsets.
- ASPECTRATIO
  
  public static final int ASPECTRATIO
  
  The struct member offsets.
Constructor Details
- XrCompositionLayerCylinderKHR
  
  public XrCompositionLayerCylinderKHR(ByteBuffer container)
  
  Creates a XrCompositionLayerCylinderKHR 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<XrCompositionLayerCylinderKHR>
- 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 cylinder 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 view of the cylinder within the reference frame of the space.
- radius
  
  public float radius()
  
  the non-negative radius of the cylinder. Values of zero or floating point positive infinity are treated as an infinite cylinder.
- centralAngle
  
  public float centralAngle()
  
  the angle of the visible section of the cylinder, based at 0 radians, in the range of [0, 2π). It grows symmetrically around the 0 radian angle.
- aspectRatio
  
  public float aspectRatio()
  
  the ratio of the visible cylinder section width / height. The height of the cylinder is given by: (cylinder radius × cylinder angle) / aspectRatio.
- type
  
  public XrCompositionLayerCylinderKHR type(int value)
  
  Sets the specified value to the type() field.
- type$Default
  
  public XrCompositionLayerCylinderKHR type$Default()
  
  Sets the TYPE_COMPOSITION_LAYER_CYLINDER_KHR value to the type() field.
- next
  
  public XrCompositionLayerCylinderKHR next(long value)
  
  Sets the specified value to the next() field.
- layerFlags
  
  public XrCompositionLayerCylinderKHR layerFlags(long value)
  
  Sets the specified value to the layerFlags() field.
- space
  
  public XrCompositionLayerCylinderKHR space(XrSpace value)
  
  Sets the specified value to the space() field.
- eyeVisibility
  
  public XrCompositionLayerCylinderKHR eyeVisibility(int value)
  
  Sets the specified value to the eyeVisibility() field.
- subImage
  
  public XrCompositionLayerCylinderKHR subImage(XrSwapchainSubImage value)
  
  Copies the specified XrSwapchainSubImage to the subImage() field.
- subImage
  
  public XrCompositionLayerCylinderKHR subImage(Consumer<XrSwapchainSubImage> consumer)
  
  Passes the subImage() field to the specified Consumer.
- pose
  
  public XrCompositionLayerCylinderKHR pose(XrPosef value)
  
  Copies the specified XrPosef to the pose() field.
- pose
  
  public XrCompositionLayerCylinderKHR pose(Consumer<XrPosef> consumer)
  
  Passes the pose() field to the specified Consumer.
- radius
  
  public XrCompositionLayerCylinderKHR radius(float value)
  
  Sets the specified value to the radius() field.
- centralAngle
  
  public XrCompositionLayerCylinderKHR centralAngle(float value)
  
  Sets the specified value to the centralAngle() field.
- aspectRatio
  
  public XrCompositionLayerCylinderKHR aspectRatio(float value)
  
  Sets the specified value to the aspectRatio() field.
- set
  
  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.
- set
  
  public XrCompositionLayerCylinderKHR set(XrCompositionLayerCylinderKHR src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static XrCompositionLayerCylinderKHR malloc()
  
  Returns a new XrCompositionLayerCylinderKHR instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static XrCompositionLayerCylinderKHR calloc()
  
  Returns a new XrCompositionLayerCylinderKHR instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static XrCompositionLayerCylinderKHR create()
  
  Returns a new XrCompositionLayerCylinderKHR instance allocated with BufferUtils.
- create
  
  public static XrCompositionLayerCylinderKHR create(long address)
  
  Returns a new XrCompositionLayerCylinderKHR instance for the specified memory address.
- createSafe
  
  public static @Nullable XrCompositionLayerCylinderKHR createSafe(long address)
  
  Like create, but returns null if address is NULL.
- create
  
  public static XrCompositionLayerCylinderKHR create(XrCompositionLayerBaseHeader value)
  
  Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerCylinderKHR.
- malloc
  
  public static XrCompositionLayerCylinderKHR.Buffer malloc(int capacity)
  
  Returns a new XrCompositionLayerCylinderKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static XrCompositionLayerCylinderKHR.Buffer calloc(int capacity)
  
  Returns a new XrCompositionLayerCylinderKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static XrCompositionLayerCylinderKHR.Buffer create(int capacity)
  
  Returns a new XrCompositionLayerCylinderKHR.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static XrCompositionLayerCylinderKHR.Buffer create(long address, int capacity)
  
  Create a XrCompositionLayerCylinderKHR.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable XrCompositionLayerCylinderKHR.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- create
  
  public static XrCompositionLayerCylinderKHR.Buffer create(XrCompositionLayerBaseHeader.Buffer value)
  
  Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerCylinderKHR.Buffer.
- malloc
  
  public static XrCompositionLayerCylinderKHR malloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerCylinderKHR instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static XrCompositionLayerCylinderKHR calloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerCylinderKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static XrCompositionLayerCylinderKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerCylinderKHR.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static XrCompositionLayerCylinderKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerCylinderKHR.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().
- ncentralAngle
  
  public static float ncentralAngle(long struct)
  
  Unsafe version of centralAngle().
- naspectRatio
  
  public static float naspectRatio(long struct)
  
  Unsafe version of aspectRatio().
- 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.
- ncentralAngle
  
  public static void ncentralAngle(long struct, float value)
  
  Unsafe version of centralAngle.
- naspectRatio
  
  public static void naspectRatio(long struct, float value)
  
  Unsafe version of aspectRatio.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class XrCompositionLayerCylinderKHR

Description

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

TYPE

NEXT

LAYERFLAGS

SPACE

EYEVISIBILITY

SUBIMAGE

POSE

RADIUS

CENTRALANGLE

ASPECTRATIO

Constructor Details

XrCompositionLayerCylinderKHR

Method Details

sizeof

type

next

layerFlags

space

eyeVisibility

subImage

pose

radius

centralAngle

aspectRatio

type

type$Default

next

layerFlags

space

eyeVisibility

subImage

subImage

pose

pose

radius

centralAngle

aspectRatio

set

set

malloc

calloc

create

create

createSafe

create

malloc

calloc

create

create

createSafe

create

malloc

calloc

malloc

calloc

ntype

nnext

nlayerFlags

nspace

neyeVisibility

nsubImage