Package org.lwjgl.openxr

Class XrVulkanGraphicsDeviceGetInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVulkanGraphicsDeviceGetInfoKHR>

org.lwjgl.openxr.XrVulkanGraphicsDeviceGetInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrVulkanGraphicsDeviceGetInfoKHR
extends org.lwjgl.system.Struct<XrVulkanGraphicsDeviceGetInfoKHR>
implements org.lwjgl.system.NativeResource

Vulkan Graphics Device Get Info.

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable2 extension must be enabled prior to using XrVulkanGraphicsDeviceGetInfoKHR
• type must be TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• vulkanInstance must be a valid VkInstance value

See Also

GetVulkanGraphicsDevice2KHR

Layout

 struct XrVulkanGraphicsDeviceGetInfoKHR {
     XrStructureType type();
     void const * next();
     XrSystemId systemId();
     VkInstance vulkanInstance();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrVulkanGraphicsDeviceGetInfoKHR.Buffer	An array of XrVulkanGraphicsDeviceGetInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SYSTEMID	The struct member offsets.
static final int	TYPE	The struct member offsets.
static final int	VULKANINSTANCE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrVulkanGraphicsDeviceGetInfoKHR(ByteBuffer container)	Creates a XrVulkanGraphicsDeviceGetInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrVulkanGraphicsDeviceGetInfoKHR	calloc()	Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance allocated with memCalloc.
static XrVulkanGraphicsDeviceGetInfoKHR.Buffer	calloc(int capacity)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance allocated with memCalloc.
static XrVulkanGraphicsDeviceGetInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanGraphicsDeviceGetInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanGraphicsDeviceGetInfoKHR	create()	Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance allocated with BufferUtils.
static XrVulkanGraphicsDeviceGetInfoKHR.Buffer	create(int capacity)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance allocated with BufferUtils.
static XrVulkanGraphicsDeviceGetInfoKHR	create(long address)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance for the specified memory address.
static XrVulkanGraphicsDeviceGetInfoKHR.Buffer	create(long address, int capacity)	Create a XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance at the specified memory.
static @Nullable XrVulkanGraphicsDeviceGetInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVulkanGraphicsDeviceGetInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrVulkanGraphicsDeviceGetInfoKHR	malloc()	Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance allocated with memAlloc.
static XrVulkanGraphicsDeviceGetInfoKHR.Buffer	malloc(int capacity)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance allocated with memAlloc.
static XrVulkanGraphicsDeviceGetInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance allocated on the specified MemoryStack.
static XrVulkanGraphicsDeviceGetInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrVulkanGraphicsDeviceGetInfoKHR	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	nsystemId(long struct)	Unsafe version of systemId().
static void	nsystemId(long struct, long value)	Unsafe version of systemId.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static long	nvulkanInstance(long struct)	Unsafe version of vulkanInstance().
static void	nvulkanInstance(long struct, org.lwjgl.vulkan.VkInstance value)	Unsafe version of vulkanInstance.
XrVulkanGraphicsDeviceGetInfoKHR	set(int type, long next, long systemId, org.lwjgl.vulkan.VkInstance vulkanInstance)	Initializes this struct with the specified values.
XrVulkanGraphicsDeviceGetInfoKHR	set(XrVulkanGraphicsDeviceGetInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
long	systemId()	an XrSystemId handle for the system which will be used to create a session.
XrVulkanGraphicsDeviceGetInfoKHR	systemId(long value)	Sets the specified value to the systemId() field.
int	type()	the XrStructureType of this structure.
XrVulkanGraphicsDeviceGetInfoKHR	type(int value)	Sets the specified value to the type() field.
XrVulkanGraphicsDeviceGetInfoKHR	type$Default()	Sets the TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
long	vulkanInstance()	a valid Vulkan VkInstance.
XrVulkanGraphicsDeviceGetInfoKHR	vulkanInstance(org.lwjgl.vulkan.VkInstance value)	Sets the specified value to the vulkanInstance() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

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.

VULKANINSTANCE

public static final int VULKANINSTANCE

The struct member offsets.

Constructor Details

XrVulkanGraphicsDeviceGetInfoKHR

public XrVulkanGraphicsDeviceGetInfoKHR(ByteBuffer container)

Creates a XrVulkanGraphicsDeviceGetInfoKHR 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<XrVulkanGraphicsDeviceGetInfoKHR>

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.

vulkanInstance

public long vulkanInstance()

a valid Vulkan VkInstance.

type

public XrVulkanGraphicsDeviceGetInfoKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrVulkanGraphicsDeviceGetInfoKHR type$Default()

Sets the TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR value to the type() field.

next

public XrVulkanGraphicsDeviceGetInfoKHR next(long value)

Sets the specified value to the next() field.

systemId

public XrVulkanGraphicsDeviceGetInfoKHR systemId(long value)

Sets the specified value to the systemId() field.

vulkanInstance

public XrVulkanGraphicsDeviceGetInfoKHR vulkanInstance(org.lwjgl.vulkan.VkInstance value)

Sets the specified value to the vulkanInstance() field.

set

public XrVulkanGraphicsDeviceGetInfoKHR set(int type,
 long next,
 long systemId,
 org.lwjgl.vulkan.VkInstance vulkanInstance)

Initializes this struct with the specified values.

set

public XrVulkanGraphicsDeviceGetInfoKHR set(XrVulkanGraphicsDeviceGetInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVulkanGraphicsDeviceGetInfoKHR malloc()

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

calloc

public static XrVulkanGraphicsDeviceGetInfoKHR calloc()

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

create

public static XrVulkanGraphicsDeviceGetInfoKHR create()

Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance allocated with BufferUtils.

create

public static XrVulkanGraphicsDeviceGetInfoKHR create(long address)

Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance for the specified memory address.

createSafe

public static @Nullable XrVulkanGraphicsDeviceGetInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVulkanGraphicsDeviceGetInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVulkanGraphicsDeviceGetInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVulkanGraphicsDeviceGetInfoKHR.Buffer create(int capacity)

Returns a new XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XrVulkanGraphicsDeviceGetInfoKHR.Buffer create(long address,
 int capacity)

Create a XrVulkanGraphicsDeviceGetInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrVulkanGraphicsDeviceGetInfoKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static XrVulkanGraphicsDeviceGetInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrVulkanGraphicsDeviceGetInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrVulkanGraphicsDeviceGetInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrVulkanGraphicsDeviceGetInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrVulkanGraphicsDeviceGetInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new XrVulkanGraphicsDeviceGetInfoKHR.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().

nvulkanInstance

public static long nvulkanInstance(long struct)

Unsafe version of vulkanInstance().

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.

nvulkanInstance

public static void nvulkanInstance(long struct,
 org.lwjgl.vulkan.VkInstance value)

Unsafe version of vulkanInstance.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate