Package org.lwjgl.openxr

Class XrGraphicsRequirementsVulkanKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrGraphicsRequirementsVulkanKHR>

org.lwjgl.openxr.XrGraphicsRequirementsVulkanKHR

All Implemented Interfaces:

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

Direct Known Subclasses:

XrGraphicsRequirementsVulkan2KHR

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

Vulkan API version requirements.

Description

XrGraphicsRequirementsVulkanKHR is populated by GetVulkanGraphicsRequirementsKHR with the runtime’s Vulkan API version requirements.

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable extension must be enabled prior to using XrGraphicsRequirementsVulkanKHR
• type must be TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

GetVulkanGraphicsRequirements2KHR, GetVulkanGraphicsRequirementsKHR

Layout

 struct XrGraphicsRequirementsVulkanKHR {
     XrStructureType type();
     void * next();
     XrVersion minApiVersionSupported();
     XrVersion maxApiVersionSupported();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrGraphicsRequirementsVulkanKHR.Buffer	An array of XrGraphicsRequirementsVulkanKHR 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	MAXAPIVERSIONSUPPORTED	The struct member offsets.
static final int	MINAPIVERSIONSUPPORTED	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	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
XrGraphicsRequirementsVulkanKHR(ByteBuffer container)	Creates a XrGraphicsRequirementsVulkanKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrGraphicsRequirementsVulkanKHR	calloc()	Returns a new XrGraphicsRequirementsVulkanKHR instance allocated with memCalloc.
static XrGraphicsRequirementsVulkanKHR.Buffer	calloc(int capacity)	Returns a new XrGraphicsRequirementsVulkanKHR.Buffer instance allocated with memCalloc.
static XrGraphicsRequirementsVulkanKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsRequirementsVulkanKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrGraphicsRequirementsVulkanKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsRequirementsVulkanKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrGraphicsRequirementsVulkanKHR	create()	Returns a new XrGraphicsRequirementsVulkanKHR instance allocated with BufferUtils.
static XrGraphicsRequirementsVulkanKHR.Buffer	create(int capacity)	Returns a new XrGraphicsRequirementsVulkanKHR.Buffer instance allocated with BufferUtils.
static XrGraphicsRequirementsVulkanKHR	create(long address)	Returns a new XrGraphicsRequirementsVulkanKHR instance for the specified memory address.
static XrGraphicsRequirementsVulkanKHR.Buffer	create(long address, int capacity)	Create a XrGraphicsRequirementsVulkanKHR.Buffer instance at the specified memory.
static @Nullable XrGraphicsRequirementsVulkanKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrGraphicsRequirementsVulkanKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrGraphicsRequirementsVulkanKHR	malloc()	Returns a new XrGraphicsRequirementsVulkanKHR instance allocated with memAlloc.
static XrGraphicsRequirementsVulkanKHR.Buffer	malloc(int capacity)	Returns a new XrGraphicsRequirementsVulkanKHR.Buffer instance allocated with memAlloc.
static XrGraphicsRequirementsVulkanKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsRequirementsVulkanKHR.Buffer instance allocated on the specified MemoryStack.
static XrGraphicsRequirementsVulkanKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsRequirementsVulkanKHR instance allocated on the specified MemoryStack.
long	maxApiVersionSupported()	the maximum Vulkan Instance API version that the runtime has been tested on and is known to support.
XrGraphicsRequirementsVulkanKHR	maxApiVersionSupported(long value)	Sets the specified value to the maxApiVersionSupported() field.
long	minApiVersionSupported()	the minimum Vulkan Instance API version that the runtime supports.
XrGraphicsRequirementsVulkanKHR	minApiVersionSupported(long value)	Sets the specified value to the minApiVersionSupported() field.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrGraphicsRequirementsVulkanKHR	next(long value)	Sets the specified value to the next() field.
static long	nmaxApiVersionSupported(long struct)	Unsafe version of maxApiVersionSupported().
static void	nmaxApiVersionSupported(long struct, long value)	Unsafe version of maxApiVersionSupported.
static long	nminApiVersionSupported(long struct)	Unsafe version of minApiVersionSupported().
static void	nminApiVersionSupported(long struct, long value)	Unsafe version of minApiVersionSupported.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrGraphicsRequirementsVulkanKHR	set(int type, long next, long minApiVersionSupported, long maxApiVersionSupported)	Initializes this struct with the specified values.
XrGraphicsRequirementsVulkanKHR	set(XrGraphicsRequirementsVulkanKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrGraphicsRequirementsVulkanKHR	type(int value)	Sets the specified value to the type() field.
XrGraphicsRequirementsVulkanKHR	type$Default()	Sets the TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR value to the type() 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.

MINAPIVERSIONSUPPORTED

public static final int MINAPIVERSIONSUPPORTED

The struct member offsets.

MAXAPIVERSIONSUPPORTED

public static final int MAXAPIVERSIONSUPPORTED

The struct member offsets.

Constructor Details

XrGraphicsRequirementsVulkanKHR

public XrGraphicsRequirementsVulkanKHR(ByteBuffer container)

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

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.

minApiVersionSupported

public long minApiVersionSupported()

the minimum Vulkan Instance API version that the runtime supports. Uses XR10.XR_MAKE_VERSION(int, int, int) on major and minor API version, ignoring any patch version component.

maxApiVersionSupported

public long maxApiVersionSupported()

the maximum Vulkan Instance API version that the runtime has been tested on and is known to support. Newer Vulkan Instance API versions might work if they are compatible. Uses XR10.XR_MAKE_VERSION(int, int, int) on major and minor API version, ignoring any patch version component.

type

public XrGraphicsRequirementsVulkanKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrGraphicsRequirementsVulkanKHR type$Default()

Sets the TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR value to the type() field.

next

public XrGraphicsRequirementsVulkanKHR next(long value)

Sets the specified value to the next() field.

minApiVersionSupported

public XrGraphicsRequirementsVulkanKHR minApiVersionSupported(long value)

Sets the specified value to the minApiVersionSupported() field.

maxApiVersionSupported

public XrGraphicsRequirementsVulkanKHR maxApiVersionSupported(long value)

Sets the specified value to the maxApiVersionSupported() field.

set

public XrGraphicsRequirementsVulkanKHR set(int type,
 long next,
 long minApiVersionSupported,
 long maxApiVersionSupported)

Initializes this struct with the specified values.

set

public XrGraphicsRequirementsVulkanKHR set(XrGraphicsRequirementsVulkanKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrGraphicsRequirementsVulkanKHR malloc()

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

calloc

public static XrGraphicsRequirementsVulkanKHR calloc()

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

create

public static XrGraphicsRequirementsVulkanKHR create()

Returns a new XrGraphicsRequirementsVulkanKHR instance allocated with BufferUtils.

create

public static XrGraphicsRequirementsVulkanKHR create(long address)

Returns a new XrGraphicsRequirementsVulkanKHR instance for the specified memory address.

createSafe

public static @Nullable XrGraphicsRequirementsVulkanKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrGraphicsRequirementsVulkanKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrGraphicsRequirementsVulkanKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrGraphicsRequirementsVulkanKHR.Buffer create(int capacity)

Returns a new XrGraphicsRequirementsVulkanKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrGraphicsRequirementsVulkanKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrGraphicsRequirementsVulkanKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nminApiVersionSupported

public static long nminApiVersionSupported(long struct)

Unsafe version of minApiVersionSupported().

nmaxApiVersionSupported

public static long nmaxApiVersionSupported(long struct)

Unsafe version of maxApiVersionSupported().

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.

nminApiVersionSupported

public static void nminApiVersionSupported(long struct,
 long value)

Unsafe version of minApiVersionSupported.

nmaxApiVersionSupported

public static void nmaxApiVersionSupported(long struct,
 long value)

Unsafe version of maxApiVersionSupported.