Package org.lwjgl.openxr

Class XrGraphicsBindingOpenGLWin32KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrGraphicsBindingOpenGLWin32KHR>

org.lwjgl.openxr.XrGraphicsBindingOpenGLWin32KHR

All Implemented Interfaces:

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

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

The graphics binding structure to be passed at session creation to use OpenGL on Windows.

Description

When creating an OpenGL-backed XrSession on Microsoft Windows, the application will provide a pointer to an XrGraphicsBindingOpenGLWin32KHR in the next chain of the XrSessionCreateInfo. As no standardized way exists for OpenGL to create the graphics context on a specific GPU, the runtime must assume that the application uses the operating systems default GPU. If the GPU used by the runtime does not match the GPU on which the OpenGL context of the application got created, CreateSession must return ERROR_GRAPHICS_DEVICE_INVALID.

The required window system configuration define to expose this structure type is USE_PLATFORM_WIN32.

Valid Usage (Implicit)

• The XR_KHR_opengl_enable extension must be enabled prior to using XrGraphicsBindingOpenGLWin32KHR
• type must be TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• hDC must be a valid HDC value
• hGLRC must be a valid HGLRC value

See Also

CreateSession

Layout

 struct XrGraphicsBindingOpenGLWin32KHR {
     XrStructureType type();
     void const * next();
     HDC hDC();
     HGLRC hGLRC();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrGraphicsBindingOpenGLWin32KHR.Buffer	An array of XrGraphicsBindingOpenGLWin32KHR 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	HDC	The struct member offsets.
static final int	HGLRC	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
XrGraphicsBindingOpenGLWin32KHR(ByteBuffer container)	Creates a XrGraphicsBindingOpenGLWin32KHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrGraphicsBindingOpenGLWin32KHR	calloc()	Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with memCalloc.
static XrGraphicsBindingOpenGLWin32KHR.Buffer	calloc(int capacity)	Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with memCalloc.
static XrGraphicsBindingOpenGLWin32KHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrGraphicsBindingOpenGLWin32KHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrGraphicsBindingOpenGLWin32KHR	create()	Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with BufferUtils.
static XrGraphicsBindingOpenGLWin32KHR.Buffer	create(int capacity)	Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with BufferUtils.
static XrGraphicsBindingOpenGLWin32KHR	create(long address)	Returns a new XrGraphicsBindingOpenGLWin32KHR instance for the specified memory address.
static XrGraphicsBindingOpenGLWin32KHR.Buffer	create(long address, int capacity)	Create a XrGraphicsBindingOpenGLWin32KHR.Buffer instance at the specified memory.
static @Nullable XrGraphicsBindingOpenGLWin32KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrGraphicsBindingOpenGLWin32KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	hDC()	a valid Windows HW device context handle.
XrGraphicsBindingOpenGLWin32KHR	hDC(long value)	Sets the specified value to the hDC() field.
long	hGLRC()	a valid Windows OpenGL rendering context handle.
XrGraphicsBindingOpenGLWin32KHR	hGLRC(long value)	Sets the specified value to the hGLRC() field.
static XrGraphicsBindingOpenGLWin32KHR	malloc()	Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with memAlloc.
static XrGraphicsBindingOpenGLWin32KHR.Buffer	malloc(int capacity)	Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with memAlloc.
static XrGraphicsBindingOpenGLWin32KHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated on the specified MemoryStack.
static XrGraphicsBindingOpenGLWin32KHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrGraphicsBindingOpenGLWin32KHR	next(long value)	Sets the specified value to the next() field.
static long	nhDC(long struct)	Unsafe version of hDC().
static void	nhDC(long struct, long value)	Unsafe version of hDC.
static long	nhGLRC(long struct)	Unsafe version of hGLRC().
static void	nhGLRC(long struct, long value)	Unsafe version of hGLRC.
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.
XrGraphicsBindingOpenGLWin32KHR	set(int type, long next, long hDC, long hGLRC)	Initializes this struct with the specified values.
XrGraphicsBindingOpenGLWin32KHR	set(XrGraphicsBindingOpenGLWin32KHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrGraphicsBindingOpenGLWin32KHR	type(int value)	Sets the specified value to the type() field.
XrGraphicsBindingOpenGLWin32KHR	type$Default()	Sets the TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

HDC

public static final int HDC

The struct member offsets.

HGLRC

public static final int HGLRC

The struct member offsets.

Constructor Details

XrGraphicsBindingOpenGLWin32KHR

public XrGraphicsBindingOpenGLWin32KHR(ByteBuffer container)

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

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.

hDC

public long hDC()

a valid Windows HW device context handle.

hGLRC

public long hGLRC()

a valid Windows OpenGL rendering context handle.

type

public XrGraphicsBindingOpenGLWin32KHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrGraphicsBindingOpenGLWin32KHR type$Default()

Sets the TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR value to the type() field.

next

public XrGraphicsBindingOpenGLWin32KHR next(long value)

Sets the specified value to the next() field.

hDC

public XrGraphicsBindingOpenGLWin32KHR hDC(long value)

Sets the specified value to the hDC() field.

hGLRC

public XrGraphicsBindingOpenGLWin32KHR hGLRC(long value)

Sets the specified value to the hGLRC() field.

set

public XrGraphicsBindingOpenGLWin32KHR set(int type,
 long next,
 long hDC,
 long hGLRC)

Initializes this struct with the specified values.

set

public XrGraphicsBindingOpenGLWin32KHR set(XrGraphicsBindingOpenGLWin32KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrGraphicsBindingOpenGLWin32KHR malloc()

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

calloc

public static XrGraphicsBindingOpenGLWin32KHR calloc()

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

create

public static XrGraphicsBindingOpenGLWin32KHR create()

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with BufferUtils.

create

public static XrGraphicsBindingOpenGLWin32KHR create(long address)

Returns a new XrGraphicsBindingOpenGLWin32KHR instance for the specified memory address.

createSafe

public static @Nullable XrGraphicsBindingOpenGLWin32KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrGraphicsBindingOpenGLWin32KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrGraphicsBindingOpenGLWin32KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrGraphicsBindingOpenGLWin32KHR.Buffer create(int capacity)

Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrGraphicsBindingOpenGLWin32KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrGraphicsBindingOpenGLWin32KHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrGraphicsBindingOpenGLWin32KHR.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().

nhDC

public static long nhDC(long struct)

Unsafe version of hDC().

nhGLRC

public static long nhGLRC(long struct)

Unsafe version of hGLRC().

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.

nhDC

public static void nhDC(long struct,
 long value)

Unsafe version of hDC.

nhGLRC

public static void nhGLRC(long struct,
 long value)

Unsafe version of hGLRC.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate