Package org.lwjgl.openxr

Class XrSceneCaptureRequestInfoFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSceneCaptureRequestInfoFB>
org.lwjgl.openxr.XrSceneCaptureRequestInfoFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSceneCaptureRequestInfoFB extends org.lwjgl.system.Struct<XrSceneCaptureRequestInfoFB> implements org.lwjgl.system.NativeResource
Describes how a scene capture should be conducted by the system.
Description

The XrSceneCaptureRequestInfoFB structure is used by an application to instruct the system what to look for during a scene capture. If the request parameter is NULL, then the runtime must conduct a default scene capture.

Valid Usage (Implicit)
See Also

RequestSceneCaptureFB

Layout


 struct XrSceneCaptureRequestInfoFB {
     XrStructureType type();
     void const * next();
     uint32_t requestByteCount();
     char const * request();
 }

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

    • REQUESTBYTECOUNT

      public static final int REQUESTBYTECOUNT
      The struct member offsets.

    • REQUEST

      public static final int REQUEST
      The struct member offsets.

  • Constructor Details

    • XrSceneCaptureRequestInfoFB

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

    • 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 or this extension.

    • requestByteCount

      public int requestByteCount()
      byte length of the request parameter.

    • request

      public @Nullable ByteBuffer request()
      a string which the application can use to specify which type of scene capture should be initiated by the runtime. The contents of buffer pointed to by the request parameter is runtime-specific.

    • type

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

    • type$Default

      public XrSceneCaptureRequestInfoFB type$Default()
      Sets the TYPE_SCENE_CAPTURE_REQUEST_INFO_FB value to the type() field.

    • next

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

    • requestByteCount

      public XrSceneCaptureRequestInfoFB requestByteCount(int value)
      Sets the specified value to the requestByteCount() field.

    • request

      public XrSceneCaptureRequestInfoFB request(@Nullable ByteBuffer value)
      Sets the address of the specified ByteBuffer to the request() field.

    • set

      public XrSceneCaptureRequestInfoFB set(int type, long next, int requestByteCount, @Nullable ByteBuffer request)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nrequestByteCount

      public static int nrequestByteCount(long struct)
      Unsafe version of requestByteCount().

    • nrequest

      public static @Nullable ByteBuffer nrequest(long struct)
      Unsafe version of request.

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

    • nrequestByteCount

      public static void nrequestByteCount(long struct, int value)
      Sets the specified value to the requestByteCount field of the specified struct.

    • nrequest

      public static void nrequest(long struct, @Nullable ByteBuffer value)
      Unsafe version of request.