| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
OpenXR.Extensions.XR_KHR_opengl_enable
Description
Name
XR_KHR_opengl_enable - instance extension
Specification
See XR_KHR_opengl_enable in the main specification for complete information.
Registered Extension Number
24
Revision
9
Extension and Version Dependencies
- Requires OpenXR 1.0
See Also
GraphicsBindingOpenGLWaylandKHR, GraphicsBindingOpenGLWin32KHR,
GraphicsBindingOpenGLXcbKHR, GraphicsBindingOpenGLXlibKHR,
GraphicsRequirementsOpenGLKHR, SwapchainImageOpenGLKHR,
getOpenGLGraphicsRequirementsKHR
Document Notes
For more information, see the OpenXR Specification
This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.
Synopsis
- getOpenGLGraphicsRequirementsKHR :: forall io. MonadIO io => Instance -> SystemId -> io GraphicsRequirementsOpenGLKHR
- data GraphicsBindingOpenGLWin32KHR = GraphicsBindingOpenGLWin32KHR {}
- data GraphicsBindingOpenGLXlibKHR = GraphicsBindingOpenGLXlibKHR {}
- data GraphicsBindingOpenGLXcbKHR = GraphicsBindingOpenGLXcbKHR {}
- data GraphicsBindingOpenGLWaylandKHR = GraphicsBindingOpenGLWaylandKHR {
- display :: Ptr Wl_display
- data SwapchainImageOpenGLKHR = SwapchainImageOpenGLKHR {}
- data GraphicsRequirementsOpenGLKHR = GraphicsRequirementsOpenGLKHR {}
- type KHR_opengl_enable_SPEC_VERSION = 9
- pattern KHR_opengl_enable_SPEC_VERSION :: forall a. Integral a => a
- type KHR_OPENGL_ENABLE_EXTENSION_NAME = "XR_KHR_opengl_enable"
- pattern KHR_OPENGL_ENABLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
- type HDC = Ptr ()
- type HGLRC = Ptr ()
- type Display = Ptr ()
- type Xcb_visualid_t = Word32
- type Xcb_glx_fbconfig_t = Word32
- type Xcb_glx_drawable_t = Word32
- type Xcb_glx_context_t = Word32
- type GLXFBConfig = Ptr ()
- type GLXDrawable = Word64
- type GLXContext = Ptr ()
- data Xcb_connection_t
- data Wl_display
Documentation
getOpenGLGraphicsRequirementsKHR Source #
Arguments
| :: forall io. MonadIO io | |
| => Instance |
|
| -> SystemId |
|
| -> io GraphicsRequirementsOpenGLKHR |
xrGetOpenGLGraphicsRequirementsKHR - Retrieve the OpenGL version requirements for an instance and system
Parameter Descriptions
Description
The getOpenGLGraphicsRequirementsKHR function identifies to the
application the minimum OpenGL version requirement and the highest known
tested OpenGL version. The runtime must return
ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING
(ERROR_VALIDATION_FAILURE may be returned
due to legacy behavior) on calls to createSession
if getOpenGLGraphicsRequirementsKHR has not been called for the same
instance and systemId.
Valid Usage (Implicit)
- The
@@ extension must be enabled prior to calling
getOpenGLGraphicsRequirementsKHR
-
instancemust be a validInstancehandle -
graphicsRequirementsmust be a pointer to anGraphicsRequirementsOpenGLKHRstructure
Return Codes
See Also
GraphicsRequirementsOpenGLKHR, Instance,
https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId
data GraphicsBindingOpenGLWin32KHR Source #
XrGraphicsBindingOpenGLWin32KHR - The graphics binding structure to be passed at session creation to use OpenGL on Windows
Member Descriptions
Description
When creating an OpenGL-backed Session on
Microsoft Windows, the application will provide a pointer to an
GraphicsBindingOpenGLWin32KHR in the next chain of the
SessionCreateInfo. 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 XR_USE_PLATFORM_WIN32.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
GraphicsBindingOpenGLWin32KHR
-
typemust beTYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR -
nextmust beNULLor a valid pointer to the next structure in a structure chain -
hDCmust be a validHDCvalue -
hGLRCmust be a validHGLRCvalue
See Also
Constructors
| GraphicsBindingOpenGLWin32KHR | |
Instances
data GraphicsBindingOpenGLXlibKHR Source #
XrGraphicsBindingOpenGLXlibKHR - The graphics binding structure to be passed at session creation to use OpenGL on X11 via Xlib
Member Descriptions
Description
When creating an OpenGL-backed Session on any
Linux/Unix platform that utilizes X11 and GLX, via the Xlib library,
the application will provide a pointer to an
GraphicsBindingOpenGLXlibKHR in the next chain of the
SessionCreateInfo.
The required window system configuration define to expose this structure type is XR_USE_PLATFORM_XLIB.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
GraphicsBindingOpenGLXlibKHR
-
typemust beTYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR -
nextmust beNULLor a valid pointer to the next structure in a structure chain -
xDisplaymust be a pointer to aDisplayvalue -
glxFBConfigmust be a validGLXFBConfigvalue -
glxDrawablemust be a validGLXDrawablevalue -
glxContextmust be a validGLXContextvalue
See Also
Constructors
| GraphicsBindingOpenGLXlibKHR | |
Fields
| |
Instances
data GraphicsBindingOpenGLXcbKHR Source #
XrGraphicsBindingOpenGLXcbKHR - The graphics binding structure to be passed at session creation to use OpenGL on X11 via XCB
Member Descriptions
Description
When creating an OpenGL-backed Session on any
Linux/Unix platform that utilizes X11 and GLX, via the Xlib library,
the application will provide a pointer to an
GraphicsBindingOpenGLXcbKHR in the next chain of the
SessionCreateInfo.
The required window system configuration define to expose this structure type is XR_USE_PLATFORM_XCB.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
GraphicsBindingOpenGLXcbKHR
-
typemust beTYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR -
nextmust beNULLor a valid pointer to the next structure in a structure chain -
connectionmust be a pointer to anxcb_connection_tvalue -
fbconfigidmust be a validxcb_glx_fbconfig_tvalue -
visualidmust be a validxcb_visualid_tvalue -
glxDrawablemust be a validxcb_glx_drawable_tvalue -
glxContextmust be a validxcb_glx_context_tvalue
See Also
Constructors
| GraphicsBindingOpenGLXcbKHR | |
Fields
| |
Instances
data GraphicsBindingOpenGLWaylandKHR Source #
XrGraphicsBindingOpenGLWaylandKHR - The graphics binding structure to be passed at session creation to use OpenGL on Wayland
Member Descriptions
Description
When creating an OpenGL-backed Session on any
Linux/Unix platform that utilizes the Wayland protocol with its
compositor, the application will provide a pointer to an
GraphicsBindingOpenGLWaylandKHR in the next chain of the
SessionCreateInfo.
The required window system configuration define to expose this structure type is XR_USE_PLATFORM_WAYLAND.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
GraphicsBindingOpenGLWaylandKHR
-
typemust beTYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR -
nextmust beNULLor a valid pointer to the next structure in a structure chain -
displaymust be a pointer to awl_displayvalue
See Also
Constructors
| GraphicsBindingOpenGLWaylandKHR | |
Fields
| |
Instances
data SwapchainImageOpenGLKHR Source #
XrSwapchainImageOpenGLKHR - OpenGL-specific swapchain image structure
Member Descriptions
Description
If a given session was created with a XrGraphicsBindingOpenGL*KHR, the
following conditions must apply.
- Calls to
enumerateSwapchainImageson anSwapchainin that session must return an array ofSwapchainImageOpenGLKHRstructures. - Whenever an OpenXR function accepts an
SwapchainImageBaseHeaderpointer as a parameter in that session, the runtime must also accept a pointer to anSwapchainImageOpenGLKHR.
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 @@
extension must be enabled prior to using
SwapchainImageOpenGLKHR
-
typemust beTYPE_SWAPCHAIN_IMAGE_OPENGL_KHR -
nextmust beNULLor a valid pointer to the next structure in a structure chain
See Also
Constructors
| SwapchainImageOpenGLKHR | |
Instances
data GraphicsRequirementsOpenGLKHR Source #
XrGraphicsRequirementsOpenGLKHR - OpenGL API version requirements
Member Descriptions
Description
GraphicsRequirementsOpenGLKHR is populated by
getOpenGLGraphicsRequirementsKHR with the runtime’s OpenGL API version
requirements.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
GraphicsRequirementsOpenGLKHR
-
typemust beTYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR -
nextmust beNULLor a valid pointer to the next structure in a structure chain
See Also
StructureType,
https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrVersion,
getOpenGLGraphicsRequirementsKHR
Constructors
| GraphicsRequirementsOpenGLKHR | |
Fields
| |
Instances
type KHR_opengl_enable_SPEC_VERSION = 9 Source #
pattern KHR_opengl_enable_SPEC_VERSION :: forall a. Integral a => a Source #
type KHR_OPENGL_ENABLE_EXTENSION_NAME = "XR_KHR_opengl_enable" Source #
pattern KHR_OPENGL_ENABLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #
type Xcb_visualid_t = Word32 Source #
type Xcb_glx_fbconfig_t = Word32 Source #
type Xcb_glx_drawable_t = Word32 Source #
type Xcb_glx_context_t = Word32 Source #
type GLXFBConfig = Ptr () Source #
type GLXDrawable = Word64 Source #
type GLXContext = Ptr () Source #
data Xcb_connection_t Source #
data Wl_display Source #