Package org.lwjgl.openxr

Class XrRoomLayoutFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrRoomLayoutFB>
org.lwjgl.openxr.XrRoomLayoutFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrRoomLayoutFB extends org.lwjgl.system.Struct<XrRoomLayoutFB> implements org.lwjgl.system.NativeResource
Provides additional context of a spatial entity representing a room.
Description

This structure is used by the GetSpaceRoomLayoutFB function to provide the application with the XrUuidEXT handles representing the various surfaces of a room.

Valid Usage (Implicit)
See Also

XrUuidEXT, GetSpaceRoomLayoutFB

Layout


 struct XrRoomLayoutFB {
     XrStructureType type();
     void const * next();
     XrUuidEXT floorUuid();
     XrUuidEXT ceilingUuid();
     uint32_t wallUuidCapacityInput();
     uint32_t wallUuidCountOutput();
     XrUuidEXT * wallUuids();
 }

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

    • FLOORUUID

      public static final int FLOORUUID
      The struct member offsets.

    • CEILINGUUID

      public static final int CEILINGUUID
      The struct member offsets.

    • WALLUUIDCAPACITYINPUT

      public static final int WALLUUIDCAPACITYINPUT
      The struct member offsets.

    • WALLUUIDCOUNTOUTPUT

      public static final int WALLUUIDCOUNTOUTPUT
      The struct member offsets.

    • WALLUUIDS

      public static final int WALLUUIDS
      The struct member offsets.

  • Constructor Details

    • XrRoomLayoutFB

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

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

    • floorUuid

      public XrUuidEXT floorUuid()
      the UUID of the spatial entity representing the room floor

    • ceilingUuid

      public XrUuidEXT ceilingUuid()
      the UUID of the spatial entity representing the room ceiling

    • wallUuidCapacityInput

      public int wallUuidCapacityInput()
      the capacity of the wallUuids array, in number of UUIDs, or 0 to indicate a request to retrieve the required capacity.

    • wallUuidCountOutput

      public int wallUuidCountOutput()
      the count of XrUuidEXT handles written, or the required capacity in the case that wallUuidCapacityInput is insufficient.

    • wallUuids

      public @Nullable XrUuidEXT.Buffer wallUuids()
      a pointer to an array of XrUuidEXT handles, but can be NULL if wallUuidCapacityInput is 0.

    • type

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

    • type$Default

      public XrRoomLayoutFB type$Default()
      Sets the TYPE_ROOM_LAYOUT_FB value to the type() field.

    • next

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

    • floorUuid

      public XrRoomLayoutFB floorUuid(XrUuidEXT value)
      Copies the specified XrUuidEXT to the floorUuid() field.

    • floorUuid

      public XrRoomLayoutFB floorUuid(Consumer<XrUuidEXT> consumer)
      Passes the floorUuid() field to the specified Consumer.

    • ceilingUuid

      public XrRoomLayoutFB ceilingUuid(XrUuidEXT value)
      Copies the specified XrUuidEXT to the ceilingUuid() field.

    • ceilingUuid

      public XrRoomLayoutFB ceilingUuid(Consumer<XrUuidEXT> consumer)
      Passes the ceilingUuid() field to the specified Consumer.

    • wallUuidCapacityInput

      public XrRoomLayoutFB wallUuidCapacityInput(int value)
      Sets the specified value to the wallUuidCapacityInput() field.

    • wallUuidCountOutput

      public XrRoomLayoutFB wallUuidCountOutput(int value)
      Sets the specified value to the wallUuidCountOutput() field.

    • wallUuids

      public XrRoomLayoutFB wallUuids(@Nullable XrUuidEXT.Buffer value)
      Sets the address of the specified XrUuidEXT.Buffer to the wallUuids() field.

    • set

      public XrRoomLayoutFB set(int type, long next, XrUuidEXT floorUuid, XrUuidEXT ceilingUuid, int wallUuidCapacityInput, int wallUuidCountOutput, @Nullable XrUuidEXT.Buffer wallUuids)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nfloorUuid

      public static XrUuidEXT nfloorUuid(long struct)
      Unsafe version of floorUuid().

    • nceilingUuid

      public static XrUuidEXT nceilingUuid(long struct)
      Unsafe version of ceilingUuid().

    • nwallUuidCapacityInput

      public static int nwallUuidCapacityInput(long struct)
      Unsafe version of wallUuidCapacityInput().

    • nwallUuidCountOutput

      public static int nwallUuidCountOutput(long struct)
      Unsafe version of wallUuidCountOutput().

    • nwallUuids

      public static @Nullable XrUuidEXT.Buffer nwallUuids(long struct)
      Unsafe version of wallUuids().

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

    • nfloorUuid

      public static void nfloorUuid(long struct, XrUuidEXT value)
      Unsafe version of floorUuid.

    • nceilingUuid

      public static void nceilingUuid(long struct, XrUuidEXT value)
      Unsafe version of ceilingUuid.

    • nwallUuidCapacityInput

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

    • nwallUuidCountOutput

      public static void nwallUuidCountOutput(long struct, int value)
      Unsafe version of wallUuidCountOutput.

    • nwallUuids

      public static void nwallUuids(long struct, @Nullable XrUuidEXT.Buffer value)
      Unsafe version of wallUuids.