Package org.lwjgl.openxr

Class XrVulkanDeviceCreateInfoKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrVulkanDeviceCreateInfoKHR>
org.lwjgl.openxr.XrVulkanDeviceCreateInfoKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrVulkanDeviceCreateInfoKHR extends org.lwjgl.system.Struct<XrVulkanDeviceCreateInfoKHR> implements org.lwjgl.system.NativeResource
Vulkan Device Create Info.
Description

If the vulkanPhysicalDevice parameter does not match the output of GetVulkanGraphicsDeviceKHR, then the runtime must return ERROR_HANDLE_INVALID.

Valid Usage (Implicit)
See Also

CreateVulkanDeviceKHR

Layout


 struct XrVulkanDeviceCreateInfoKHR {
     XrStructureType type();
     void const * next();
     XrSystemId systemId();
     XrVulkanDeviceCreateFlagsKHR createFlags();
     PFN_vkGetInstanceProcAddr pfnGetInstanceProcAddr();
     VkPhysicalDevice vulkanPhysicalDevice();
     VkDeviceCreateInfo const * vulkanCreateInfo();
     VkAllocationCallbacks const * vulkanAllocator();
 }

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

    • SYSTEMID

      public static final int SYSTEMID
      The struct member offsets.

    • CREATEFLAGS

      public static final int CREATEFLAGS
      The struct member offsets.

    • PFNGETINSTANCEPROCADDR

      public static final int PFNGETINSTANCEPROCADDR
      The struct member offsets.

    • VULKANPHYSICALDEVICE

      public static final int VULKANPHYSICALDEVICE
      The struct member offsets.

    • VULKANCREATEINFO

      public static final int VULKANCREATEINFO
      The struct member offsets.

    • VULKANALLOCATOR

      public static final int VULKANALLOCATOR
      The struct member offsets.

  • Constructor Details

    • XrVulkanDeviceCreateInfoKHR

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

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

    • systemId

      public long systemId()
      an XrSystemId handle for the system which will be used to create a session.

    • createFlags

      public long createFlags()
      a bitmask of XrVulkanDeviceCreateFlagBitsKHR

    • pfnGetInstanceProcAddr

      public long pfnGetInstanceProcAddr()
      a function pointer to vkGetInstanceProcAddr or a compatible entry point.

    • vulkanPhysicalDevice

      public long vulkanPhysicalDevice()
      must match GetVulkanGraphicsDeviceKHR.

    • vulkanCreateInfo

      public org.lwjgl.vulkan.VkDeviceCreateInfo vulkanCreateInfo()
      the VkDeviceCreateInfo as specified by Vulkan.

    • vulkanAllocator

      public @Nullable org.lwjgl.vulkan.VkAllocationCallbacks vulkanAllocator()
      the VkAllocationCallbacks as specified by Vulkan.

    • type

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

    • type$Default

      public XrVulkanDeviceCreateInfoKHR type$Default()
      Sets the TYPE_VULKAN_DEVICE_CREATE_INFO_KHR value to the type() field.

    • next

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

    • systemId

      public XrVulkanDeviceCreateInfoKHR systemId(long value)
      Sets the specified value to the systemId() field.

    • createFlags

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

    • pfnGetInstanceProcAddr

      public XrVulkanDeviceCreateInfoKHR pfnGetInstanceProcAddr(long value)
      Sets the specified value to the pfnGetInstanceProcAddr() field.

    • vulkanPhysicalDevice

      public XrVulkanDeviceCreateInfoKHR vulkanPhysicalDevice(org.lwjgl.vulkan.VkPhysicalDevice value)
      Sets the specified value to the vulkanPhysicalDevice() field.

    • vulkanCreateInfo

      public XrVulkanDeviceCreateInfoKHR vulkanCreateInfo(org.lwjgl.vulkan.VkDeviceCreateInfo value)
      Sets the address of the specified VkDeviceCreateInfo to the vulkanCreateInfo() field.

    • vulkanAllocator

      public XrVulkanDeviceCreateInfoKHR vulkanAllocator(@Nullable org.lwjgl.vulkan.VkAllocationCallbacks value)
      Sets the address of the specified VkAllocationCallbacks to the vulkanAllocator() field.

    • set

      public XrVulkanDeviceCreateInfoKHR set(int type, long next, long systemId, long createFlags, long pfnGetInstanceProcAddr, org.lwjgl.vulkan.VkPhysicalDevice vulkanPhysicalDevice, org.lwjgl.vulkan.VkDeviceCreateInfo vulkanCreateInfo, @Nullable org.lwjgl.vulkan.VkAllocationCallbacks vulkanAllocator)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nsystemId

      public static long nsystemId(long struct)
      Unsafe version of systemId().

    • ncreateFlags

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

    • npfnGetInstanceProcAddr

      public static long npfnGetInstanceProcAddr(long struct)
      Unsafe version of pfnGetInstanceProcAddr().

    • nvulkanPhysicalDevice

      public static long nvulkanPhysicalDevice(long struct)
      Unsafe version of vulkanPhysicalDevice().

    • nvulkanCreateInfo

      public static org.lwjgl.vulkan.VkDeviceCreateInfo nvulkanCreateInfo(long struct)
      Unsafe version of vulkanCreateInfo().

    • nvulkanAllocator

      public static @Nullable org.lwjgl.vulkan.VkAllocationCallbacks nvulkanAllocator(long struct)
      Unsafe version of vulkanAllocator().

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

    • nsystemId

      public static void nsystemId(long struct, long value)
      Unsafe version of systemId.

    • ncreateFlags

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

    • npfnGetInstanceProcAddr

      public static void npfnGetInstanceProcAddr(long struct, long value)
      Unsafe version of pfnGetInstanceProcAddr.

    • nvulkanPhysicalDevice

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

    • nvulkanCreateInfo

      public static void nvulkanCreateInfo(long struct, org.lwjgl.vulkan.VkDeviceCreateInfo value)
      Unsafe version of vulkanCreateInfo.

    • nvulkanAllocator

      public static void nvulkanAllocator(long struct, @Nullable org.lwjgl.vulkan.VkAllocationCallbacks value)
      Unsafe version of vulkanAllocator.

    • validate

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