Package org.lwjgl.openxr

Class XrSwapchainImageVulkanKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainImageVulkanKHR>

org.lwjgl.openxr.XrSwapchainImageVulkanKHR

All Implemented Interfaces:

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

Direct Known Subclasses:

XrSwapchainImageVulkan2KHR

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

Vulkan-specific swapchain image structure.

Description

If a given session was created with XrGraphicsBindingVulkanKHR, the following conditions must apply.

• Calls to EnumerateSwapchainImages on an XrSwapchain in that session must return an array of XrSwapchainImageVulkanKHR structures.
• Whenever an OpenXR function accepts an XrSwapchainImageBaseHeader pointer as a parameter in that session, the runtime must also accept a pointer to an XrSwapchainImageVulkanKHR.

The OpenXR runtime must interpret the top-left corner of the swapchain image as the coordinate origin unless specified otherwise by extension functionality.

The OpenXR runtime must interpret the swapchain images in a clip space of positive Y pointing down, near Z plane at 0, and far Z plane at 1.

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable extension must be enabled prior to using XrSwapchainImageVulkanKHR
• type must be TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrSwapchainImageFoveationVulkanFB

See Also

XrSwapchainImageBaseHeader

Layout

 struct XrSwapchainImageVulkanKHR {
     XrStructureType type();
     void * next();
     VkImage image();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSwapchainImageVulkanKHR.Buffer	An array of XrSwapchainImageVulkanKHR 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	IMAGE	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
XrSwapchainImageVulkanKHR(ByteBuffer container)	Creates a XrSwapchainImageVulkanKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSwapchainImageVulkanKHR	calloc()	Returns a new XrSwapchainImageVulkanKHR instance allocated with memCalloc.
static XrSwapchainImageVulkanKHR.Buffer	calloc(int capacity)	Returns a new XrSwapchainImageVulkanKHR.Buffer instance allocated with memCalloc.
static XrSwapchainImageVulkanKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageVulkanKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainImageVulkanKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageVulkanKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainImageVulkanKHR	create()	Returns a new XrSwapchainImageVulkanKHR instance allocated with BufferUtils.
static XrSwapchainImageVulkanKHR.Buffer	create(int capacity)	Returns a new XrSwapchainImageVulkanKHR.Buffer instance allocated with BufferUtils.
static XrSwapchainImageVulkanKHR	create(long address)	Returns a new XrSwapchainImageVulkanKHR instance for the specified memory address.
static XrSwapchainImageVulkanKHR.Buffer	create(long address, int capacity)	Create a XrSwapchainImageVulkanKHR.Buffer instance at the specified memory.
static XrSwapchainImageVulkanKHR	create(XrSwapchainImageBaseHeader value)	Downcasts the specified XrSwapchainImageBaseHeader instance to XrSwapchainImageVulkanKHR.
static XrSwapchainImageVulkanKHR.Buffer	create(XrSwapchainImageBaseHeader.Buffer value)	Downcasts the specified XrSwapchainImageBaseHeader.Buffer instance to XrSwapchainImageVulkanKHR.Buffer.
static @Nullable XrSwapchainImageVulkanKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSwapchainImageVulkanKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()	a valid Vulkan VkImage to use.
static XrSwapchainImageVulkanKHR	malloc()	Returns a new XrSwapchainImageVulkanKHR instance allocated with memAlloc.
static XrSwapchainImageVulkanKHR.Buffer	malloc(int capacity)	Returns a new XrSwapchainImageVulkanKHR.Buffer instance allocated with memAlloc.
static XrSwapchainImageVulkanKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageVulkanKHR.Buffer instance allocated on the specified MemoryStack.
static XrSwapchainImageVulkanKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageVulkanKHR instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSwapchainImageVulkanKHR	next(long value)	Sets the specified value to the next() field.
XrSwapchainImageVulkanKHR	next(XrSwapchainImageFoveationVulkanFB value)	Prepends the specified XrSwapchainImageFoveationVulkanFB value to the next chain.
static long	nimage(long struct)	Unsafe version of image().
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.
XrSwapchainImageVulkanKHR	set(int type, long next)	Initializes this struct with the specified values.
XrSwapchainImageVulkanKHR	set(XrSwapchainImageVulkanKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSwapchainImageVulkanKHR	type(int value)	Sets the specified value to the type() field.
XrSwapchainImageVulkanKHR	type$Default()	Sets the TYPE_SWAPCHAIN_IMAGE_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.

IMAGE

public static final int IMAGE

The struct member offsets.

Constructor Details

XrSwapchainImageVulkanKHR

public XrSwapchainImageVulkanKHR(ByteBuffer container)

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

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.

image

public long image()

a valid Vulkan VkImage to use.

type

public XrSwapchainImageVulkanKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrSwapchainImageVulkanKHR type$Default()

Sets the TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR value to the type() field.

next

public XrSwapchainImageVulkanKHR next(long value)

Sets the specified value to the next() field.

next

public XrSwapchainImageVulkanKHR next(XrSwapchainImageFoveationVulkanFB value)

Prepends the specified XrSwapchainImageFoveationVulkanFB value to the next chain.

set

public XrSwapchainImageVulkanKHR set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSwapchainImageVulkanKHR set(XrSwapchainImageVulkanKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainImageVulkanKHR malloc()

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

calloc

public static XrSwapchainImageVulkanKHR calloc()

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

create

public static XrSwapchainImageVulkanKHR create()

Returns a new XrSwapchainImageVulkanKHR instance allocated with BufferUtils.

create

public static XrSwapchainImageVulkanKHR create(long address)

Returns a new XrSwapchainImageVulkanKHR instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainImageVulkanKHR createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSwapchainImageVulkanKHR create(XrSwapchainImageBaseHeader value)

Downcasts the specified XrSwapchainImageBaseHeader instance to XrSwapchainImageVulkanKHR.

malloc

public static XrSwapchainImageVulkanKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainImageVulkanKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainImageVulkanKHR.Buffer create(int capacity)

Returns a new XrSwapchainImageVulkanKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainImageVulkanKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrSwapchainImageVulkanKHR.Buffer create(XrSwapchainImageBaseHeader.Buffer value)

Downcasts the specified XrSwapchainImageBaseHeader.Buffer instance to XrSwapchainImageVulkanKHR.Buffer.

malloc

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

Returns a new XrSwapchainImageVulkanKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nimage

public static long nimage(long struct)

Unsafe version of image().

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.