Package org.lwjgl.openxr

Class XrSwapchainCreateInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSwapchainCreateInfo>
org.lwjgl.openxr.XrSwapchainCreateInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSwapchainCreateInfo extends org.lwjgl.system.Struct<XrSwapchainCreateInfo> implements org.lwjgl.system.NativeResource
Creation info for a swapchain.
Valid Usage (Implicit)
See Also

CreateSession, CreateSwapchain, EnumerateSwapchainFormats

Layout


 struct XrSwapchainCreateInfo {
     XrStructureType type();
     void const * next();
     XrSwapchainCreateFlags createFlags();
     XrSwapchainUsageFlags usageFlags();
     int64_t format();
     uint32_t sampleCount();
     uint32_t width();
     uint32_t height();
     uint32_t faceCount();
     uint32_t arraySize();
     uint32_t mipCount();
 }

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

    • CREATEFLAGS

      public static final int CREATEFLAGS
      The struct member offsets.

    • USAGEFLAGS

      public static final int USAGEFLAGS
      The struct member offsets.

    • FORMAT

      public static final int FORMAT
      The struct member offsets.

    • SAMPLECOUNT

      public static final int SAMPLECOUNT
      The struct member offsets.

    • WIDTH

      public static final int WIDTH
      The struct member offsets.

    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.

    • FACECOUNT

      public static final int FACECOUNT
      The struct member offsets.

    • ARRAYSIZE

      public static final int ARRAYSIZE
      The struct member offsets.

    • MIPCOUNT

      public static final int MIPCOUNT
      The struct member offsets.

  • Constructor Details

    • XrSwapchainCreateInfo

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

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

    • createFlags

      public long createFlags()
      a bitmask of XrSwapchainCreateFlagBits describing additional properties of the swapchain.

    • usageFlags

      public long usageFlags()
      a bitmask of XrSwapchainUsageFlagBits describing the intended usage of the swapchain’s images. The usage flags define how the corresponding graphics API objects are created. A mismatch may result in swapchain images that do not support the application’s usage.

    • format

      public long format()
      a graphics API-specific texture format identifier. For example, if the graphics API specified in CreateSession is Vulkan, then this format is a Vulkan format such as VK_FORMAT_R8G8B8A8_SRGB. The format identifies the format that the runtime will interpret the texture as upon submission. Valid formats are indicated by EnumerateSwapchainFormats.

    • sampleCount

      public int sampleCount()
      the number of sub-data element samples in the image, must not be 0 or greater than the graphics API’s maximum limit.

    • width

      public int width()
      the width of the image, must not be 0 or greater than the graphics API’s maximum limit.

    • height

      public int height()
      the height of the image, must not be 0 or greater than the graphics API’s maximum limit.

    • faceCount

      public int faceCount()
      the number of faces, which must be either 6 (for cubemaps) or 1.

    • arraySize

      public int arraySize()
      the number of array layers in the image or 1 for a 2D image, must not be 0 or greater than the graphics API’s maximum limit.

    • mipCount

      public int mipCount()
      describes the number of levels of detail available for minified sampling of the image, must not be 0 or greater than the graphics API’s maximum limit.

    • type

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

    • type$Default

      public XrSwapchainCreateInfo type$Default()
      Sets the TYPE_SWAPCHAIN_CREATE_INFO value to the type() field.

    • next

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

    • next

      public XrSwapchainCreateInfo next(XrSecondaryViewConfigurationSwapchainCreateInfoMSFT value)
      Prepends the specified XrSecondaryViewConfigurationSwapchainCreateInfoMSFT value to the next chain.

    • next

      public XrSwapchainCreateInfo next(XrSwapchainCreateInfoFoveationFB value)
      Prepends the specified XrSwapchainCreateInfoFoveationFB value to the next chain.

    • next

      public XrSwapchainCreateInfo next(XrVulkanSwapchainCreateInfoMETA value)
      Prepends the specified XrVulkanSwapchainCreateInfoMETA value to the next chain.

    • createFlags

      public XrSwapchainCreateInfo createFlags(long value)
      Sets the specified value to the createFlags() field.

    • usageFlags

      public XrSwapchainCreateInfo usageFlags(long value)
      Sets the specified value to the usageFlags() field.

    • format

      public XrSwapchainCreateInfo format(long value)
      Sets the specified value to the format() field.

    • sampleCount

      public XrSwapchainCreateInfo sampleCount(int value)
      Sets the specified value to the sampleCount() field.

    • width

      public XrSwapchainCreateInfo width(int value)
      Sets the specified value to the width() field.

    • height

      public XrSwapchainCreateInfo height(int value)
      Sets the specified value to the height() field.

    • faceCount

      public XrSwapchainCreateInfo faceCount(int value)
      Sets the specified value to the faceCount() field.

    • arraySize

      public XrSwapchainCreateInfo arraySize(int value)
      Sets the specified value to the arraySize() field.

    • mipCount

      public XrSwapchainCreateInfo mipCount(int value)
      Sets the specified value to the mipCount() field.

    • set

      public XrSwapchainCreateInfo set(int type, long next, long createFlags, long usageFlags, long format, int sampleCount, int width, int height, int faceCount, int arraySize, int mipCount)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • ncreateFlags

      public static long ncreateFlags(long struct)
      Unsafe version of createFlags().

    • nusageFlags

      public static long nusageFlags(long struct)
      Unsafe version of usageFlags().

    • nformat

      public static long nformat(long struct)
      Unsafe version of format().

    • nsampleCount

      public static int nsampleCount(long struct)
      Unsafe version of sampleCount().

    • nwidth

      public static int nwidth(long struct)
      Unsafe version of width().

    • nheight

      public static int nheight(long struct)
      Unsafe version of height().

    • nfaceCount

      public static int nfaceCount(long struct)
      Unsafe version of faceCount().

    • narraySize

      public static int narraySize(long struct)
      Unsafe version of arraySize().

    • nmipCount

      public static int nmipCount(long struct)
      Unsafe version of mipCount().

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

    • ncreateFlags

      public static void ncreateFlags(long struct, long value)
      Unsafe version of createFlags.

    • nusageFlags

      public static void nusageFlags(long struct, long value)
      Unsafe version of usageFlags.

    • nformat

      public static void nformat(long struct, long value)
      Unsafe version of format.

    • nsampleCount

      public static void nsampleCount(long struct, int value)
      Unsafe version of sampleCount.

    • nwidth

      public static void nwidth(long struct, int value)
      Unsafe version of width.

    • nheight

      public static void nheight(long struct, int value)
      Unsafe version of height.

    • nfaceCount

      public static void nfaceCount(long struct, int value)
      Unsafe version of faceCount.

    • narraySize

      public static void narraySize(long struct, int value)
      Unsafe version of arraySize.

    • nmipCount

      public static void nmipCount(long struct, int value)
      Unsafe version of mipCount.