Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrGraphicsBindingVulkanKHR

extends Struct<XrGraphicsBindingVulkanKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.openxr.XrGraphicsBindingVulkan2KHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.vulkan.*

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;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEVICE

The struct member offsets.

public static final int
INSTANCE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
PHYSICALDEVICE

The struct member offsets.

public static final int
QUEUEFAMILYINDEX

The struct member offsets.

public static final int
QUEUEINDEX

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrGraphicsBindingVulkanKHR(long address, ByteBuffer container)

public
XrGraphicsBindingVulkanKHR(ByteBuffer container)

Creates a XrGraphicsBindingVulkanKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrGraphicsBindingVulkanKHR
calloc()

Returns a new XrGraphicsBindingVulkanKHR instance allocated with memCalloc.

public static XrGraphicsBindingVulkanKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated with memCalloc.

public static XrGraphicsBindingVulkanKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrGraphicsBindingVulkanKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static XrGraphicsBindingVulkanKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected XrGraphicsBindingVulkanKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrGraphicsBindingVulkanKHR
create()

Returns a new XrGraphicsBindingVulkanKHR instance allocated with BufferUtils.

public static XrGraphicsBindingVulkanKHR
create(long address)

Returns a new XrGraphicsBindingVulkanKHR instance for the specified memory address.

public static XrGraphicsBindingVulkanKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated with BufferUtils.

public static XrGraphicsBindingVulkanKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a XrGraphicsBindingVulkanKHR.Buffer instance at the specified memory.

public static XrGraphicsBindingVulkanKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static XrGraphicsBindingVulkanKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
device()

a valid Vulkan VkDevice.

public XrGraphicsBindingVulkanKHR
device(VkDevice value)

Sets the specified value to the device field.

public long
instance()

a valid Vulkan VkInstance.

public XrGraphicsBindingVulkanKHR
instance(VkInstance value)

Sets the specified value to the instance field.

public static XrGraphicsBindingVulkanKHR
malloc()

Returns a new XrGraphicsBindingVulkanKHR instance allocated with memAlloc.

public static XrGraphicsBindingVulkanKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated with memAlloc.

public static XrGraphicsBindingVulkanKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrGraphicsBindingVulkanKHR instance allocated on the specified MemoryStack.

public static XrGraphicsBindingVulkanKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated on the specified MemoryStack.

public static long
ndevice(long struct)

Unsafe version of device.

public static void
ndevice(long struct, VkDevice value)

Unsafe version of device.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrGraphicsBindingVulkanKHR
next(long value)

Sets the specified value to the next field.

public static long
ninstance(long struct)

Unsafe version of instance.

public static void
ninstance(long struct, VkInstance value)

Unsafe version of instance.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nphysicalDevice(long struct)

Unsafe version of physicalDevice.

public static void
nphysicalDevice(long struct, VkPhysicalDevice value)

Unsafe version of physicalDevice.

public static int
nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex.

public static void
nqueueFamilyIndex(long struct, int value)

Unsafe version of queueFamilyIndex.

public static int
nqueueIndex(long struct)

Unsafe version of queueIndex.

public static void
nqueueIndex(long struct, int value)

Unsafe version of queueIndex.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public long
physicalDevice()

a valid Vulkan VkPhysicalDevice.

public XrGraphicsBindingVulkanKHR
physicalDevice(VkPhysicalDevice value)

Sets the specified value to the physicalDevice field.

public int
queueFamilyIndex()

a valid queue family index on device.

public XrGraphicsBindingVulkanKHR
queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex field.

public int
queueIndex()

a valid queue index on device to be used for synchronization.

public XrGraphicsBindingVulkanKHR
queueIndex(int value)

Sets the specified value to the queueIndex field.

public XrGraphicsBindingVulkanKHR
set(int type, long next, VkInstance instance, VkPhysicalDevice physicalDevice, VkDevice device, int queueFamilyIndex, int queueIndex)

Initializes this struct with the specified values.

public XrGraphicsBindingVulkanKHR

Returns:

