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

Layout


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

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrSwapchainImageVulkanKHR.Buffer An array of `XrSwapchainImageVulkanKHR` structs.

Field Summary

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

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrSwapchainImageVulkanKHR(long address, ByteBuffer container)
public	XrSwapchainImageVulkanKHR(ByteBuffer container) Creates a `XrSwapchainImageVulkanKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrSwapchainImageVulkanKHR	calloc() Returns a new `XrSwapchainImageVulkanKHR` instance allocated with `memCalloc`.
public static XrSwapchainImageVulkanKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated with `memCalloc`.
public static XrSwapchainImageVulkanKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainImageVulkanKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSwapchainImageVulkanKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrSwapchainImageVulkanKHR	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static XrSwapchainImageVulkanKHR	create() Returns a new `XrSwapchainImageVulkanKHR` instance allocated with `BufferUtils`.
public static XrSwapchainImageVulkanKHR	create(long address) Returns a new `XrSwapchainImageVulkanKHR` instance for the specified memory address.
public static XrSwapchainImageVulkanKHR	create(XrSwapchainImageBaseHeader value) Downcasts the specified `XrSwapchainImageBaseHeader` instance to `XrSwapchainImageVulkanKHR`.
public static XrSwapchainImageVulkanKHR.Buffer	create(int the buffer capacity capacity) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated with `BufferUtils`.
public static XrSwapchainImageVulkanKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSwapchainImageVulkanKHR.Buffer` instance at the specified memory.
public static XrSwapchainImageVulkanKHR.Buffer	create(XrSwapchainImageBaseHeader.Buffer value) Downcasts the specified `XrSwapchainImageBaseHeader.Buffer` instance to `XrSwapchainImageVulkanKHR.Buffer`.
public static XrSwapchainImageVulkanKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSwapchainImageVulkanKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	image() a valid Vulkan `VkImage` to use.
public static XrSwapchainImageVulkanKHR	malloc() Returns a new `XrSwapchainImageVulkanKHR` instance allocated with `memAlloc`.
public static XrSwapchainImageVulkanKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated with `memAlloc`.
public static XrSwapchainImageVulkanKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainImageVulkanKHR` instance allocated on the specified `MemoryStack`.
public static XrSwapchainImageVulkanKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrSwapchainImageVulkanKHR	next(long value) Sets the specified value to the `next` field.
public XrSwapchainImageVulkanKHR	next(XrSwapchainImageFoveationVulkanFB value) Prepends the specified `XrSwapchainImageFoveationVulkanFB` value to the `next` chain.
public static long	nimage(long struct) Unsafe version of `image`.
public static long	nnext(long struct) Unsafe version of `next`.
public static void	nnext(long struct, long value) Unsafe version of `next`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public XrSwapchainImageVulkanKHR	set(int type, long next) Initializes this struct with the specified values.
public XrSwapchainImageVulkanKHR	Returns: this struct set(XrSwapchainImageVulkanKHR the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	type() the `XrStructureType` of this structure.
public XrSwapchainImageVulkanKHR	type(int value) Sets the specified value to the `type` field.
public XrSwapchainImageVulkanKHR	type$Default() Sets the `TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR` value to the `type` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

IMAGE	back to summary
public static final int IMAGE The struct member offsets.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

XrSwapchainImageVulkanKHR	back to summary
protected XrSwapchainImageVulkanKHR(long address, ByteBuffer container)

XrSwapchainImageVulkanKHR back to summary

XrSwapchainImageVulkanKHR	back to summary
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.

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 Detail

calloc	back to summary
public static XrSwapchainImageVulkanKHR calloc() Returns a new `XrSwapchainImageVulkanKHR` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrSwapchainImageVulkanKHR.Buffer calloc(int capacity) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSwapchainImageVulkanKHR.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrSwapchainImageVulkanKHR calloc(MemoryStack stack) Returns a new `XrSwapchainImageVulkanKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSwapchainImageVulkanKHR calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrSwapchainImageVulkanKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected XrSwapchainImageVulkanKHR create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected XrSwapchainImageVulkanKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static XrSwapchainImageVulkanKHR create() Returns a new `XrSwapchainImageVulkanKHR` instance allocated with `BufferUtils`.

create	back to summary
public static XrSwapchainImageVulkanKHR create(long address) Returns a new `XrSwapchainImageVulkanKHR` instance for the specified memory address.

create	back to summary
public static XrSwapchainImageVulkanKHR create(XrSwapchainImageBaseHeader value) Downcasts the specified `XrSwapchainImageBaseHeader` instance to `XrSwapchainImageVulkanKHR`.

create back to summary

create	back to summary
public static XrSwapchainImageVulkanKHR.Buffer create(int capacity) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrSwapchainImageVulkanKHR.Buffer create(int capacity)

Returns a new XrSwapchainImageVulkanKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrSwapchainImageVulkanKHR.Buffer create(long address, int capacity) Create a `XrSwapchainImageVulkanKHR.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrSwapchainImageVulkanKHR.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

create	back to summary
public static XrSwapchainImageVulkanKHR.Buffer create(XrSwapchainImageBaseHeader.Buffer value) Downcasts the specified `XrSwapchainImageBaseHeader.Buffer` instance to `XrSwapchainImageVulkanKHR.Buffer`.

createSafe back to summary

createSafe	back to summary
public static XrSwapchainImageVulkanKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSwapchainImageVulkanKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrSwapchainImageVulkanKHR.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

image back to summary

image	back to summary
public long image() a valid Vulkan `VkImage` to use. Annotations @NativeType:VkImage

public long image()

a valid Vulkan VkImage to use.

Annotations

@NativeType:VkImage

malloc	back to summary
public static XrSwapchainImageVulkanKHR malloc() Returns a new `XrSwapchainImageVulkanKHR` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrSwapchainImageVulkanKHR.Buffer malloc(int capacity) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSwapchainImageVulkanKHR.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrSwapchainImageVulkanKHR malloc(MemoryStack stack) Returns a new `XrSwapchainImageVulkanKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSwapchainImageVulkanKHR malloc(MemoryStack stack)

Returns a new XrSwapchainImageVulkanKHR instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrSwapchainImageVulkanKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSwapchainImageVulkanKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back to summary
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. Annotations @NativeType:void *

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.

Annotations

@NativeType:void *

next	back to summary
public XrSwapchainImageVulkanKHR next(long value) Sets the specified value to the `next` field.

next	back to summary
public XrSwapchainImageVulkanKHR next(XrSwapchainImageFoveationVulkanFB value) Prepends the specified `XrSwapchainImageFoveationVulkanFB` value to the `next` chain.

nimage	back to summary
public static long nimage(long struct) Unsafe version of `image`.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

set	back to summary
public XrSwapchainImageVulkanKHR set(int type, long next) Initializes this struct with the specified values.

set	back to summary
public XrSwapchainImageVulkanKHR set(XrSwapchainImageVulkanKHR src) Copies the specified struct data to this struct. Parameters src:XrSwapchainImageVulkanKHR the source struct Returns:XrSwapchainImageVulkanKHR this struct

set

back to summary

public XrSwapchainImageVulkanKHR set(XrSwapchainImageVulkanKHR src)

Copies the specified struct data to this struct.

Parameters

src:XrSwapchainImageVulkanKHR: the source struct

Returns:XrSwapchainImageVulkanKHR

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrSwapchainImageVulkanKHR type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrSwapchainImageVulkanKHR type$Default() Sets the `TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrSwapchainImageVulkanKHR.Buffer

Class Inheritance

extends StructBuffer<XrSwapchainImageVulkanKHR, XrSwapchainImageVulkanKHR.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrSwapchainImageVulkanKHR.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

Known Direct Subclasses

org.lwjgl.openxr.XrSwapchainImageVulkan2KHR.Buffer

An array of XrSwapchainImageVulkanKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSwapchainImageVulkanKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSwapchainImageVulkanKHR.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected XrSwapchainImageVulkanKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrSwapchainImageVulkanKHR#image` field. image()
public long	Returns: the value of the `XrSwapchainImageVulkanKHR#next` field. next()
public XrSwapchainImageVulkanKHR.Buffer	next(long value) Sets the specified value to the `XrSwapchainImageVulkanKHR#next` field.
public XrSwapchainImageVulkanKHR.Buffer	next(XrSwapchainImageFoveationVulkanFB value) Prepends the specified `XrSwapchainImageFoveationVulkanFB` value to the `next` chain.
protected XrSwapchainImageVulkanKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrSwapchainImageVulkanKHR#type` field. type()
public XrSwapchainImageVulkanKHR.Buffer	type(int value) Sets the specified value to the `XrSwapchainImageVulkanKHR#type` field.
public XrSwapchainImageVulkanKHR.Buffer	type$Default() Sets the `TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR` value to the `XrSwapchainImageVulkanKHR#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrSwapchainImageVulkanKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrSwapchainImageVulkanKHR.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `XrSwapchainImageVulkanKHR#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrSwapchainImageVulkanKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrSwapchainImageVulkanKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory

back to summary

protected XrSwapchainImageVulkanKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

image	back to summary
public long image() Returns:long the value of the `XrSwapchainImageVulkanKHR#image` field. Annotations @NativeType:VkImage

next	back to summary
public long next() Returns:long the value of the `XrSwapchainImageVulkanKHR#next` field. Annotations @NativeType:void *

next	back to summary
public XrSwapchainImageVulkanKHR.Buffer next(long value) Sets the specified value to the `XrSwapchainImageVulkanKHR#next` field.

next	back to summary
public XrSwapchainImageVulkanKHR.Buffer next(XrSwapchainImageFoveationVulkanFB value) Prepends the specified `XrSwapchainImageFoveationVulkanFB` value to the `next` chain.

self

back to summary

protected XrSwapchainImageVulkanKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

type	back to summary
public int type() Returns:int the value of the `XrSwapchainImageVulkanKHR#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrSwapchainImageVulkanKHR.Buffer type(int value) Sets the specified value to the `XrSwapchainImageVulkanKHR#type` field.

type$Default	back to summary
public XrSwapchainImageVulkanKHR.Buffer type$Default() Sets the `TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR` value to the `XrSwapchainImageVulkanKHR#type` field.

public Class XrSwapchainImageVulkanKHR

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrSwapchainImageVulkanKHR.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail