Package org.lwjgl.openxr

Class XrFrameEndInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrFrameEndInfo>
org.lwjgl.openxr.XrFrameEndInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrFrameEndInfo extends org.lwjgl.system.Struct<XrFrameEndInfo> implements org.lwjgl.system.NativeResource
End frame information.
Valid Usage (Implicit)
See Also

XrCompositionLayerBaseHeader, EndFrame

Layout


 struct XrFrameEndInfo {
     XrStructureType type();
     void const * next();
     XrTime displayTime();
     XrEnvironmentBlendMode environmentBlendMode();
     uint32_t layerCount();
     XrCompositionLayerBaseHeader const * const * layers();
 }

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

    • DISPLAYTIME

      public static final int DISPLAYTIME
      The struct member offsets.

    • ENVIRONMENTBLENDMODE

      public static final int ENVIRONMENTBLENDMODE
      The struct member offsets.

    • LAYERCOUNT

      public static final int LAYERCOUNT
      The struct member offsets.

    • LAYERS

      public static final int LAYERS
      The struct member offsets.

  • Constructor Details

    • XrFrameEndInfo

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

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

    • displayTime

      public long displayTime()
      the XrTime at which this frame should be displayed.

    • environmentBlendMode

      public int environmentBlendMode()
      the XrEnvironmentBlendMode value representing the desired environment blend mode for this frame.

    • layerCount

      public int layerCount()
      the number of composition layers in this frame. The maximum supported layer count is identified by XrSystemGraphicsProperties::maxLayerCount. If layerCount is greater than the maximum supported layer count then ERROR_LAYER_LIMIT_EXCEEDED must be returned.

    • layers

      public @Nullable org.lwjgl.PointerBuffer layers()
      a pointer to an array of XrCompositionLayerBaseHeader pointers.

    • type

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

    • type$Default

      public XrFrameEndInfo type$Default()
      Sets the TYPE_FRAME_END_INFO value to the type() field.

    • next

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

    • next

      public XrFrameEndInfo next(XrFrameEndInfoML value)
      Prepends the specified XrFrameEndInfoML value to the next chain.

    • next

      public XrFrameEndInfo next(XrGlobalDimmerFrameEndInfoML value)
      Prepends the specified XrGlobalDimmerFrameEndInfoML value to the next chain.

    • next

      public XrFrameEndInfo next(XrLocalDimmingFrameEndInfoMETA value)
      Prepends the specified XrLocalDimmingFrameEndInfoMETA value to the next chain.

    • next

      public XrFrameEndInfo next(XrSecondaryViewConfigurationFrameEndInfoMSFT value)
      Prepends the specified XrSecondaryViewConfigurationFrameEndInfoMSFT value to the next chain.

    • displayTime

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

    • environmentBlendMode

      public XrFrameEndInfo environmentBlendMode(int value)
      Sets the specified value to the environmentBlendMode() field.

    • layerCount

      public XrFrameEndInfo layerCount(int value)
      Sets the specified value to the layerCount() field.

    • layers

      public XrFrameEndInfo layers(@Nullable org.lwjgl.PointerBuffer value)
      Sets the address of the specified PointerBuffer to the layers() field.

    • set

      public XrFrameEndInfo set(int type, long next, long displayTime, int environmentBlendMode, int layerCount, @Nullable org.lwjgl.PointerBuffer layers)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • ndisplayTime

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

    • nenvironmentBlendMode

      public static int nenvironmentBlendMode(long struct)
      Unsafe version of environmentBlendMode().

    • nlayerCount

      public static int nlayerCount(long struct)
      Unsafe version of layerCount().

    • nlayers

      public static @Nullable org.lwjgl.PointerBuffer nlayers(long struct)
      Unsafe version of layers.

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

    • ndisplayTime

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

    • nenvironmentBlendMode

      public static void nenvironmentBlendMode(long struct, int value)
      Unsafe version of environmentBlendMode.

    • nlayerCount

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

    • nlayers

      public static void nlayers(long struct, @Nullable org.lwjgl.PointerBuffer value)
      Unsafe version of layers.