Package org.lwjgl.openxr

Class XrFaceTrackerCreateInfo2FB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrFaceTrackerCreateInfo2FB>
org.lwjgl.openxr.XrFaceTrackerCreateInfo2FB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrFaceTrackerCreateInfo2FB extends org.lwjgl.system.Struct<XrFaceTrackerCreateInfo2FB> implements org.lwjgl.system.NativeResource
Information to create a facial expression handle.
Description

The XrFaceTrackerCreateInfo2FB structure describes the information to create an XrFaceTracker2FB handle.

Runtimes may support a variety of data sources for estimations of facial expression, and some runtimes and devices may use data from multiple data sources. The application tells the runtime all data sources that the runtime may use to provide facial expressions for the application.

Because the device setting may change during a running session, the runtime may return a valid XrFaceTracker2FB handle even if the device is unable to estimate facial expression using the data sources requested by the application’s call to CreateFaceTracker2FB. The runtime must instead return ERROR_FEATURE_UNSUPPORTED from CreateFaceTracker2FB, if for example the runtime believes it will never be able to satisfy the request.

If requestedDataSourceCount is 0, the runtime may choose any supported data source, preferably one that is more expressive than the others.

If any value in requestedDataSources is duplicated the runtime must return ERROR_VALIDATION_FAILURE from the call to CreateFaceTracker2FB.

Valid Usage (Implicit)
See Also

CreateFaceTracker2FB

Layout


 struct XrFaceTrackerCreateInfo2FB {
     XrStructureType type();
     void const * next();
     XrFaceExpressionSet2FB faceExpressionSet();
     uint32_t requestedDataSourceCount();
     XrFaceTrackingDataSource2FB * requestedDataSources();
 }

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

    • FACEEXPRESSIONSET

      public static final int FACEEXPRESSIONSET
      The struct member offsets.

    • REQUESTEDDATASOURCECOUNT

      public static final int REQUESTEDDATASOURCECOUNT
      The struct member offsets.

    • REQUESTEDDATASOURCES

      public static final int REQUESTEDDATASOURCES
      The struct member offsets.

  • Constructor Details

    • XrFaceTrackerCreateInfo2FB

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

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

    • faceExpressionSet

      public int faceExpressionSet()
      an XrFaceExpressionSet2FB that describes the set of blend shapes to retrieve.

    • requestedDataSourceCount

      public int requestedDataSourceCount()
      the number of elements in the requestedDataSources array.

    • requestedDataSources

      public @Nullable IntBuffer requestedDataSources()
      an array of XrFaceTrackingDataSource2FB that the application accepts. The order of values in the array has no significance.

    • type

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

    • type$Default

      public XrFaceTrackerCreateInfo2FB type$Default()
      Sets the TYPE_FACE_TRACKER_CREATE_INFO2_FB value to the type() field.

    • next

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

    • faceExpressionSet

      public XrFaceTrackerCreateInfo2FB faceExpressionSet(int value)
      Sets the specified value to the faceExpressionSet() field.

    • requestedDataSourceCount

      public XrFaceTrackerCreateInfo2FB requestedDataSourceCount(int value)
      Sets the specified value to the requestedDataSourceCount() field.

    • requestedDataSources

      public XrFaceTrackerCreateInfo2FB requestedDataSources(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the requestedDataSources() field.

    • set

      public XrFaceTrackerCreateInfo2FB set(int type, long next, int faceExpressionSet, int requestedDataSourceCount, @Nullable IntBuffer requestedDataSources)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nfaceExpressionSet

      public static int nfaceExpressionSet(long struct)
      Unsafe version of faceExpressionSet().

    • nrequestedDataSourceCount

      public static int nrequestedDataSourceCount(long struct)
      Unsafe version of requestedDataSourceCount().

    • nrequestedDataSources

      public static @Nullable IntBuffer nrequestedDataSources(long struct)
      Unsafe version of requestedDataSources.

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

    • nfaceExpressionSet

      public static void nfaceExpressionSet(long struct, int value)
      Unsafe version of faceExpressionSet.

    • nrequestedDataSourceCount

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

    • nrequestedDataSources

      public static void nrequestedDataSources(long struct, @Nullable IntBuffer value)
      Unsafe version of requestedDataSources.