org.lwjgl.openxr.XrGraphicsBindingOpenGLXlibKHR Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.openxr;
import org.jspecify.annotations.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
import org.lwjgl.system.linux.*;
import org.lwjgl.opengl.*;
/**
* The graphics binding structure to be passed at session creation to use OpenGL on X11 via Xlib.
*
* Description
*
* When creating an OpenGL-backed {@code XrSession} on any Linux/Unix platform that utilizes X11 and GLX, via the Xlib library, the application will provide a pointer to an {@link XrGraphicsBindingOpenGLXlibKHR} in the {@code next} chain of the {@link XrSessionCreateInfo}.
*
* The required window system configuration define to expose this structure type is {@link XR10#XR_USE_PLATFORM_XLIB USE_PLATFORM_XLIB}.
*
* Valid Usage (Implicit)
*
*
* - The {@link KHROpenGLEnable XR_KHR_opengl_enable} extension must be enabled prior to using {@link XrGraphicsBindingOpenGLXlibKHR}
* - {@code type} must be {@link KHROpenGLEnable#XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - {@code xDisplay} must be a pointer to a {@code Display} value
* - {@code glxFBConfig} must be a valid {@code GLXFBConfig} value
* - {@code glxDrawable} must be a valid {@code GLXDrawable} value
* - {@code glxContext} must be a valid {@code GLXContext} value
*
*
* See Also
*
* {@link XR10#xrCreateSession CreateSession}
*
* Layout
*
*
* struct XrGraphicsBindingOpenGLXlibKHR {
* XrStructureType {@link #type};
* void const * {@link #next};
* Display * {@link #xDisplay};
* uint32_t {@link #visualid};
* GLXFBConfig {@link #glxFBConfig};
* GLXDrawable {@link #glxDrawable};
* GLXContext {@link #glxContext};
* }
*/
public class XrGraphicsBindingOpenGLXlibKHR extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
TYPE,
NEXT,
XDISPLAY,
VISUALID,
GLXFBCONFIG,
GLXDRAWABLE,
GLXCONTEXT;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
XDISPLAY = layout.offsetof(2);
VISUALID = layout.offsetof(3);
GLXFBCONFIG = layout.offsetof(4);
GLXDRAWABLE = layout.offsetof(5);
GLXCONTEXT = layout.offsetof(6);
}
protected XrGraphicsBindingOpenGLXlibKHR(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrGraphicsBindingOpenGLXlibKHR create(long address, @Nullable ByteBuffer container) {
return new XrGraphicsBindingOpenGLXlibKHR(address, container);
}
/**
* Creates a {@code XrGraphicsBindingOpenGLXlibKHR} instance at the current position of the specified {@link 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 XrGraphicsBindingOpenGLXlibKHR(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the {@code XrStructureType} of this structure. */
@NativeType("XrStructureType")
public int type() { return ntype(address()); }
/** {@code NULL} or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension. */
@NativeType("void const *")
public long next() { return nnext(address()); }
/** a valid X11 {@code Display}. */
@NativeType("Display *")
public long xDisplay() { return nxDisplay(address()); }
/** a valid X11 visual identifier. */
@NativeType("uint32_t")
public int visualid() { return nvisualid(address()); }
/** a valid X11 OpenGL GLX {@code GLXFBConfig}. */
@NativeType("GLXFBConfig")
public long glxFBConfig() { return nglxFBConfig(address()); }
/** a valid X11 OpenGL GLX {@code GLXDrawable}. */
@NativeType("GLXDrawable")
public long glxDrawable() { return nglxDrawable(address()); }
/** a valid X11 OpenGL GLX {@code GLXContext}. */
@NativeType("GLXContext")
public long glxContext() { return nglxContext(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrGraphicsBindingOpenGLXlibKHR type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link KHROpenGLEnable#XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR} value to the {@link #type} field. */
public XrGraphicsBindingOpenGLXlibKHR type$Default() { return type(KHROpenGLEnable.XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR); }
/** Sets the specified value to the {@link #next} field. */
public XrGraphicsBindingOpenGLXlibKHR next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #xDisplay} field. */
public XrGraphicsBindingOpenGLXlibKHR xDisplay(@NativeType("Display *") long value) { nxDisplay(address(), value); return this; }
/** Sets the specified value to the {@link #visualid} field. */
public XrGraphicsBindingOpenGLXlibKHR visualid(@NativeType("uint32_t") int value) { nvisualid(address(), value); return this; }
/** Sets the specified value to the {@link #glxFBConfig} field. */
public XrGraphicsBindingOpenGLXlibKHR glxFBConfig(@NativeType("GLXFBConfig") long value) { nglxFBConfig(address(), value); return this; }
/** Sets the specified value to the {@link #glxDrawable} field. */
public XrGraphicsBindingOpenGLXlibKHR glxDrawable(@NativeType("GLXDrawable") long value) { nglxDrawable(address(), value); return this; }
/** Sets the specified value to the {@link #glxContext} field. */
public XrGraphicsBindingOpenGLXlibKHR glxContext(@NativeType("GLXContext") long value) { nglxContext(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrGraphicsBindingOpenGLXlibKHR set(
int type,
long next,
long xDisplay,
int visualid,
long glxFBConfig,
long glxDrawable,
long glxContext
) {
type(type);
next(next);
xDisplay(xDisplay);
visualid(visualid);
glxFBConfig(glxFBConfig);
glxDrawable(glxDrawable);
glxContext(glxContext);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrGraphicsBindingOpenGLXlibKHR set(XrGraphicsBindingOpenGLXlibKHR src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrGraphicsBindingOpenGLXlibKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrGraphicsBindingOpenGLXlibKHR malloc() {
return new XrGraphicsBindingOpenGLXlibKHR(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrGraphicsBindingOpenGLXlibKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrGraphicsBindingOpenGLXlibKHR calloc() {
return new XrGraphicsBindingOpenGLXlibKHR(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrGraphicsBindingOpenGLXlibKHR} instance allocated with {@link BufferUtils}. */
public static XrGraphicsBindingOpenGLXlibKHR create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrGraphicsBindingOpenGLXlibKHR(memAddress(container), container);
}
/** Returns a new {@code XrGraphicsBindingOpenGLXlibKHR} instance for the specified memory address. */
public static XrGraphicsBindingOpenGLXlibKHR create(long address) {
return new XrGraphicsBindingOpenGLXlibKHR(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrGraphicsBindingOpenGLXlibKHR createSafe(long address) {
return address == NULL ? null : new XrGraphicsBindingOpenGLXlibKHR(address, null);
}
/**
* Returns a new {@link XrGraphicsBindingOpenGLXlibKHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrGraphicsBindingOpenGLXlibKHR.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrGraphicsBindingOpenGLXlibKHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrGraphicsBindingOpenGLXlibKHR.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrGraphicsBindingOpenGLXlibKHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrGraphicsBindingOpenGLXlibKHR.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrGraphicsBindingOpenGLXlibKHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrGraphicsBindingOpenGLXlibKHR.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static XrGraphicsBindingOpenGLXlibKHR.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrGraphicsBindingOpenGLXlibKHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrGraphicsBindingOpenGLXlibKHR malloc(MemoryStack stack) {
return new XrGraphicsBindingOpenGLXlibKHR(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrGraphicsBindingOpenGLXlibKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrGraphicsBindingOpenGLXlibKHR calloc(MemoryStack stack) {
return new XrGraphicsBindingOpenGLXlibKHR(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrGraphicsBindingOpenGLXlibKHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrGraphicsBindingOpenGLXlibKHR.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrGraphicsBindingOpenGLXlibKHR.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrGraphicsBindingOpenGLXlibKHR.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #type}. */
public static int ntype(long struct) { return memGetInt(struct + XrGraphicsBindingOpenGLXlibKHR.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.NEXT); }
/** Unsafe version of {@link #xDisplay}. */
public static long nxDisplay(long struct) { return memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.XDISPLAY); }
/** Unsafe version of {@link #visualid}. */
public static int nvisualid(long struct) { return memGetInt(struct + XrGraphicsBindingOpenGLXlibKHR.VISUALID); }
/** Unsafe version of {@link #glxFBConfig}. */
public static long nglxFBConfig(long struct) { return memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXFBCONFIG); }
/** Unsafe version of {@link #glxDrawable}. */
public static long nglxDrawable(long struct) { return memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXDRAWABLE); }
/** Unsafe version of {@link #glxContext}. */
public static long nglxContext(long struct) { return memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXCONTEXT); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrGraphicsBindingOpenGLXlibKHR.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrGraphicsBindingOpenGLXlibKHR.NEXT, value); }
/** Unsafe version of {@link #xDisplay(long) xDisplay}. */
public static void nxDisplay(long struct, long value) { memPutAddress(struct + XrGraphicsBindingOpenGLXlibKHR.XDISPLAY, check(value)); }
/** Unsafe version of {@link #visualid(int) visualid}. */
public static void nvisualid(long struct, int value) { memPutInt(struct + XrGraphicsBindingOpenGLXlibKHR.VISUALID, value); }
/** Unsafe version of {@link #glxFBConfig(long) glxFBConfig}. */
public static void nglxFBConfig(long struct, long value) { memPutAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXFBCONFIG, check(value)); }
/** Unsafe version of {@link #glxDrawable(long) glxDrawable}. */
public static void nglxDrawable(long struct, long value) { memPutAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXDRAWABLE, check(value)); }
/** Unsafe version of {@link #glxContext(long) glxContext}. */
public static void nglxContext(long struct, long value) { memPutAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXCONTEXT, check(value)); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.XDISPLAY));
check(memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXFBCONFIG));
check(memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXDRAWABLE));
check(memGetAddress(struct + XrGraphicsBindingOpenGLXlibKHR.GLXCONTEXT));
}
// -----------------------------------
/** An array of {@link XrGraphicsBindingOpenGLXlibKHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrGraphicsBindingOpenGLXlibKHR ELEMENT_FACTORY = XrGraphicsBindingOpenGLXlibKHR.create(-1L);
/**
* Creates a new {@code XrGraphicsBindingOpenGLXlibKHR.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 {@link XrGraphicsBindingOpenGLXlibKHR#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer create(long address, @Nullable ByteBuffer container, int mark, int position, int limit, int capacity) {
return new Buffer(address, container, mark, position, limit, capacity);
}
@Override
protected XrGraphicsBindingOpenGLXlibKHR getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrGraphicsBindingOpenGLXlibKHR#type} field. */
@NativeType("XrStructureType")
public int type() { return XrGraphicsBindingOpenGLXlibKHR.ntype(address()); }
/** @return the value of the {@link XrGraphicsBindingOpenGLXlibKHR#next} field. */
@NativeType("void const *")
public long next() { return XrGraphicsBindingOpenGLXlibKHR.nnext(address()); }
/** @return the value of the {@link XrGraphicsBindingOpenGLXlibKHR#xDisplay} field. */
@NativeType("Display *")
public long xDisplay() { return XrGraphicsBindingOpenGLXlibKHR.nxDisplay(address()); }
/** @return the value of the {@link XrGraphicsBindingOpenGLXlibKHR#visualid} field. */
@NativeType("uint32_t")
public int visualid() { return XrGraphicsBindingOpenGLXlibKHR.nvisualid(address()); }
/** @return the value of the {@link XrGraphicsBindingOpenGLXlibKHR#glxFBConfig} field. */
@NativeType("GLXFBConfig")
public long glxFBConfig() { return XrGraphicsBindingOpenGLXlibKHR.nglxFBConfig(address()); }
/** @return the value of the {@link XrGraphicsBindingOpenGLXlibKHR#glxDrawable} field. */
@NativeType("GLXDrawable")
public long glxDrawable() { return XrGraphicsBindingOpenGLXlibKHR.nglxDrawable(address()); }
/** @return the value of the {@link XrGraphicsBindingOpenGLXlibKHR#glxContext} field. */
@NativeType("GLXContext")
public long glxContext() { return XrGraphicsBindingOpenGLXlibKHR.nglxContext(address()); }
/** Sets the specified value to the {@link XrGraphicsBindingOpenGLXlibKHR#type} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer type(@NativeType("XrStructureType") int value) { XrGraphicsBindingOpenGLXlibKHR.ntype(address(), value); return this; }
/** Sets the {@link KHROpenGLEnable#XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR} value to the {@link XrGraphicsBindingOpenGLXlibKHR#type} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer type$Default() { return type(KHROpenGLEnable.XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR); }
/** Sets the specified value to the {@link XrGraphicsBindingOpenGLXlibKHR#next} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer next(@NativeType("void const *") long value) { XrGraphicsBindingOpenGLXlibKHR.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrGraphicsBindingOpenGLXlibKHR#xDisplay} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer xDisplay(@NativeType("Display *") long value) { XrGraphicsBindingOpenGLXlibKHR.nxDisplay(address(), value); return this; }
/** Sets the specified value to the {@link XrGraphicsBindingOpenGLXlibKHR#visualid} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer visualid(@NativeType("uint32_t") int value) { XrGraphicsBindingOpenGLXlibKHR.nvisualid(address(), value); return this; }
/** Sets the specified value to the {@link XrGraphicsBindingOpenGLXlibKHR#glxFBConfig} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer glxFBConfig(@NativeType("GLXFBConfig") long value) { XrGraphicsBindingOpenGLXlibKHR.nglxFBConfig(address(), value); return this; }
/** Sets the specified value to the {@link XrGraphicsBindingOpenGLXlibKHR#glxDrawable} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer glxDrawable(@NativeType("GLXDrawable") long value) { XrGraphicsBindingOpenGLXlibKHR.nglxDrawable(address(), value); return this; }
/** Sets the specified value to the {@link XrGraphicsBindingOpenGLXlibKHR#glxContext} field. */
public XrGraphicsBindingOpenGLXlibKHR.Buffer glxContext(@NativeType("GLXContext") long value) { XrGraphicsBindingOpenGLXlibKHR.nglxContext(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy