Package org.lwjgl.ovr

Class OVRErrorInfo

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

    public class OVRErrorInfo
    extends Struct
    implements NativeResource
    Provides information about the last error.

    Member documentation

    • Result – the result from the last API call that generated an error ovrResult
    • ErrorString – a UTF8-encoded null-terminated English string describing the problem. The format of this string is subject to change in future versions

    Layout

    
     struct ovrErrorInfo {
         ovrResult Result;
         char ErrorString[512];
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • RESULT, ERRORSTRING

        The struct member offsets.
    • Constructor Detail

      • OVRErrorInfo

        public OVRErrorInfo​(java.nio.ByteBuffer container)
        Creates a OVRErrorInfo 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • Result

        public int Result()
        Returns the value of the Result field.
      • ErrorString

        public java.nio.ByteBuffer ErrorString()
        Returns a ByteBuffer view of the ErrorString field.
      • ErrorStringString

        public java.lang.String ErrorStringString()
        Decodes the null-terminated string stored in the ErrorString field.
      • create

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

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

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

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

        public static OVRErrorInfo callocStack​(MemoryStack stack)
        Returns a new OVRErrorInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static OVRErrorInfo.Buffer callocStack​(int capacity)
        Returns a new OVRErrorInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • callocStack

        public static OVRErrorInfo.Buffer callocStack​(int capacity,
                                                      MemoryStack stack)
        Returns a new OVRErrorInfo.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
      • nResult

        public static int nResult​(long struct)
        Unsafe version of Result().
      • nErrorString

        public static java.nio.ByteBuffer nErrorString​(long struct)
        Unsafe version of ErrorString().
      • nErrorStringString

        public static java.lang.String nErrorStringString​(long struct)
        Unsafe version of ErrorStringString().