this struct
set
(XrGraphicsBindingVulkanKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

the XrStructureType of this structure.

public XrGraphicsBindingVulkanKHR
type(int value)

Sets the specified value to the type field.

public XrGraphicsBindingVulkanKHR
type$Default()

Sets the TYPE_GRAPHICS_BINDING_VULKAN_KHR value to the type field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DEVICEback to summary
public static final int DEVICE

The struct member offsets.

INSTANCEback to summary
public static final int INSTANCE

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

PHYSICALDEVICEback to summary
public static final int PHYSICALDEVICE

The struct member offsets.

QUEUEFAMILYINDEXback to summary
public static final int QUEUEFAMILYINDEX

The struct member offsets.

QUEUEINDEXback to summary
public static final int QUEUEINDEX

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrGraphicsBindingVulkanKHRback to summary
protected XrGraphicsBindingVulkanKHR(long address, ByteBuffer container)
XrGraphicsBindingVulkanKHRback to summary
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 Detail

callocback to summary
public static XrGraphicsBindingVulkanKHR calloc()

Returns a new XrGraphicsBindingVulkanKHR instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static XrGraphicsBindingVulkanKHR.Buffer calloc(int capacity)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrGraphicsBindingVulkanKHR calloc(MemoryStack stack)

Returns a new XrGraphicsBindingVulkanKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrGraphicsBindingVulkanKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrGraphicsBindingVulkanKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrGraphicsBindingVulkanKHR create()

Returns a new XrGraphicsBindingVulkanKHR instance allocated with BufferUtils.

createback to summary
public static XrGraphicsBindingVulkanKHR create(long address)

Returns a new XrGraphicsBindingVulkanKHR instance for the specified memory address.

createback to summary
public static XrGraphicsBindingVulkanKHR.Buffer create(int capacity)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrGraphicsBindingVulkanKHR.Buffer create(long address, int capacity)

Create a XrGraphicsBindingVulkanKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrGraphicsBindingVulkanKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrGraphicsBindingVulkanKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceback to summary
public long device()

a valid Vulkan VkDevice.

Annotations
@NativeType:VkDevice
deviceback to summary
public XrGraphicsBindingVulkanKHR device(VkDevice value)

Sets the specified value to the device field.

instanceback to summary
public long instance()

a valid Vulkan VkInstance.

Annotations
@NativeType:VkInstance
instanceback to summary
public XrGraphicsBindingVulkanKHR instance(VkInstance value)

Sets the specified value to the instance field.

mallocback to summary
public static XrGraphicsBindingVulkanKHR malloc()

Returns a new XrGraphicsBindingVulkanKHR instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static XrGraphicsBindingVulkanKHR.Buffer malloc(int capacity)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrGraphicsBindingVulkanKHR malloc(MemoryStack stack)

Returns a new XrGraphicsBindingVulkanKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrGraphicsBindingVulkanKHR.Buffer malloc(int capacity, MemoryStack stack)

Returns a new XrGraphicsBindingVulkanKHR.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndeviceback to summary
public static long ndevice(long struct)

Unsafe version of device.

ndeviceback to summary
public static void ndevice(long struct, VkDevice value)

Unsafe version of device.

nextback to summary
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.

Annotations
@NativeType:void const *
nextback to summary
public XrGraphicsBindingVulkanKHR next(long value)

Sets the specified value to the next field.

ninstanceback to summary
public static long ninstance(long struct)

Unsafe version of instance.

ninstanceback to summary
public static void ninstance(long struct, VkInstance value)

Unsafe version of instance.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nphysicalDeviceback to summary
public static long nphysicalDevice(long struct)

Unsafe version of physicalDevice.

nphysicalDeviceback to summary
public static void nphysicalDevice(long struct, VkPhysicalDevice value)

Unsafe version of physicalDevice.

nqueueFamilyIndexback to summary
public static int nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex.

nqueueFamilyIndexback to summary
public static void nqueueFamilyIndex(long struct, int value)

Unsafe version of queueFamilyIndex.

nqueueIndexback to summary
public static int nqueueIndex(long struct)

Unsafe version of queueIndex.

nqueueIndexback to summary
public static void nqueueIndex(long struct, int value)

Unsafe version of queueIndex.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

physicalDeviceback to summary
public long physicalDevice()

a valid Vulkan VkPhysicalDevice.

Annotations
@NativeType:VkPhysicalDevice
physicalDeviceback to summary
public XrGraphicsBindingVulkanKHR physicalDevice(VkPhysicalDevice value)

Sets the specified value to the physicalDevice field.

queueFamilyIndexback to summary
public int queueFamilyIndex()

a valid queue family index on device.

Annotations
@NativeType:uint32_t
queueFamilyIndexback to summary
public XrGraphicsBindingVulkanKHR queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex field.

queueIndexback to summary
public int queueIndex()

a valid queue index on device to be used for synchronization.

Annotations
@NativeType:uint32_t
queueIndexback to summary
public XrGraphicsBindingVulkanKHR queueIndex(int value)

Sets the specified value to the queueIndex field.

setback to summary
public XrGraphicsBindingVulkanKHR set(int type, long next, VkInstance instance, VkPhysicalDevice physicalDevice, VkDevice device, int queueFamilyIndex, int queueIndex)

Initializes this struct with the specified values.

setback to summary
public XrGraphicsBindingVulkanKHR set(XrGraphicsBindingVulkanKHR src)

Copies the specified struct data to this struct.

Parameters
src:XrGraphicsBindingVulkanKHR

the source struct

Returns:XrGraphicsBindingVulkanKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrGraphicsBindingVulkanKHR type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrGraphicsBindingVulkanKHR type$Default()

Sets the TYPE_GRAPHICS_BINDING_VULKAN_KHR value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrGraphicsBindingVulkanKHR.Buffer

extends StructBuffer<XrGraphicsBindingVulkanKHR, XrGraphicsBindingVulkanKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.openxr.XrGraphicsBindingVulkan2KHR.Buffer

An array of XrGraphicsBindingVulkanKHR structs.

Field Summary

Modifier and TypeField and Description
private static final XrGraphicsBindingVulkanKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrGraphicsBindingVulkanKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the XrGraphicsBindingVulkanKHR#device field.
device
()

public XrGraphicsBindingVulkanKHR.Buffer
device(VkDevice value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#device field.

protected XrGraphicsBindingVulkanKHR
public long

Returns:

the value of the XrGraphicsBindingVulkanKHR#instance field.
instance
()

public XrGraphicsBindingVulkanKHR.Buffer
instance(VkInstance value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#instance field.

public long

Returns:

the value of the XrGraphicsBindingVulkanKHR#next field.
next
()

public XrGraphicsBindingVulkanKHR.Buffer
next(long value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#next field.

public long
public XrGraphicsBindingVulkanKHR.Buffer
physicalDevice(VkPhysicalDevice value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#physicalDevice field.

public int
public XrGraphicsBindingVulkanKHR.Buffer
queueFamilyIndex(int value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#queueFamilyIndex field.

public int

Returns:

the value of the XrGraphicsBindingVulkanKHR#queueIndex field.
queueIndex
()

public XrGraphicsBindingVulkanKHR.Buffer
queueIndex(int value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#queueIndex field.

protected XrGraphicsBindingVulkanKHR.Buffer
public int

Returns:

the value of the XrGraphicsBindingVulkanKHR#type field.
type
()

public XrGraphicsBindingVulkanKHR.Buffer
type(int value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#type field.

public XrGraphicsBindingVulkanKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrGraphicsBindingVulkanKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrGraphicsBindingVulkanKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrGraphicsBindingVulkanKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

deviceback to summary
public long device()
Returns:long

the value of the XrGraphicsBindingVulkanKHR#device field.

Annotations
@NativeType:VkDevice
deviceback to summary
public XrGraphicsBindingVulkanKHR.Buffer device(VkDevice value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#device field.

getElementFactoryback to summary
protected XrGraphicsBindingVulkanKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
instanceback to summary
public long instance()
Returns:long

the value of the XrGraphicsBindingVulkanKHR#instance field.

Annotations
@NativeType:VkInstance
instanceback to summary
public XrGraphicsBindingVulkanKHR.Buffer instance(VkInstance value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#instance field.

nextback to summary
public long next()
Returns:long

the value of the XrGraphicsBindingVulkanKHR#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrGraphicsBindingVulkanKHR.Buffer next(long value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#next field.

physicalDeviceback to summary
public long physicalDevice()
Returns:long

the value of the XrGraphicsBindingVulkanKHR#physicalDevice field.

Annotations
@NativeType:VkPhysicalDevice
physicalDeviceback to summary
public XrGraphicsBindingVulkanKHR.Buffer physicalDevice(VkPhysicalDevice value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#physicalDevice field.

queueFamilyIndexback to summary
public int queueFamilyIndex()
Returns:int

the value of the XrGraphicsBindingVulkanKHR#queueFamilyIndex field.

Annotations
@NativeType:uint32_t
queueFamilyIndexback to summary
public XrGraphicsBindingVulkanKHR.Buffer queueFamilyIndex(int value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#queueFamilyIndex field.

queueIndexback to summary
public int queueIndex()
Returns:int

the value of the XrGraphicsBindingVulkanKHR#queueIndex field.

Annotations
@NativeType:uint32_t
queueIndexback to summary
public XrGraphicsBindingVulkanKHR.Buffer queueIndex(int value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#queueIndex field.

selfback to summary
protected XrGraphicsBindingVulkanKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrGraphicsBindingVulkanKHR#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrGraphicsBindingVulkanKHR.Buffer type(int value)

Sets the specified value to the XrGraphicsBindingVulkanKHR#type field.

type$Defaultback to summary
public XrGraphicsBindingVulkanKHR.Buffer type$Default()

Sets the TYPE_GRAPHICS_BINDING_VULKAN_KHR value to the XrGraphicsBindingVulkanKHR#type field.