Package org.lwjgl.openxr

Class XrViewLocateInfo

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

The XrViewLocateInfo structure contains the display time and space used to locate the view XrView structures.

The runtime must return error ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED if the given viewConfigurationType is not one of the supported type reported by EnumerateViewConfigurations.

Valid Usage (Implicit)
See Also

XrView, XrViewState, LocateViews

Layout


 struct XrViewLocateInfo {
     XrStructureType type();
     void const * next();
     XrViewConfigurationType viewConfigurationType();
     XrTime displayTime();
     XrSpace space();
 }

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

    • VIEWCONFIGURATIONTYPE

      public static final int VIEWCONFIGURATIONTYPE
      The struct member offsets.

    • DISPLAYTIME

      public static final int DISPLAYTIME
      The struct member offsets.

    • SPACE

      public static final int SPACE
      The struct member offsets.

  • Constructor Details

    • XrViewLocateInfo

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

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

    • viewConfigurationType

      public int viewConfigurationType()
      XrViewConfigurationType to query for.

    • displayTime

      public long displayTime()
      the time for which the view poses are predicted.

    • space

      public long space()
      the XrSpace in which the pose in each XrView is expressed.

    • type

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

    • type$Default

      public XrViewLocateInfo type$Default()
      Sets the TYPE_VIEW_LOCATE_INFO value to the type() field.

    • next

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

    • next

      public XrViewLocateInfo next(XrViewLocateFoveatedRenderingVARJO value)
      Prepends the specified XrViewLocateFoveatedRenderingVARJO value to the next chain.

    • viewConfigurationType

      public XrViewLocateInfo viewConfigurationType(int value)
      Sets the specified value to the viewConfigurationType() field.

    • displayTime

      public XrViewLocateInfo displayTime(long value)
      Sets the specified value to the displayTime() field.

    • space

      public XrViewLocateInfo space(XrSpace value)
      Sets the specified value to the space() field.

    • set

      public XrViewLocateInfo set(int type, long next, int viewConfigurationType, long displayTime, XrSpace space)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nviewConfigurationType

      public static int nviewConfigurationType(long struct)
      Unsafe version of viewConfigurationType().

    • ndisplayTime

      public static long ndisplayTime(long struct)
      Unsafe version of displayTime().

    • nspace

      public static long nspace(long struct)
      Unsafe version of space().

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

    • nviewConfigurationType

      public static void nviewConfigurationType(long struct, int value)
      Unsafe version of viewConfigurationType.

    • ndisplayTime

      public static void ndisplayTime(long struct, long value)
      Unsafe version of displayTime.

    • nspace

      public static void nspace(long struct, XrSpace value)
      Unsafe version of space.

    • validate

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