Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrGraphicsBindingOpenGLWin32KHR

extends Struct<XrGraphicsBindingOpenGLWin32KHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.system.windows.*

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)
See Also

CreateSession

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HDC

The struct member offsets.

public static final int
HGLRC

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:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrGraphicsBindingOpenGLWin32KHR(ByteBuffer container)

Creates a XrGraphicsBindingOpenGLWin32KHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrGraphicsBindingOpenGLWin32KHR
calloc()

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with memCalloc.

public static XrGraphicsBindingOpenGLWin32KHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with memCalloc.

public static XrGraphicsBindingOpenGLWin32KHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrGraphicsBindingOpenGLWin32KHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrGraphicsBindingOpenGLWin32KHR
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 XrGraphicsBindingOpenGLWin32KHR
create()

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with BufferUtils.

public static XrGraphicsBindingOpenGLWin32KHR
create(long address)

Returns a new XrGraphicsBindingOpenGLWin32KHR instance for the specified memory address.

public static XrGraphicsBindingOpenGLWin32KHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with BufferUtils.

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

Create a XrGraphicsBindingOpenGLWin32KHR.Buffer instance at the specified memory.

public static XrGraphicsBindingOpenGLWin32KHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
hDC()

a valid Windows HW device context handle.

public XrGraphicsBindingOpenGLWin32KHR
hDC(long value)

Sets the specified value to the hDC field.

public long
hGLRC()

a valid Windows OpenGL rendering context handle.

public XrGraphicsBindingOpenGLWin32KHR
hGLRC(long value)

Sets the specified value to the hGLRC field.

public static XrGraphicsBindingOpenGLWin32KHR
malloc()

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with memAlloc.

public static XrGraphicsBindingOpenGLWin32KHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with memAlloc.

public static XrGraphicsBindingOpenGLWin32KHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated on the specified MemoryStack.

public static XrGraphicsBindingOpenGLWin32KHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrGraphicsBindingOpenGLWin32KHR
next(long value)

Sets the specified value to the next field.

public static long
nhDC(long struct)

Unsafe version of hDC.

public static void
nhDC(long struct, long value)

Unsafe version of hDC.

public static long
nhGLRC(long struct)

Unsafe version of hGLRC.

public static void
nhGLRC(long struct, long value)

Unsafe version of hGLRC.

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 XrGraphicsBindingOpenGLWin32KHR
set(int type, long next, long hDC, long hGLRC)

Initializes this struct with the specified values.

public XrGraphicsBindingOpenGLWin32KHR

Returns:

this struct
set
(XrGraphicsBindingOpenGLWin32KHR
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 XrGraphicsBindingOpenGLWin32KHR
type(int value)

Sets the specified value to the type field.

public XrGraphicsBindingOpenGLWin32KHR
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

HDCback to summary
public static final int HDC

The struct member offsets.

HGLRCback to summary
public static final int HGLRC

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrGraphicsBindingOpenGLWin32KHRback to summary
protected XrGraphicsBindingOpenGLWin32KHR(long address, ByteBuffer container)
XrGraphicsBindingOpenGLWin32KHRback to summary
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 Detail

callocback to summary
public static XrGraphicsBindingOpenGLWin32KHR calloc()

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

callocback to summary
public static XrGraphicsBindingOpenGLWin32KHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrGraphicsBindingOpenGLWin32KHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrGraphicsBindingOpenGLWin32KHR.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected XrGraphicsBindingOpenGLWin32KHR 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
createback to summary
public static XrGraphicsBindingOpenGLWin32KHR create()

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated with BufferUtils.

createback to summary
public static XrGraphicsBindingOpenGLWin32KHR create(long address)

Returns a new XrGraphicsBindingOpenGLWin32KHR instance for the specified memory address.

createback to summary
public static XrGraphicsBindingOpenGLWin32KHR.Buffer create(int capacity)

Returns a new XrGraphicsBindingOpenGLWin32KHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrGraphicsBindingOpenGLWin32KHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrGraphicsBindingOpenGLWin32KHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrGraphicsBindingOpenGLWin32KHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
hDCback to summary
public long hDC()

a valid Windows HW device context handle.

Annotations
@NativeType:HDC
hDCback to summary
public XrGraphicsBindingOpenGLWin32KHR hDC(long value)

Sets the specified value to the hDC field.

hGLRCback to summary
public long hGLRC()

a valid Windows OpenGL rendering context handle.

Annotations
@NativeType:HGLRC
hGLRCback to summary
public XrGraphicsBindingOpenGLWin32KHR hGLRC(long value)

Sets the specified value to the hGLRC field.

mallocback to summary
public static XrGraphicsBindingOpenGLWin32KHR malloc()

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

mallocback to summary
public static XrGraphicsBindingOpenGLWin32KHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrGraphicsBindingOpenGLWin32KHR malloc(MemoryStack stack)

Returns a new XrGraphicsBindingOpenGLWin32KHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrGraphicsBindingOpenGLWin32KHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback 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 const *
nextback to summary
public XrGraphicsBindingOpenGLWin32KHR next(long value)

Sets the specified value to the next field.

nhDCback to summary
public static long nhDC(long struct)

Unsafe version of hDC.

nhDCback to summary
public static void nhDC(long struct, long value)

Unsafe version of hDC.

nhGLRCback to summary
public static long nhGLRC(long struct)

Unsafe version of hGLRC.

nhGLRCback to summary
public static void nhGLRC(long struct, long value)

Unsafe version of hGLRC.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

setback to summary
public XrGraphicsBindingOpenGLWin32KHR set(XrGraphicsBindingOpenGLWin32KHR src)

Copies the specified struct data to this struct.

Parameters
src:XrGraphicsBindingOpenGLWin32KHR

the source struct

Returns:XrGraphicsBindingOpenGLWin32KHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrGraphicsBindingOpenGLWin32KHR type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrGraphicsBindingOpenGLWin32KHR type$Default()

Sets the TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrGraphicsBindingOpenGLWin32KHR.Buffer

extends StructBuffer<XrGraphicsBindingOpenGLWin32KHR, XrGraphicsBindingOpenGLWin32KHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrGraphicsBindingOpenGLWin32KHR structs.

Field Summary

Modifier and TypeField and Description
private static final XrGraphicsBindingOpenGLWin32KHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrGraphicsBindingOpenGLWin32KHR.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 TypeMethod and Description
protected XrGraphicsBindingOpenGLWin32KHR
public long

Returns:

the value of the XrGraphicsBindingOpenGLWin32KHR#hDC field.
hDC
()

public XrGraphicsBindingOpenGLWin32KHR.Buffer
hDC(long value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#hDC field.

public long

Returns:

the value of the XrGraphicsBindingOpenGLWin32KHR#hGLRC field.
hGLRC
()

public XrGraphicsBindingOpenGLWin32KHR.Buffer
hGLRC(long value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#hGLRC field.

public long

Returns:

the value of the XrGraphicsBindingOpenGLWin32KHR#next field.
next
()

public XrGraphicsBindingOpenGLWin32KHR.Buffer
next(long value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#next field.

protected XrGraphicsBindingOpenGLWin32KHR.Buffer
public int

Returns:

the value of the XrGraphicsBindingOpenGLWin32KHR#type field.
type
()

public XrGraphicsBindingOpenGLWin32KHR.Buffer
type(int value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#type field.

public XrGraphicsBindingOpenGLWin32KHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrGraphicsBindingOpenGLWin32KHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrGraphicsBindingOpenGLWin32KHR.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 XrGraphicsBindingOpenGLWin32KHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected XrGraphicsBindingOpenGLWin32KHR getElementFactory()

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

Annotations
@Override
hDCback to summary
public long hDC()
Returns:long

the value of the XrGraphicsBindingOpenGLWin32KHR#hDC field.

Annotations
@NativeType:HDC
hDCback to summary
public XrGraphicsBindingOpenGLWin32KHR.Buffer hDC(long value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#hDC field.

hGLRCback to summary
public long hGLRC()
Returns:long

the value of the XrGraphicsBindingOpenGLWin32KHR#hGLRC field.

Annotations
@NativeType:HGLRC
hGLRCback to summary
public XrGraphicsBindingOpenGLWin32KHR.Buffer hGLRC(long value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#hGLRC field.

nextback to summary
public long next()
Returns:long

the value of the XrGraphicsBindingOpenGLWin32KHR#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrGraphicsBindingOpenGLWin32KHR.Buffer next(long value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#next field.

selfback to summary
protected XrGraphicsBindingOpenGLWin32KHR.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrGraphicsBindingOpenGLWin32KHR#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrGraphicsBindingOpenGLWin32KHR.Buffer type(int value)

Sets the specified value to the XrGraphicsBindingOpenGLWin32KHR#type field.

type$Defaultback to summary
public XrGraphicsBindingOpenGLWin32KHR.Buffer type$Default()

Sets the TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR value to the XrGraphicsBindingOpenGLWin32KHR#type field.