Package org.lwjgl.openxr
Class XrSwapchainImageVulkanKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrSwapchainImageVulkanKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
XrSwapchainImageVulkan2KHR
public class XrSwapchainImageVulkanKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceVulkan-specific swapchain image structure.Description
If a given session was created with
XrGraphicsBindingVulkanKHR, the following conditions must apply.- Calls to
EnumerateSwapchainImageson anXrSwapchainin that session must return an array ofXrSwapchainImageVulkanKHRstructures. - Whenever an OpenXR function accepts an
XrSwapchainImageBaseHeaderpointer as a parameter in that session, the runtime must also accept a pointer to anXrSwapchainImageVulkanKHR.
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_enableextension must be enabled prior to usingXrSwapchainImageVulkanKHR typemust beTYPE_SWAPCHAIN_IMAGE_VULKAN_KHRnextmust beNULLor a valid pointer to the next structure in a structure chain. See also:XrSwapchainImageFoveationVulkanFBimagemust be a validVkImagevalue
See Also
Layout
struct XrSwapchainImageVulkanKHR { XrStructureTypetype(); void *next(); VkImageimage(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrSwapchainImageVulkanKHR.BufferAn array ofXrSwapchainImageVulkanKHRstructs.
-
Constructor Summary
Constructors Constructor Description XrSwapchainImageVulkanKHR(java.nio.ByteBuffer container)Creates aXrSwapchainImageVulkanKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrSwapchainImageVulkanKHRcalloc()Returns a newXrSwapchainImageVulkanKHRinstance allocated withmemCalloc.static XrSwapchainImageVulkanKHR.Buffercalloc(int capacity)Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated withmemCalloc.static XrSwapchainImageVulkanKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSwapchainImageVulkanKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageVulkanKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSwapchainImageVulkanKHRcreate()Returns a newXrSwapchainImageVulkanKHRinstance allocated withBufferUtils.static XrSwapchainImageVulkanKHR.Buffercreate(int capacity)Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated withBufferUtils.static XrSwapchainImageVulkanKHRcreate(long address)Returns a newXrSwapchainImageVulkanKHRinstance for the specified memory address.static XrSwapchainImageVulkanKHR.Buffercreate(long address, int capacity)Create aXrSwapchainImageVulkanKHR.Bufferinstance at the specified memory.static XrSwapchainImageVulkanKHRcreate(XrSwapchainImageBaseHeader value)Downcasts the specifiedXrSwapchainImageBaseHeaderinstance toXrSwapchainImageVulkanKHR.static XrSwapchainImageVulkanKHR.Buffercreate(XrSwapchainImageBaseHeader.Buffer value)Downcasts the specifiedXrSwapchainImageBaseHeader.Bufferinstance toXrSwapchainImageVulkanKHR.Buffer.static XrSwapchainImageVulkanKHRcreateSafe(long address)static XrSwapchainImageVulkanKHR.BuffercreateSafe(long address, int capacity)longimage()a valid VulkanVkImageto use.XrSwapchainImageVulkanKHRimage(long value)Sets the specified value to theimage()field.static XrSwapchainImageVulkanKHRmalloc()Returns a newXrSwapchainImageVulkanKHRinstance allocated withmemAlloc.static XrSwapchainImageVulkanKHR.Buffermalloc(int capacity)Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated withmemAlloc.static XrSwapchainImageVulkanKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated on the specifiedMemoryStack.static XrSwapchainImageVulkanKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageVulkanKHRinstance allocated on the specifiedMemoryStack.longnext()NULLor a pointer to the next structure in a structure chain.XrSwapchainImageVulkanKHRnext(long value)Sets the specified value to thenext()field.XrSwapchainImageVulkanKHRnext(XrSwapchainImageFoveationVulkanFB value)Prepends the specifiedXrSwapchainImageFoveationVulkanFBvalue to thenextchain.static longnimage(long struct)Unsafe version ofimage().static voidnimage(long struct, long value)Unsafe version ofimage.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrSwapchainImageVulkanKHRset(int type, long next, long image)Initializes this struct with the specified values.XrSwapchainImageVulkanKHRset(XrSwapchainImageVulkanKHR src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrSwapchainImageVulkanKHRtype(int value)Sets the specified value to thetype()field.XrSwapchainImageVulkanKHRtype$Default()Sets theTYPE_SWAPCHAIN_IMAGE_VULKAN_KHRvalue to thetype()field.
-
-
-
Constructor Detail
-
XrSwapchainImageVulkanKHR
public XrSwapchainImageVulkanKHR(java.nio.ByteBuffer container)
Creates aXrSwapchainImageVulkanKHRinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor 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 VulkanVkImageto use.
-
type
public XrSwapchainImageVulkanKHR type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrSwapchainImageVulkanKHR type$Default()
Sets theTYPE_SWAPCHAIN_IMAGE_VULKAN_KHRvalue to thetype()field.
-
next
public XrSwapchainImageVulkanKHR next(long value)
Sets the specified value to thenext()field.
-
next
public XrSwapchainImageVulkanKHR next(XrSwapchainImageFoveationVulkanFB value)
Prepends the specifiedXrSwapchainImageFoveationVulkanFBvalue to thenextchain.
-
image
public XrSwapchainImageVulkanKHR image(long value)
Sets the specified value to theimage()field.
-
set
public XrSwapchainImageVulkanKHR set(int type, long next, long image)
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 newXrSwapchainImageVulkanKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrSwapchainImageVulkanKHR calloc()
Returns a newXrSwapchainImageVulkanKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrSwapchainImageVulkanKHR create()
Returns a newXrSwapchainImageVulkanKHRinstance allocated withBufferUtils.
-
create
public static XrSwapchainImageVulkanKHR create(long address)
Returns a newXrSwapchainImageVulkanKHRinstance for the specified memory address.
-
createSafe
@Nullable public static XrSwapchainImageVulkanKHR createSafe(long address)
-
create
public static XrSwapchainImageVulkanKHR create(XrSwapchainImageBaseHeader value)
Downcasts the specifiedXrSwapchainImageBaseHeaderinstance toXrSwapchainImageVulkanKHR.
-
malloc
public static XrSwapchainImageVulkanKHR.Buffer malloc(int capacity)
Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrSwapchainImageVulkanKHR.Buffer calloc(int capacity)
Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrSwapchainImageVulkanKHR.Buffer create(int capacity)
Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrSwapchainImageVulkanKHR.Buffer create(long address, int capacity)
Create aXrSwapchainImageVulkanKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrSwapchainImageVulkanKHR.Buffer createSafe(long address, int capacity)
-
create
public static XrSwapchainImageVulkanKHR.Buffer create(XrSwapchainImageBaseHeader.Buffer value)
Downcasts the specifiedXrSwapchainImageBaseHeader.Bufferinstance toXrSwapchainImageVulkanKHR.Buffer.
-
malloc
public static XrSwapchainImageVulkanKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainImageVulkanKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrSwapchainImageVulkanKHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainImageVulkanKHRinstance allocated on the specifiedMemoryStackand 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 newXrSwapchainImageVulkanKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrSwapchainImageVulkanKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainImageVulkanKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nimage
public static long nimage(long struct)
Unsafe version ofimage().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nimage
public static void nimage(long struct, long value)Unsafe version ofimage.
-
-