Class XrViewState

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

    public class XrViewState
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Struct containing additional view state.
    Description

    The XrViewState contains additional view state from LocateViews common to all views of the active view configuration.

    Valid Usage (Implicit)
    See Also

    XrView, LocateViews

    Layout

    
     struct XrViewState {
         XrStructureType type();
         void * next();
         XrViewStateFlags viewStateFlags();
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  XrViewState.Buffer
      An array of XrViewState structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

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

        org.lwjgl.system.Struct.StructValidation
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int NEXT
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int TYPE
      VIEWSTATEFLAGS
      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
      XrViewState​(java.nio.ByteBuffer container)
      Creates a XrViewState instance at the current position of the specified ByteBuffer container.
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • TYPE, NEXT, VIEWSTATEFLAGS

        The struct member offsets.
    • Constructor Detail

      • XrViewState

        public XrViewState​(java.nio.ByteBuffer container)
        Creates a XrViewState 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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • 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.
      • viewStateFlags

        public long viewStateFlags()
        a bitmask of XrViewStateFlagBits indicating state for all views.
      • type

        public XrViewState type​(int value)
        Sets the specified value to the type() field.
      • next

        public XrViewState next​(long value)
        Sets the specified value to the next() field.
      • set

        public XrViewState set​(int type,
                               long next,
                               long viewStateFlags)
        Initializes this struct with the specified values.
      • set

        public XrViewState set​(XrViewState src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

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

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

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

        public static XrViewState create​(long address)
        Returns a new XrViewState instance for the specified memory address.
      • createSafe

        @Nullable
        public static XrViewState createSafe​(long address)
        Like create, but returns null if address is NULL.
      • malloc

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

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

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

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

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

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

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

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

        public static XrViewState.Buffer calloc​(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
        Returns a new XrViewState.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • ntype

        public static int ntype​(long struct)
        Unsafe version of type().
      • nnext

        public static long nnext​(long struct)
        Unsafe version of next().
      • nviewStateFlags

        public static long nviewStateFlags​(long struct)
        Unsafe version of viewStateFlags().
      • 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.
      • nviewStateFlags

        public static void nviewStateFlags​(long struct,
                                           long value)
        Unsafe version of viewStateFlags.