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

Layout


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

Nested and Inner Type Summary

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

Method Summary

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

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

XrSwapchainImageOpenGLKHR back to summary

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

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 Detail

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

calloc back to summary

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

public static XrSwapchainImageOpenGLKHR.Buffer calloc(int capacity)

Returns a new XrSwapchainImageOpenGLKHR.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 XrSwapchainImageOpenGLKHR calloc(MemoryStack stack) Returns a new `XrSwapchainImageOpenGLKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSwapchainImageOpenGLKHR calloc(MemoryStack stack)

Returns a new XrSwapchainImageOpenGLKHR 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 XrSwapchainImageOpenGLKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSwapchainImageOpenGLKHR.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 XrSwapchainImageOpenGLKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrSwapchainImageOpenGLKHR.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 XrSwapchainImageOpenGLKHR 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 XrSwapchainImageOpenGLKHR 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 XrSwapchainImageOpenGLKHR create() Returns a new `XrSwapchainImageOpenGLKHR` instance allocated with `BufferUtils`.

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

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

create back to summary

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

public static XrSwapchainImageOpenGLKHR.Buffer create(int capacity)

Returns a new XrSwapchainImageOpenGLKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a XrSwapchainImageOpenGLKHR.Buffer instance at the specified memory.

Parameters

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

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

createSafe back to summary

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

public static XrSwapchainImageOpenGLKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

image	back to summary
public int image() the OpenGL texture handle associated with this swapchain image. Annotations @NativeType:uint32_t

image

back to summary

public int image()

the OpenGL texture handle associated with this swapchain image.

Annotations

@NativeType:uint32_t

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

malloc back to summary

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

public static XrSwapchainImageOpenGLKHR.Buffer malloc(int capacity)

Returns a new XrSwapchainImageOpenGLKHR.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 XrSwapchainImageOpenGLKHR malloc(MemoryStack stack) Returns a new `XrSwapchainImageOpenGLKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSwapchainImageOpenGLKHR malloc(MemoryStack stack)

Returns a new XrSwapchainImageOpenGLKHR 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 XrSwapchainImageOpenGLKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSwapchainImageOpenGLKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new XrSwapchainImageOpenGLKHR.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 XrSwapchainImageOpenGLKHR next(long value) Sets the specified value to the `next` field.

nimage	back to summary
public static int 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 XrSwapchainImageOpenGLKHR set(int type, long next) Initializes this struct with the specified values.

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

set

back to summary

public XrSwapchainImageOpenGLKHR set(XrSwapchainImageOpenGLKHR src)

Copies the specified struct data to this struct.

Parameters

src:XrSwapchainImageOpenGLKHR: the source struct

Returns:XrSwapchainImageOpenGLKHR

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 XrSwapchainImageOpenGLKHR type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrSwapchainImageOpenGLKHR type$Default() Sets the `TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrSwapchainImageOpenGLKHR.Buffer

Class Inheritance

extends StructBuffer<XrSwapchainImageOpenGLKHR, XrSwapchainImageOpenGLKHR.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of XrSwapchainImageOpenGLKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSwapchainImageOpenGLKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSwapchainImageOpenGLKHR.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 XrSwapchainImageOpenGLKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `XrSwapchainImageOpenGLKHR#image` field. image()
public long	Returns: the value of the `XrSwapchainImageOpenGLKHR#next` field. next()
public XrSwapchainImageOpenGLKHR.Buffer	next(long value) Sets the specified value to the `XrSwapchainImageOpenGLKHR#next` field.
protected XrSwapchainImageOpenGLKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrSwapchainImageOpenGLKHR#type` field. type()
public XrSwapchainImageOpenGLKHR.Buffer	type(int value) Sets the specified value to the `XrSwapchainImageOpenGLKHR#type` field.
public XrSwapchainImageOpenGLKHR.Buffer	type$Default() Sets the `TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR` value to the `XrSwapchainImageOpenGLKHR#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 XrSwapchainImageOpenGLKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrSwapchainImageOpenGLKHR.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 `XrSwapchainImageOpenGLKHR#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 XrSwapchainImageOpenGLKHR.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 XrSwapchainImageOpenGLKHR#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 XrSwapchainImageOpenGLKHR getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected XrSwapchainImageOpenGLKHR getElementFactory()

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

Annotations

@Override

image	back to summary
public int image() Returns:int the value of the `XrSwapchainImageOpenGLKHR#image` field. Annotations @NativeType:uint32_t

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

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

self

back to summary

protected XrSwapchainImageOpenGLKHR.Buffer self()

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

Annotations

@Override

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

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

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

public Class XrSwapchainImageOpenGLKHR

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 XrSwapchainImageOpenGLKHR.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail