Class XrBaseOutStructure

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

    public class XrBaseOutStructure
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Convenience type for iterating (mutable).
    Description

    XrBaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

    See Also

    XrBaseInStructure, XrBaseOutStructure

    Layout

    
     struct XrBaseOutStructure {
         XrStructureType type();
         XrBaseOutStructure * next();
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • TYPE, NEXT

        The struct member offsets.
    • Constructor Detail

      • XrBaseOutStructure

        public XrBaseOutStructure​(java.nio.ByteBuffer container)
        Creates a XrBaseOutStructure 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. This base structure itself has no associated XrStructureType value.
      • next

        public XrBaseOutStructure next()
        NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
      • malloc

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

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

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

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

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

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

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

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

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

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

        public static void ntype​(long struct,
                                 int value)
        Unsafe version of type.
      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate