Package org.lwjgl.openxr
Class XrSwapchainImageOpenGLKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrSwapchainImageOpenGLKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrSwapchainImageOpenGLKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceOpenGL-specific swapchain image structure.Description
If a given session was created with a stext:XrGraphicsBindingOpenGL*KHR, the following conditions must apply.
- Calls to
EnumerateSwapchainImageson anXrSwapchainin that session must return an array ofXrSwapchainImageOpenGLKHRstructures. - Whenever an OpenXR function accepts an
XrSwapchainImageBaseHeaderpointer as a parameter in that session, the runtime must also accept a pointer to anXrSwapchainImageOpenGLKHR.
The OpenXR runtime must interpret the bottom-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 up, near Z plane at -1, and far Z plane at 1.
Valid Usage (Implicit)
- The
XR_KHR_opengl_enableextension must be enabled prior to usingXrSwapchainImageOpenGLKHR typemust beTYPE_SWAPCHAIN_IMAGE_OPENGL_KHRnextmust beNULLor a valid pointer to the next structure in a structure chain
See Also
Layout
struct XrSwapchainImageOpenGLKHR { XrStructureTypetype(); void *next(); uint32_timage(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrSwapchainImageOpenGLKHR.BufferAn array ofXrSwapchainImageOpenGLKHRstructs.
-
Constructor Summary
Constructors Constructor Description XrSwapchainImageOpenGLKHR(java.nio.ByteBuffer container)Creates aXrSwapchainImageOpenGLKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrSwapchainImageOpenGLKHRcalloc()Returns a newXrSwapchainImageOpenGLKHRinstance allocated withmemCalloc.static XrSwapchainImageOpenGLKHR.Buffercalloc(int capacity)Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated withmemCalloc.static XrSwapchainImageOpenGLKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSwapchainImageOpenGLKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageOpenGLKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSwapchainImageOpenGLKHRcreate()Returns a newXrSwapchainImageOpenGLKHRinstance allocated withBufferUtils.static XrSwapchainImageOpenGLKHR.Buffercreate(int capacity)Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated withBufferUtils.static XrSwapchainImageOpenGLKHRcreate(long address)Returns a newXrSwapchainImageOpenGLKHRinstance for the specified memory address.static XrSwapchainImageOpenGLKHR.Buffercreate(long address, int capacity)Create aXrSwapchainImageOpenGLKHR.Bufferinstance at the specified memory.static XrSwapchainImageOpenGLKHRcreate(XrSwapchainImageBaseHeader value)Downcasts the specifiedXrSwapchainImageBaseHeaderinstance toXrSwapchainImageOpenGLKHR.static XrSwapchainImageOpenGLKHR.Buffercreate(XrSwapchainImageBaseHeader.Buffer value)Downcasts the specifiedXrSwapchainImageBaseHeader.Bufferinstance toXrSwapchainImageOpenGLKHR.Buffer.static XrSwapchainImageOpenGLKHRcreateSafe(long address)static XrSwapchainImageOpenGLKHR.BuffercreateSafe(long address, int capacity)intimage()the OpenGL texture handle associated with this swapchain image.XrSwapchainImageOpenGLKHRimage(int value)Sets the specified value to theimage()field.static XrSwapchainImageOpenGLKHRmalloc()Returns a newXrSwapchainImageOpenGLKHRinstance allocated withmemAlloc.static XrSwapchainImageOpenGLKHR.Buffermalloc(int capacity)Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated withmemAlloc.static XrSwapchainImageOpenGLKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated on the specifiedMemoryStack.static XrSwapchainImageOpenGLKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainImageOpenGLKHRinstance allocated on the specifiedMemoryStack.longnext()NULLor a pointer to the next structure in a structure chain.XrSwapchainImageOpenGLKHRnext(long value)Sets the specified value to thenext()field.static intnimage(long struct)Unsafe version ofimage().static voidnimage(long struct, int 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.XrSwapchainImageOpenGLKHRset(int type, long next, int image)Initializes this struct with the specified values.XrSwapchainImageOpenGLKHRset(XrSwapchainImageOpenGLKHR src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrSwapchainImageOpenGLKHRtype(int value)Sets the specified value to thetype()field.XrSwapchainImageOpenGLKHRtype$Default()Sets theTYPE_SWAPCHAIN_IMAGE_OPENGL_KHRvalue to thetype()field.
-
-
-
Constructor Detail
-
XrSwapchainImageOpenGLKHR
public XrSwapchainImageOpenGLKHR(java.nio.ByteBuffer container)
Creates aXrSwapchainImageOpenGLKHRinstance 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 int image()
the OpenGL texture handle associated with this swapchain image.
-
type
public XrSwapchainImageOpenGLKHR type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrSwapchainImageOpenGLKHR type$Default()
Sets theTYPE_SWAPCHAIN_IMAGE_OPENGL_KHRvalue to thetype()field.
-
next
public XrSwapchainImageOpenGLKHR next(long value)
Sets the specified value to thenext()field.
-
image
public XrSwapchainImageOpenGLKHR image(int value)
Sets the specified value to theimage()field.
-
set
public XrSwapchainImageOpenGLKHR set(int type, long next, int image)
Initializes this struct with the specified values.
-
set
public XrSwapchainImageOpenGLKHR set(XrSwapchainImageOpenGLKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrSwapchainImageOpenGLKHR malloc()
Returns a newXrSwapchainImageOpenGLKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrSwapchainImageOpenGLKHR calloc()
Returns a newXrSwapchainImageOpenGLKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrSwapchainImageOpenGLKHR create()
Returns a newXrSwapchainImageOpenGLKHRinstance allocated withBufferUtils.
-
create
public static XrSwapchainImageOpenGLKHR create(long address)
Returns a newXrSwapchainImageOpenGLKHRinstance for the specified memory address.
-
createSafe
@Nullable public static XrSwapchainImageOpenGLKHR createSafe(long address)
-
create
public static XrSwapchainImageOpenGLKHR create(XrSwapchainImageBaseHeader value)
Downcasts the specifiedXrSwapchainImageBaseHeaderinstance toXrSwapchainImageOpenGLKHR.
-
malloc
public static XrSwapchainImageOpenGLKHR.Buffer malloc(int capacity)
Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrSwapchainImageOpenGLKHR.Buffer calloc(int capacity)
Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrSwapchainImageOpenGLKHR.Buffer create(int capacity)
Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrSwapchainImageOpenGLKHR.Buffer create(long address, int capacity)
Create aXrSwapchainImageOpenGLKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrSwapchainImageOpenGLKHR.Buffer createSafe(long address, int capacity)
-
create
public static XrSwapchainImageOpenGLKHR.Buffer create(XrSwapchainImageBaseHeader.Buffer value)
Downcasts the specifiedXrSwapchainImageBaseHeader.Bufferinstance toXrSwapchainImageOpenGLKHR.Buffer.
-
malloc
public static XrSwapchainImageOpenGLKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainImageOpenGLKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrSwapchainImageOpenGLKHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainImageOpenGLKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrSwapchainImageOpenGLKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainImageOpenGLKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrSwapchainImageOpenGLKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainImageOpenGLKHR.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 int 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, int value)Unsafe version ofimage.
-
-