Package org.lwjgl.openxr

Class XrGraphicsBindingVulkanKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrGraphicsBindingVulkanKHR>
org.lwjgl.openxr.XrGraphicsBindingVulkanKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
XrGraphicsBindingVulkan2KHR
public class XrGraphicsBindingVulkanKHR extends org.lwjgl.system.Struct<XrGraphicsBindingVulkanKHR> implements org.lwjgl.system.NativeResource
The graphics binding structure to be passed at session creation to use Vulkan.
Description

When creating a Vulkan-backed XrSession, the application will provide a pointer to an XrGraphicsBindingVulkanKHR in the next chain of the XrSessionCreateInfo.

Valid Usage
Valid Usage (Implicit)
See Also

CreateSession

Layout


 struct XrGraphicsBindingVulkanKHR {
     XrStructureType type();
     void const * next();
     VkInstance instance();
     VkPhysicalDevice physicalDevice();
     VkDevice device();
     uint32_t queueFamilyIndex();
     uint32_t queueIndex();
 }

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

    • INSTANCE

      public static final int INSTANCE
      The struct member offsets.

    • PHYSICALDEVICE

      public static final int PHYSICALDEVICE
      The struct member offsets.

    • DEVICE

      public static final int DEVICE
      The struct member offsets.

    • QUEUEFAMILYINDEX

      public static final int QUEUEFAMILYINDEX
      The struct member offsets.

    • QUEUEINDEX

      public static final int QUEUEINDEX
      The struct member offsets.

  • Constructor Details

    • XrGraphicsBindingVulkanKHR

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

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

    • instance

      public long instance()
      a valid Vulkan VkInstance.

    • physicalDevice

      public long physicalDevice()
      a valid Vulkan VkPhysicalDevice.

    • device

      public long device()
      a valid Vulkan VkDevice.

    • queueFamilyIndex

      public int queueFamilyIndex()
      a valid queue family index on device.

    • queueIndex

      public int queueIndex()
      a valid queue index on device to be used for synchronization.

    • type

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

    • type$Default

      public XrGraphicsBindingVulkanKHR type$Default()
      Sets the TYPE_GRAPHICS_BINDING_VULKAN_KHR value to the type() field.

    • next

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

    • instance

      public XrGraphicsBindingVulkanKHR instance(org.lwjgl.vulkan.VkInstance value)
      Sets the specified value to the instance() field.

    • physicalDevice

      public XrGraphicsBindingVulkanKHR physicalDevice(org.lwjgl.vulkan.VkPhysicalDevice value)
      Sets the specified value to the physicalDevice() field.

    • device

      public XrGraphicsBindingVulkanKHR device(org.lwjgl.vulkan.VkDevice value)
      Sets the specified value to the device() field.

    • queueFamilyIndex

      public XrGraphicsBindingVulkanKHR queueFamilyIndex(int value)
      Sets the specified value to the queueFamilyIndex() field.

    • queueIndex

      public XrGraphicsBindingVulkanKHR queueIndex(int value)
      Sets the specified value to the queueIndex() field.

    • set

      public XrGraphicsBindingVulkanKHR set(int type, long next, org.lwjgl.vulkan.VkInstance instance, org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, org.lwjgl.vulkan.VkDevice device, int queueFamilyIndex, int queueIndex)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • ninstance

      public static long ninstance(long struct)
      Unsafe version of instance().

    • nphysicalDevice

      public static long nphysicalDevice(long struct)
      Unsafe version of physicalDevice().

    • ndevice

      public static long ndevice(long struct)
      Unsafe version of device().

    • nqueueFamilyIndex

      public static int nqueueFamilyIndex(long struct)
      Unsafe version of queueFamilyIndex().

    • nqueueIndex

      public static int nqueueIndex(long struct)
      Unsafe version of queueIndex().

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

    • ninstance

      public static void ninstance(long struct, org.lwjgl.vulkan.VkInstance value)
      Unsafe version of instance.

    • nphysicalDevice

      public static void nphysicalDevice(long struct, org.lwjgl.vulkan.VkPhysicalDevice value)
      Unsafe version of physicalDevice.

    • ndevice

      public static void ndevice(long struct, org.lwjgl.vulkan.VkDevice value)
      Unsafe version of device.

    • nqueueFamilyIndex

      public static void nqueueFamilyIndex(long struct, int value)
      Unsafe version of queueFamilyIndex.

    • nqueueIndex

      public static void nqueueIndex(long struct, int value)
      Unsafe version of queueIndex.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate