Package org.lwjgl.openxr

Class XrGraphicsBindingOpenGLWaylandKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrGraphicsBindingOpenGLWaylandKHR>

org.lwjgl.openxr.XrGraphicsBindingOpenGLWaylandKHR

All Implemented Interfaces:

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

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

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

Description

When creating an OpenGL-backed XrSession on any Linux/Unix platform that utilizes the Wayland protocol with its compositor, the application will provide a pointer to an XrGraphicsBindingOpenGLWaylandKHR in the next chain of the XrSessionCreateInfo.

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

Valid Usage (Implicit)

• The XR_KHR_opengl_enable extension must be enabled prior to using XrGraphicsBindingOpenGLWaylandKHR
• type must be TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• display must be a pointer to a wl_display value

See Also

CreateSession

Layout

 struct XrGraphicsBindingOpenGLWaylandKHR {
     XrStructureType type();
     void const * next();
     struct wl_display * display();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

DISPLAY

public static final int DISPLAY

The struct member offsets.

Constructor Details

XrGraphicsBindingOpenGLWaylandKHR

public XrGraphicsBindingOpenGLWaylandKHR(ByteBuffer container)

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

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.

display

public long display()

a valid Wayland wl_display.

type

public XrGraphicsBindingOpenGLWaylandKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrGraphicsBindingOpenGLWaylandKHR type$Default()

Sets the TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR value to the type() field.

next

public XrGraphicsBindingOpenGLWaylandKHR next(long value)

Sets the specified value to the next() field.

display

public XrGraphicsBindingOpenGLWaylandKHR display(long value)

Sets the specified value to the display() field.

set

public XrGraphicsBindingOpenGLWaylandKHR set(int type,
 long next,
 long display)

Initializes this struct with the specified values.

set

public XrGraphicsBindingOpenGLWaylandKHR set(XrGraphicsBindingOpenGLWaylandKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrGraphicsBindingOpenGLWaylandKHR malloc()

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

calloc

public static XrGraphicsBindingOpenGLWaylandKHR calloc()

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

create

public static XrGraphicsBindingOpenGLWaylandKHR create()

Returns a new XrGraphicsBindingOpenGLWaylandKHR instance allocated with BufferUtils.

create

public static XrGraphicsBindingOpenGLWaylandKHR create(long address)

Returns a new XrGraphicsBindingOpenGLWaylandKHR instance for the specified memory address.

createSafe

public static @Nullable XrGraphicsBindingOpenGLWaylandKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrGraphicsBindingOpenGLWaylandKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrGraphicsBindingOpenGLWaylandKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrGraphicsBindingOpenGLWaylandKHR.Buffer create(int capacity)

Returns a new XrGraphicsBindingOpenGLWaylandKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrGraphicsBindingOpenGLWaylandKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrGraphicsBindingOpenGLWaylandKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndisplay

public static long ndisplay(long struct)

Unsafe version of display().

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.

ndisplay

public static void ndisplay(long struct,
 long value)

Unsafe version of display.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate