java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerEquirectKHR>

org.lwjgl.openxr.XrCompositionLayerEquirectKHR

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

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

Equirectangular layer composition info.

Description

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

Valid Usage (Implicit)

The XR_KHR_composition_layer_equirect extension must be enabled prior to using XrCompositionLayerEquirectKHR
type must be TYPE_COMPOSITION_LAYER_EQUIRECT_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 XrCompositionLayerEquirectKHR {
     XrStructureType type();
     void const * next();
     XrCompositionLayerFlags layerFlags();
     XrSpace space();
     XrEyeVisibility eyeVisibility();
     XrSwapchainSubImage subImage();
     XrPosef pose();
     float radius();
     XrVector2f scale();
     XrVector2f bias();
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

XrCompositionLayerEquirectKHR.Buffer

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

BIAS

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

SCALE

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

XrCompositionLayerEquirectKHR(ByteBuffer container)

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

Modifier and Type

Method

Description

XrVector2f

bias()

an XrVector2f indicating a bias of the texture coordinates after the mapping to 2D.

XrCompositionLayerEquirectKHR

bias(Consumer<XrVector2f> consumer)

Passes the bias() field to the specified Consumer.

XrCompositionLayerEquirectKHR

bias(XrVector2f value)

Copies the specified XrVector2f to the bias() field.

static XrCompositionLayerEquirectKHR

calloc()

Returns a new XrCompositionLayerEquirectKHR instance allocated with memCalloc.

static XrCompositionLayerEquirectKHR.Buffer

calloc(int capacity)

Returns a new XrCompositionLayerEquirectKHR.Buffer instance allocated with memCalloc.

static XrCompositionLayerEquirectKHR.Buffer

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

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

static XrCompositionLayerEquirectKHR

calloc(org.lwjgl.system.MemoryStack stack)

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

static XrCompositionLayerEquirectKHR

create()

Returns a new XrCompositionLayerEquirectKHR instance allocated with BufferUtils.

static XrCompositionLayerEquirectKHR.Buffer

create(int capacity)

Returns a new XrCompositionLayerEquirectKHR.Buffer instance allocated with BufferUtils.

static XrCompositionLayerEquirectKHR

create(long address)

Returns a new XrCompositionLayerEquirectKHR instance for the specified memory address.

static XrCompositionLayerEquirectKHR.Buffer

create(long address, int capacity)

Create a XrCompositionLayerEquirectKHR.Buffer instance at the specified memory.

static XrCompositionLayerEquirectKHR

create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerEquirectKHR.

static XrCompositionLayerEquirectKHR.Buffer

create(XrCompositionLayerBaseHeader.Buffer value)

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

static @Nullable XrCompositionLayerEquirectKHR

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable XrCompositionLayerEquirectKHR.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

eyeVisibility()

the eye represented by this layer.

XrCompositionLayerEquirectKHR

eyeVisibility(int value)

Sets the specified value to the eyeVisibility() field.

long

layerFlags()

specifies options for the layer.

XrCompositionLayerEquirectKHR

layerFlags(long value)

Sets the specified value to the layerFlags() field.

static XrCompositionLayerEquirectKHR

malloc()

Returns a new XrCompositionLayerEquirectKHR instance allocated with memAlloc.

static XrCompositionLayerEquirectKHR.Buffer

malloc(int capacity)

Returns a new XrCompositionLayerEquirectKHR.Buffer instance allocated with memAlloc.

static XrCompositionLayerEquirectKHR.Buffer

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

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

static XrCompositionLayerEquirectKHR

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrCompositionLayerEquirectKHR instance allocated on the specified MemoryStack.

static XrVector2f

nbias(long struct)

Unsafe version of bias().

static void

nbias(long struct, XrVector2f value)

Unsafe version of bias.

long

next()

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

XrCompositionLayerEquirectKHR

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 XrVector2f

nscale(long struct)

Unsafe version of scale().

static void

nscale(long struct, XrVector2f value)

Unsafe version of scale.

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 sphere onto which the equirect image data is mapped, relative to the reference frame of the space.

XrCompositionLayerEquirectKHR

pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

XrCompositionLayerEquirectKHR

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.

XrCompositionLayerEquirectKHR

radius(float value)

Sets the specified value to the radius() field.

XrVector2f

scale()

an XrVector2f indicating a scale of the texture coordinates after the mapping to 2D.

XrCompositionLayerEquirectKHR

scale(Consumer<XrVector2f> consumer)

Passes the scale() field to the specified Consumer.

XrCompositionLayerEquirectKHR

scale(XrVector2f value)

Copies the specified XrVector2f to the scale() field.

XrCompositionLayerEquirectKHR

set(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchainSubImage subImage, XrPosef pose, float radius, XrVector2f scale, XrVector2f bias)

Initializes this struct with the specified values.

XrCompositionLayerEquirectKHR

set(XrCompositionLayerEquirectKHR 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.

XrCompositionLayerEquirectKHR

space(XrSpace value)

Sets the specified value to the space() field.

XrSwapchainSubImage

subImage()

identifies the image XrSwapchainSubImage to use.

XrCompositionLayerEquirectKHR

subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the subImage() field to the specified Consumer.

XrCompositionLayerEquirectKHR

subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the subImage() field.

int

type()

the XrStructureType of this structure.

XrCompositionLayerEquirectKHR

type(int value)

Sets the specified value to the type() field.

XrCompositionLayerEquirectKHR

type$Default()

Sets the TYPE_COMPOSITION_LAYER_EQUIRECT_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.
- SCALE
  
  public static final int SCALE
  
  The struct member offsets.
- BIAS
  
  public static final int BIAS
  
  The struct member offsets.
Constructor Details
- XrCompositionLayerEquirectKHR
  
  public XrCompositionLayerEquirectKHR(ByteBuffer container)
  
  Creates a XrCompositionLayerEquirectKHR 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<XrCompositionLayerEquirectKHR>
- 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.
- scale
  
  public XrVector2f scale()
  
  an XrVector2f indicating a scale of the texture coordinates after the mapping to 2D.
- bias
  
  public XrVector2f bias()
  
  an XrVector2f indicating a bias of the texture coordinates after the mapping to 2D.
- type
  
  public XrCompositionLayerEquirectKHR type(int value)
  
  Sets the specified value to the type() field.
- type$Default
  
  public XrCompositionLayerEquirectKHR type$Default()
  
  Sets the TYPE_COMPOSITION_LAYER_EQUIRECT_KHR value to the type() field.
- next
  
  public XrCompositionLayerEquirectKHR next(long value)
  
  Sets the specified value to the next() field.
- layerFlags
  
  public XrCompositionLayerEquirectKHR layerFlags(long value)
  
  Sets the specified value to the layerFlags() field.
- space
  
  public XrCompositionLayerEquirectKHR space(XrSpace value)
  
  Sets the specified value to the space() field.
- eyeVisibility
  
  public XrCompositionLayerEquirectKHR eyeVisibility(int value)
  
  Sets the specified value to the eyeVisibility() field.
- subImage
  
  public XrCompositionLayerEquirectKHR subImage(XrSwapchainSubImage value)
  
  Copies the specified XrSwapchainSubImage to the subImage() field.
- subImage
  
  public XrCompositionLayerEquirectKHR subImage(Consumer<XrSwapchainSubImage> consumer)
  
  Passes the subImage() field to the specified Consumer.
- pose
  
  public XrCompositionLayerEquirectKHR pose(XrPosef value)
  
  Copies the specified XrPosef to the pose() field.
- pose
  
  public XrCompositionLayerEquirectKHR pose(Consumer<XrPosef> consumer)
  
  Passes the pose() field to the specified Consumer.
- radius
  
  public XrCompositionLayerEquirectKHR radius(float value)
  
  Sets the specified value to the radius() field.
- scale
  
  public XrCompositionLayerEquirectKHR scale(XrVector2f value)
  
  Copies the specified XrVector2f to the scale() field.
- scale
  
  public XrCompositionLayerEquirectKHR scale(Consumer<XrVector2f> consumer)
  
  Passes the scale() field to the specified Consumer.
- bias
  
  public XrCompositionLayerEquirectKHR bias(XrVector2f value)
  
  Copies the specified XrVector2f to the bias() field.
- bias
  
  public XrCompositionLayerEquirectKHR bias(Consumer<XrVector2f> consumer)
  
  Passes the bias() field to the specified Consumer.
- set
  
  public XrCompositionLayerEquirectKHR set(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchainSubImage subImage, XrPosef pose, float radius, XrVector2f scale, XrVector2f bias)
  
  Initializes this struct with the specified values.
- set
  
  public XrCompositionLayerEquirectKHR set(XrCompositionLayerEquirectKHR src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static XrCompositionLayerEquirectKHR malloc()
  
  Returns a new XrCompositionLayerEquirectKHR instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static XrCompositionLayerEquirectKHR calloc()
  
  Returns a new XrCompositionLayerEquirectKHR instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static XrCompositionLayerEquirectKHR create()
  
  Returns a new XrCompositionLayerEquirectKHR instance allocated with BufferUtils.
- create
  
  public static XrCompositionLayerEquirectKHR create(long address)
  
  Returns a new XrCompositionLayerEquirectKHR instance for the specified memory address.
- createSafe
  
  public static @Nullable XrCompositionLayerEquirectKHR createSafe(long address)
  
  Like create, but returns null if address is NULL.
- create
  
  public static XrCompositionLayerEquirectKHR create(XrCompositionLayerBaseHeader value)
  
  Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerEquirectKHR.
- malloc
  
  public static XrCompositionLayerEquirectKHR.Buffer malloc(int capacity)
  
  Returns a new XrCompositionLayerEquirectKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static XrCompositionLayerEquirectKHR.Buffer calloc(int capacity)
  
  Returns a new XrCompositionLayerEquirectKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static XrCompositionLayerEquirectKHR.Buffer create(int capacity)
  
  Returns a new XrCompositionLayerEquirectKHR.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static XrCompositionLayerEquirectKHR.Buffer create(long address, int capacity)
  
  Create a XrCompositionLayerEquirectKHR.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable XrCompositionLayerEquirectKHR.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- create
  
  public static XrCompositionLayerEquirectKHR.Buffer create(XrCompositionLayerBaseHeader.Buffer value)
  
  Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerEquirectKHR.Buffer.
- malloc
  
  public static XrCompositionLayerEquirectKHR malloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerEquirectKHR instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static XrCompositionLayerEquirectKHR calloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerEquirectKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static XrCompositionLayerEquirectKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerEquirectKHR.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static XrCompositionLayerEquirectKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrCompositionLayerEquirectKHR.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().
- nscale
  
  public static XrVector2f nscale(long struct)
  
  Unsafe version of scale().
- nbias
  
  public static XrVector2f nbias(long struct)
  
  Unsafe version of bias().
- 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.
- nscale
  
  public static void nscale(long struct, XrVector2f value)
  
  Unsafe version of scale.
- nbias
  
  public static void nbias(long struct, XrVector2f value)
  
  Unsafe version of bias.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class XrCompositionLayerEquirectKHR

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

SCALE

BIAS

Constructor Details

XrCompositionLayerEquirectKHR

Method Details

sizeof

type

next

layerFlags

space

eyeVisibility

subImage

pose

radius

scale

bias

type

type$Default

next

layerFlags

space

eyeVisibility

subImage

subImage

pose

pose

radius

scale

scale

bias

bias

set

set

malloc

calloc

create

create

createSafe

create

malloc

calloc

create

create

createSafe

create

malloc

calloc

malloc

calloc

ntype

nnext

nlayerFlags

nspace