Package org.lwjgl.openxr

Class XrVulkanSwapchainFormatListCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVulkanSwapchainFormatListCreateInfoKHR>

org.lwjgl.openxr.XrVulkanSwapchainFormatListCreateInfoKHR

All Implemented Interfaces:

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

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

A list of Vulkan view formats.

Valid Usage (Implicit)

• The XR_KHR_vulkan_swapchain_format_list extension must be enabled prior to using XrVulkanSwapchainFormatListCreateInfoKHR
• type must be TYPE_VULKAN_SWAPCHAIN_FORMAT_LIST_CREATE_INFO_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• If viewFormatCount is not 0, viewFormats must be a pointer to an array of viewFormatCount valid VkFormat values

See Also

CreateSwapchain

Layout

 struct XrVulkanSwapchainFormatListCreateInfoKHR {
     XrStructureType type();
     void const * next();
     uint32_t viewFormatCount();
     VkFormat const * viewFormats();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	An array of XrVulkanSwapchainFormatListCreateInfoKHR 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	TYPE	The struct member offsets.
static final int	VIEWFORMATCOUNT	The struct member offsets.
static final int	VIEWFORMATS	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
XrVulkanSwapchainFormatListCreateInfoKHR(ByteBuffer container)	Creates a XrVulkanSwapchainFormatListCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrVulkanSwapchainFormatListCreateInfoKHR	calloc()	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with memCalloc.
static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with memCalloc.
static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanSwapchainFormatListCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanSwapchainFormatListCreateInfoKHR	create()	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with BufferUtils.
static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	create(int capacity)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with BufferUtils.
static XrVulkanSwapchainFormatListCreateInfoKHR	create(long address)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance for the specified memory address.
static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	create(long address, int capacity)	Create a XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable XrVulkanSwapchainFormatListCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrVulkanSwapchainFormatListCreateInfoKHR	malloc()	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with memAlloc.
static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with memAlloc.
static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static XrVulkanSwapchainFormatListCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrVulkanSwapchainFormatListCreateInfoKHR	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 int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static int	nviewFormatCount(long struct)	Unsafe version of viewFormatCount().
static void	nviewFormatCount(long struct, int value)	Sets the specified value to the viewFormatCount field of the specified struct.
static @Nullable IntBuffer	nviewFormats(long struct)	Unsafe version of viewFormats.
static void	nviewFormats(long struct, @Nullable IntBuffer value)	Unsafe version of viewFormats.
XrVulkanSwapchainFormatListCreateInfoKHR	set(int type, long next, @Nullable IntBuffer viewFormats)	Initializes this struct with the specified values.
XrVulkanSwapchainFormatListCreateInfoKHR	set(XrVulkanSwapchainFormatListCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrVulkanSwapchainFormatListCreateInfoKHR	type(int value)	Sets the specified value to the type() field.
XrVulkanSwapchainFormatListCreateInfoKHR	type$Default()	Sets the TYPE_VULKAN_SWAPCHAIN_FORMAT_LIST_CREATE_INFO_KHR value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	viewFormatCount()	the number of view formats passed in viewFormats.
@Nullable IntBuffer	viewFormats()	an array of VkFormat.
XrVulkanSwapchainFormatListCreateInfoKHR	viewFormats(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the viewFormats() 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.

VIEWFORMATCOUNT

public static final int VIEWFORMATCOUNT

The struct member offsets.

VIEWFORMATS

public static final int VIEWFORMATS

The struct member offsets.

Constructor Details

XrVulkanSwapchainFormatListCreateInfoKHR

public XrVulkanSwapchainFormatListCreateInfoKHR(ByteBuffer container)

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

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.

viewFormatCount

public int viewFormatCount()

the number of view formats passed in viewFormats.

viewFormats

public @Nullable IntBuffer viewFormats()

an array of VkFormat.

type

public XrVulkanSwapchainFormatListCreateInfoKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrVulkanSwapchainFormatListCreateInfoKHR type$Default()

Sets the TYPE_VULKAN_SWAPCHAIN_FORMAT_LIST_CREATE_INFO_KHR value to the type() field.

next

public XrVulkanSwapchainFormatListCreateInfoKHR next(long value)

Sets the specified value to the next() field.

viewFormats

public XrVulkanSwapchainFormatListCreateInfoKHR viewFormats(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the viewFormats() field.

set

public XrVulkanSwapchainFormatListCreateInfoKHR set(int type,
 long next,
 @Nullable IntBuffer viewFormats)

Initializes this struct with the specified values.

set

public XrVulkanSwapchainFormatListCreateInfoKHR set(XrVulkanSwapchainFormatListCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVulkanSwapchainFormatListCreateInfoKHR malloc()

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

calloc

public static XrVulkanSwapchainFormatListCreateInfoKHR calloc()

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

create

public static XrVulkanSwapchainFormatListCreateInfoKHR create()

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with BufferUtils.

create

public static XrVulkanSwapchainFormatListCreateInfoKHR create(long address)

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable XrVulkanSwapchainFormatListCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVulkanSwapchainFormatListCreateInfoKHR.Buffer create(int capacity)

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nviewFormatCount

public static int nviewFormatCount(long struct)

Unsafe version of viewFormatCount().

nviewFormats

public static @Nullable IntBuffer nviewFormats(long struct)

Unsafe version of viewFormats.

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.

nviewFormatCount

public static void nviewFormatCount(long struct,
 int value)

Sets the specified value to the viewFormatCount field of the specified struct.

nviewFormats

public static void nviewFormats(long struct,
 @Nullable IntBuffer value)

Unsafe version of viewFormats.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate