Package org.lwjgl.openxr

Class XrView

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrView>
org.lwjgl.openxr.XrView
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrView extends org.lwjgl.system.Struct<XrView> implements org.lwjgl.system.NativeResource
Struct containing view projection state.
Description

The XrView structure contains view pose and projection state necessary to render a single projection view in the view configuration.

Valid Usage (Implicit)
See Also

XrFovf, XrPosef, XrViewLocateInfo, XrViewState, LocateViews

Layout


 struct XrView {
     XrStructureType type();
     void * next();
     XrPosef pose();
     XrFovf fov();
 }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    XrView.Buffer
    An array of XrView 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
    FOV
    The struct member offsets.
    static final int
    NEXT
    The struct member offsets.
    static final int
    POSE
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.
    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
    XrView(ByteBuffer container)
    Creates a XrView instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    static XrView
    calloc()
    Returns a new XrView instance allocated with memCalloc.
    static XrView.Buffer
    calloc(int capacity)
    Returns a new XrView.Buffer instance allocated with memCalloc.
    static XrView.Buffer
    calloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new XrView.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static XrView
    calloc(org.lwjgl.system.MemoryStack stack)
    Returns a new XrView instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static XrView
    create()
    Returns a new XrView instance allocated with BufferUtils.
    static XrView.Buffer
    create(int capacity)
    Returns a new XrView.Buffer instance allocated with BufferUtils.
    static XrView
    create(long address)
    Returns a new XrView instance for the specified memory address.
    static XrView.Buffer
    create(long address, int capacity)
    Create a XrView.Buffer instance at the specified memory.
    static @Nullable XrView
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable XrView.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    XrFovf
    fov()
    the XrFovf for the four sides of the projection.
    XrView
    fov(Consumer<XrFovf> consumer)
    Passes the fov() field to the specified Consumer.
    XrView
    fov(XrFovf value)
    Copies the specified XrFovf to the fov() field.
    static XrView
    malloc()
    Returns a new XrView instance allocated with memAlloc.
    static XrView.Buffer
    malloc(int capacity)
    Returns a new XrView.Buffer instance allocated with memAlloc.
    static XrView.Buffer
    malloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new XrView.Buffer instance allocated on the specified MemoryStack.
    static XrView
    malloc(org.lwjgl.system.MemoryStack stack)
    Returns a new XrView instance allocated on the specified MemoryStack.
    long
    next()
    NULL or a pointer to the next structure in a structure chain.
    XrView
    next(long value)
    Sets the specified value to the next() field.
    static XrFovf
    nfov(long struct)
    Unsafe version of fov().
    static void
    nfov(long struct, XrFovf value)
    Unsafe version of fov.
    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 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 location and orientation of the view in the space specified by the LocateViews function.
    XrView
    pose(Consumer<XrPosef> consumer)
    Passes the pose() field to the specified Consumer.
    XrView
    pose(XrPosef value)
    Copies the specified XrPosef to the pose() field.
    XrView
    set(int type, long next, XrPosef pose, XrFovf fov)
    Initializes this struct with the specified values.
    XrView
    set(XrView src)
    Copies the specified struct data to this struct.
    int
    sizeof()
     
    int
    type()
    the XrStructureType of this structure.
    XrView
    type(int value)
    Sets the specified value to the type() field.
    XrView
    type$Default()
    Sets the TYPE_VIEW value to the type() field.

    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.

    • POSE

      public static final int POSE
      The struct member offsets.

    • FOV

      public static final int FOV
      The struct member offsets.

  • Constructor Details

    • XrView

      public XrView(ByteBuffer container)
      Creates a XrView 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<XrView>

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

    • pose

      public XrPosef pose()
      an XrPosef defining the location and orientation of the view in the space specified by the LocateViews function.

    • fov

      public XrFovf fov()
      the XrFovf for the four sides of the projection.

    • type

      public XrView type(int value)
      Sets the specified value to the type() field.

    • type$Default

      public XrView type$Default()
      Sets the TYPE_VIEW value to the type() field.

    • next

      public XrView next(long value)
      Sets the specified value to the next() field.

    • pose

      public XrView pose(XrPosef value)
      Copies the specified XrPosef to the pose() field.

    • pose

      public XrView pose(Consumer<XrPosef> consumer)
      Passes the pose() field to the specified Consumer.

    • fov

      public XrView fov(XrFovf value)
      Copies the specified XrFovf to the fov() field.

    • fov

      public XrView fov(Consumer<XrFovf> consumer)
      Passes the fov() field to the specified Consumer.

    • set

      public XrView set(int type, long next, XrPosef pose, XrFovf fov)
      Initializes this struct with the specified values.

    • set

      public XrView set(XrView src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static XrView malloc()
      Returns a new XrView instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static XrView calloc()
      Returns a new XrView instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static XrView create()
      Returns a new XrView instance allocated with BufferUtils.

    • create

      public static XrView create(long address)
      Returns a new XrView instance for the specified memory address.

    • createSafe

      public static @Nullable XrView createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static XrView.Buffer malloc(int capacity)
      Returns a new XrView.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static XrView.Buffer calloc(int capacity)
      Returns a new XrView.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XrView.Buffer create(int capacity)
      Returns a new XrView.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XrView.Buffer create(long address, int capacity)
      Create a XrView.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable XrView.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static XrView malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XrView instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static XrView calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XrView instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static XrView.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrView.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static XrView.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrView.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().

    • npose

      public static XrPosef npose(long struct)
      Unsafe version of pose().

    • nfov

      public static XrFovf nfov(long struct)
      Unsafe version of fov().

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

    • npose

      public static void npose(long struct, XrPosef value)
      Unsafe version of pose.

    • nfov

      public static void nfov(long struct, XrFovf value)
      Unsafe version of fov.