Package org.lwjgl.openxr

Class XrSwapchainImageOpenGLKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainImageOpenGLKHR>

org.lwjgl.openxr.XrSwapchainImageOpenGLKHR

All Implemented Interfaces:

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

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

OpenGL-specific swapchain image structure.

Description

If a given session was created with a stext:XrGraphicsBindingOpenGL*KHR, the following conditions must apply.

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

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_enable extension must be enabled prior to using XrSwapchainImageOpenGLKHR
• type must be TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrSwapchainImageBaseHeader

Layout

 struct XrSwapchainImageOpenGLKHR {
     XrStructureType type();
     void * next();
     uint32_t image();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

XrSwapchainImageOpenGLKHR

public XrSwapchainImageOpenGLKHR(ByteBuffer container)

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

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 int image()

the OpenGL texture handle associated with this swapchain image.

type

public XrSwapchainImageOpenGLKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrSwapchainImageOpenGLKHR type$Default()

Sets the TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR value to the type() field.

next

public XrSwapchainImageOpenGLKHR next(long value)

Sets the specified value to the next() field.

set

public XrSwapchainImageOpenGLKHR set(int type,
 long next)

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 new XrSwapchainImageOpenGLKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static XrSwapchainImageOpenGLKHR calloc()

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

create

public static XrSwapchainImageOpenGLKHR create()

Returns a new XrSwapchainImageOpenGLKHR instance allocated with BufferUtils.

create

public static XrSwapchainImageOpenGLKHR create(long address)

Returns a new XrSwapchainImageOpenGLKHR instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainImageOpenGLKHR createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSwapchainImageOpenGLKHR create(XrSwapchainImageBaseHeader value)

Downcasts the specified XrSwapchainImageBaseHeader instance to XrSwapchainImageOpenGLKHR.

malloc

public static XrSwapchainImageOpenGLKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainImageOpenGLKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainImageOpenGLKHR.Buffer create(int capacity)

Returns a new XrSwapchainImageOpenGLKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainImageOpenGLKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrSwapchainImageOpenGLKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

Returns a new XrSwapchainImageOpenGLKHR instance allocated on the specified MemoryStack and 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 new XrSwapchainImageOpenGLKHR.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrSwapchainImageOpenGLKHR.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 int 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.