Package org.lwjgl.openxr

Class XrVulkanSwapchainCreateInfoMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVulkanSwapchainCreateInfoMETA>

org.lwjgl.openxr.XrVulkanSwapchainCreateInfoMETA

All Implemented Interfaces:

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

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

Debug utils object name info.

Description

The runtime must return ERROR_FEATURE_UNSUPPORTED if any bit of either additionalCreateFlags or additionalUsageFlags is not supported.

Valid Usage (Implicit)

• The XR_META_vulkan_swapchain_create_info extension must be enabled prior to using XrVulkanSwapchainCreateInfoMETA
• type must be TYPE_VULKAN_SWAPCHAIN_CREATE_INFO_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• additionalCreateFlags must be a valid VkImageCreateFlags value
• additionalUsageFlags must be a valid VkImageUsageFlags value

Layout

 struct XrVulkanSwapchainCreateInfoMETA {
     XrStructureType type();
     void const * next();
     VkImageCreateFlags additionalCreateFlags();
     VkImageUsageFlags additionalUsageFlags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrVulkanSwapchainCreateInfoMETA.Buffer	An array of XrVulkanSwapchainCreateInfoMETA 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	ADDITIONALCREATEFLAGS	The struct member offsets.
static final int	ADDITIONALUSAGEFLAGS	The struct member offsets.
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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	additionalCreateFlags()	a bitmask of VkImageCreateFlags describing additional parameters of an image.
XrVulkanSwapchainCreateInfoMETA	additionalCreateFlags(int value)	Sets the specified value to the additionalCreateFlags() field.
int	additionalUsageFlags()	a bitmask of VkImageUsageFlags describing additional parameters of an image.
XrVulkanSwapchainCreateInfoMETA	additionalUsageFlags(int value)	Sets the specified value to the additionalUsageFlags() field.
static XrVulkanSwapchainCreateInfoMETA	calloc()	Returns a new XrVulkanSwapchainCreateInfoMETA instance allocated with memCalloc.
static XrVulkanSwapchainCreateInfoMETA.Buffer	calloc(int capacity)	Returns a new XrVulkanSwapchainCreateInfoMETA.Buffer instance allocated with memCalloc.
static XrVulkanSwapchainCreateInfoMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainCreateInfoMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanSwapchainCreateInfoMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainCreateInfoMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanSwapchainCreateInfoMETA	create()	Returns a new XrVulkanSwapchainCreateInfoMETA instance allocated with BufferUtils.
static XrVulkanSwapchainCreateInfoMETA.Buffer	create(int capacity)	Returns a new XrVulkanSwapchainCreateInfoMETA.Buffer instance allocated with BufferUtils.
static XrVulkanSwapchainCreateInfoMETA	create(long address)	Returns a new XrVulkanSwapchainCreateInfoMETA instance for the specified memory address.
static XrVulkanSwapchainCreateInfoMETA.Buffer	create(long address, int capacity)	Create a XrVulkanSwapchainCreateInfoMETA.Buffer instance at the specified memory.
static @Nullable XrVulkanSwapchainCreateInfoMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVulkanSwapchainCreateInfoMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrVulkanSwapchainCreateInfoMETA	malloc()	Returns a new XrVulkanSwapchainCreateInfoMETA instance allocated with memAlloc.
static XrVulkanSwapchainCreateInfoMETA.Buffer	malloc(int capacity)	Returns a new XrVulkanSwapchainCreateInfoMETA.Buffer instance allocated with memAlloc.
static XrVulkanSwapchainCreateInfoMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainCreateInfoMETA.Buffer instance allocated on the specified MemoryStack.
static XrVulkanSwapchainCreateInfoMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVulkanSwapchainCreateInfoMETA instance allocated on the specified MemoryStack.
static int	nadditionalCreateFlags(long struct)	Unsafe version of additionalCreateFlags().
static void	nadditionalCreateFlags(long struct, int value)	Unsafe version of additionalCreateFlags.
static int	nadditionalUsageFlags(long struct)	Unsafe version of additionalUsageFlags().
static void	nadditionalUsageFlags(long struct, int value)	Unsafe version of additionalUsageFlags.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrVulkanSwapchainCreateInfoMETA	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.
XrVulkanSwapchainCreateInfoMETA	set(int type, long next, int additionalCreateFlags, int additionalUsageFlags)	Initializes this struct with the specified values.
XrVulkanSwapchainCreateInfoMETA	set(XrVulkanSwapchainCreateInfoMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrVulkanSwapchainCreateInfoMETA	type(int value)	Sets the specified value to the type() field.
XrVulkanSwapchainCreateInfoMETA	type$Default()	Sets the TYPE_VULKAN_SWAPCHAIN_CREATE_INFO_META 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.

ADDITIONALCREATEFLAGS

public static final int ADDITIONALCREATEFLAGS

The struct member offsets.

ADDITIONALUSAGEFLAGS

public static final int ADDITIONALUSAGEFLAGS

The struct member offsets.

Constructor Details

XrVulkanSwapchainCreateInfoMETA

public XrVulkanSwapchainCreateInfoMETA(ByteBuffer container)

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

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.

additionalCreateFlags

public int additionalCreateFlags()

a bitmask of VkImageCreateFlags describing additional parameters of an image.

additionalUsageFlags

public int additionalUsageFlags()

a bitmask of VkImageUsageFlags describing additional parameters of an image.

type

public XrVulkanSwapchainCreateInfoMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrVulkanSwapchainCreateInfoMETA type$Default()

Sets the TYPE_VULKAN_SWAPCHAIN_CREATE_INFO_META value to the type() field.

next

public XrVulkanSwapchainCreateInfoMETA next(long value)

Sets the specified value to the next() field.

additionalCreateFlags

public XrVulkanSwapchainCreateInfoMETA additionalCreateFlags(int value)

Sets the specified value to the additionalCreateFlags() field.

additionalUsageFlags

public XrVulkanSwapchainCreateInfoMETA additionalUsageFlags(int value)

Sets the specified value to the additionalUsageFlags() field.

set

public XrVulkanSwapchainCreateInfoMETA set(int type,
 long next,
 int additionalCreateFlags,
 int additionalUsageFlags)

Initializes this struct with the specified values.

set

public XrVulkanSwapchainCreateInfoMETA set(XrVulkanSwapchainCreateInfoMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVulkanSwapchainCreateInfoMETA malloc()

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

calloc

public static XrVulkanSwapchainCreateInfoMETA calloc()

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

create

public static XrVulkanSwapchainCreateInfoMETA create()

Returns a new XrVulkanSwapchainCreateInfoMETA instance allocated with BufferUtils.

create

public static XrVulkanSwapchainCreateInfoMETA create(long address)

Returns a new XrVulkanSwapchainCreateInfoMETA instance for the specified memory address.

createSafe

public static @Nullable XrVulkanSwapchainCreateInfoMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVulkanSwapchainCreateInfoMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVulkanSwapchainCreateInfoMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVulkanSwapchainCreateInfoMETA.Buffer create(int capacity)

Returns a new XrVulkanSwapchainCreateInfoMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrVulkanSwapchainCreateInfoMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrVulkanSwapchainCreateInfoMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nadditionalCreateFlags

public static int nadditionalCreateFlags(long struct)

Unsafe version of additionalCreateFlags().

nadditionalUsageFlags

public static int nadditionalUsageFlags(long struct)

Unsafe version of additionalUsageFlags().

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.

nadditionalCreateFlags

public static void nadditionalCreateFlags(long struct,
 int value)

Unsafe version of additionalCreateFlags.

nadditionalUsageFlags

public static void nadditionalUsageFlags(long struct,
 int value)

Unsafe version of additionalUsageFlags.