Package org.lwjgl.openxr
Class XrGraphicsBindingVulkanKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrGraphicsBindingVulkanKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
XrGraphicsBindingVulkan2KHR
public class XrGraphicsBindingVulkanKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceThe 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 anXrGraphicsBindingVulkanKHRin thenextchain of theXrSessionCreateInfo.Valid Usage
instancemust have enabled a Vulkan API version in the range specified byXrGraphicsBindingVulkanKHRinstancemust have enabled all the instance extensions specified byGetVulkanInstanceExtensionsKHRphysicalDeviceVkPhysicalDevicemust match the device specified byGetVulkanGraphicsDeviceKHRdevicemust have enabled all the device extensions specified byGetVulkanDeviceExtensionsKHR
Valid Usage (Implicit)
- The
XR_KHR_vulkan_enableextension must be enabled prior to usingXrGraphicsBindingVulkanKHR typemust beTYPE_GRAPHICS_BINDING_VULKAN_KHRnextmust beNULLor a valid pointer to the next structure in a structure chaininstancemust be a validVkInstancevaluephysicalDevicemust be a validVkPhysicalDevicevaluedevicemust be a validVkDevicevalue
See Also
Layout
struct XrGraphicsBindingVulkanKHR { XrStructureTypetype(); void const *next(); VkInstanceinstance(); VkPhysicalDevicephysicalDevice(); VkDevicedevice(); uint32_tqueueFamilyIndex(); uint32_tqueueIndex(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrGraphicsBindingVulkanKHR.BufferAn array ofXrGraphicsBindingVulkanKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDEVICE
INSTANCE
NEXT
PHYSICALDEVICE
QUEUEFAMILYINDEX
QUEUEINDEXThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrGraphicsBindingVulkanKHR(java.nio.ByteBuffer container)Creates aXrGraphicsBindingVulkanKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrGraphicsBindingVulkanKHRcalloc()Returns a newXrGraphicsBindingVulkanKHRinstance allocated withmemCalloc.static XrGraphicsBindingVulkanKHR.Buffercalloc(int capacity)Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated withmemCalloc.static XrGraphicsBindingVulkanKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrGraphicsBindingVulkanKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrGraphicsBindingVulkanKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrGraphicsBindingVulkanKHRcreate()Returns a newXrGraphicsBindingVulkanKHRinstance allocated withBufferUtils.static XrGraphicsBindingVulkanKHR.Buffercreate(int capacity)Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated withBufferUtils.static XrGraphicsBindingVulkanKHRcreate(long address)Returns a newXrGraphicsBindingVulkanKHRinstance for the specified memory address.static XrGraphicsBindingVulkanKHR.Buffercreate(long address, int capacity)Create aXrGraphicsBindingVulkanKHR.Bufferinstance at the specified memory.static XrGraphicsBindingVulkanKHRcreateSafe(long address)static XrGraphicsBindingVulkanKHR.BuffercreateSafe(long address, int capacity)longdevice()a valid VulkanVkDevice.XrGraphicsBindingVulkanKHRdevice(org.lwjgl.vulkan.VkDevice value)Sets the specified value to thedevice()field.longinstance()a valid VulkanVkInstance.XrGraphicsBindingVulkanKHRinstance(org.lwjgl.vulkan.VkInstance value)Sets the specified value to theinstance()field.static XrGraphicsBindingVulkanKHRmalloc()Returns a newXrGraphicsBindingVulkanKHRinstance allocated withmemAlloc.static XrGraphicsBindingVulkanKHR.Buffermalloc(int capacity)Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated withmemAlloc.static XrGraphicsBindingVulkanKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated on the specifiedMemoryStack.static XrGraphicsBindingVulkanKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrGraphicsBindingVulkanKHRinstance allocated on the specifiedMemoryStack.static longndevice(long struct)Unsafe version ofdevice().static voidndevice(long struct, org.lwjgl.vulkan.VkDevice value)Unsafe version ofdevice.longnext()NULLor a pointer to the next structure in a structure chain.XrGraphicsBindingVulkanKHRnext(long value)Sets the specified value to thenext()field.static longninstance(long struct)Unsafe version ofinstance().static voidninstance(long struct, org.lwjgl.vulkan.VkInstance value)Unsafe version ofinstance.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static longnphysicalDevice(long struct)Unsafe version ofphysicalDevice().static voidnphysicalDevice(long struct, org.lwjgl.vulkan.VkPhysicalDevice value)Unsafe version ofphysicalDevice.static intnqueueFamilyIndex(long struct)Unsafe version ofqueueFamilyIndex().static voidnqueueFamilyIndex(long struct, int value)Unsafe version ofqueueFamilyIndex.static intnqueueIndex(long struct)Unsafe version ofqueueIndex().static voidnqueueIndex(long struct, int value)Unsafe version ofqueueIndex.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.longphysicalDevice()a valid VulkanVkPhysicalDevice.XrGraphicsBindingVulkanKHRphysicalDevice(org.lwjgl.vulkan.VkPhysicalDevice value)Sets the specified value to thephysicalDevice()field.intqueueFamilyIndex()a valid queue family index ondevice.XrGraphicsBindingVulkanKHRqueueFamilyIndex(int value)Sets the specified value to thequeueFamilyIndex()field.intqueueIndex()a valid queue index ondeviceto be used for synchronization.XrGraphicsBindingVulkanKHRqueueIndex(int value)Sets the specified value to thequeueIndex()field.XrGraphicsBindingVulkanKHRset(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.XrGraphicsBindingVulkanKHRset(XrGraphicsBindingVulkanKHR src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrGraphicsBindingVulkanKHRtype(int value)Sets the specified value to thetype()field.XrGraphicsBindingVulkanKHRtype$Default()Sets theTYPE_GRAPHICS_BINDING_VULKAN_KHRvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrGraphicsBindingVulkanKHR
public XrGraphicsBindingVulkanKHR(java.nio.ByteBuffer container)
Creates aXrGraphicsBindingVulkanKHRinstance at the current position of the specifiedByteBuffercontainer. 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor 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 VulkanVkInstance.
-
physicalDevice
public long physicalDevice()
a valid VulkanVkPhysicalDevice.
-
device
public long device()
a valid VulkanVkDevice.
-
queueFamilyIndex
public int queueFamilyIndex()
a valid queue family index ondevice.
-
queueIndex
public int queueIndex()
a valid queue index ondeviceto be used for synchronization.
-
type
public XrGraphicsBindingVulkanKHR type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrGraphicsBindingVulkanKHR type$Default()
Sets theTYPE_GRAPHICS_BINDING_VULKAN_KHRvalue to thetype()field.
-
next
public XrGraphicsBindingVulkanKHR next(long value)
Sets the specified value to thenext()field.
-
instance
public XrGraphicsBindingVulkanKHR instance(org.lwjgl.vulkan.VkInstance value)
Sets the specified value to theinstance()field.
-
physicalDevice
public XrGraphicsBindingVulkanKHR physicalDevice(org.lwjgl.vulkan.VkPhysicalDevice value)
Sets the specified value to thephysicalDevice()field.
-
device
public XrGraphicsBindingVulkanKHR device(org.lwjgl.vulkan.VkDevice value)
Sets the specified value to thedevice()field.
-
queueFamilyIndex
public XrGraphicsBindingVulkanKHR queueFamilyIndex(int value)
Sets the specified value to thequeueFamilyIndex()field.
-
queueIndex
public XrGraphicsBindingVulkanKHR queueIndex(int value)
Sets the specified value to thequeueIndex()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 newXrGraphicsBindingVulkanKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrGraphicsBindingVulkanKHR calloc()
Returns a newXrGraphicsBindingVulkanKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrGraphicsBindingVulkanKHR create()
Returns a newXrGraphicsBindingVulkanKHRinstance allocated withBufferUtils.
-
create
public static XrGraphicsBindingVulkanKHR create(long address)
Returns a newXrGraphicsBindingVulkanKHRinstance for the specified memory address.
-
createSafe
@Nullable public static XrGraphicsBindingVulkanKHR createSafe(long address)
-
malloc
public static XrGraphicsBindingVulkanKHR.Buffer malloc(int capacity)
Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrGraphicsBindingVulkanKHR.Buffer calloc(int capacity)
Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrGraphicsBindingVulkanKHR.Buffer create(int capacity)
Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrGraphicsBindingVulkanKHR.Buffer create(long address, int capacity)
Create aXrGraphicsBindingVulkanKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrGraphicsBindingVulkanKHR.Buffer createSafe(long address, int capacity)
-
malloc
public static XrGraphicsBindingVulkanKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrGraphicsBindingVulkanKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrGraphicsBindingVulkanKHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrGraphicsBindingVulkanKHRinstance allocated on the specifiedMemoryStackand 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 newXrGraphicsBindingVulkanKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrGraphicsBindingVulkanKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrGraphicsBindingVulkanKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
ninstance
public static long ninstance(long struct)
Unsafe version ofinstance().
-
nphysicalDevice
public static long nphysicalDevice(long struct)
Unsafe version ofphysicalDevice().
-
ndevice
public static long ndevice(long struct)
Unsafe version ofdevice().
-
nqueueFamilyIndex
public static int nqueueFamilyIndex(long struct)
Unsafe version ofqueueFamilyIndex().
-
nqueueIndex
public static int nqueueIndex(long struct)
Unsafe version ofqueueIndex().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
ninstance
public static void ninstance(long struct, org.lwjgl.vulkan.VkInstance value)Unsafe version ofinstance.
-
nphysicalDevice
public static void nphysicalDevice(long struct, org.lwjgl.vulkan.VkPhysicalDevice value)Unsafe version ofphysicalDevice.
-
ndevice
public static void ndevice(long struct, org.lwjgl.vulkan.VkDevice value)Unsafe version ofdevice.
-
nqueueFamilyIndex
public static void nqueueFamilyIndex(long struct, int value)Unsafe version ofqueueFamilyIndex.
-
nqueueIndex
public static void nqueueIndex(long struct, int value)Unsafe version ofqueueIndex.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-