Show / Hide Table of Contents

Namespace OpenTK.Windowing.GraphicsLibraryFramework

Classes

GLFW

Provides access to the GLFW API. On Linux to use GLFW compiled for Wayland set the environment variable OPENTK_4_USE_WAYLAND=1.

GLFWBindingsContext

Provides methods for querying available functions in a GLFW context.

GLFWCallbacks

Class containing GLFW related callbacks.

GLFWException

Represents errors that occur within GLFW.

JoystickState

Encapsulates the state of a joystick device.

KeyboardState

Encapsulates the state of a Keyboard device.

MouseState

Encapsulates the state of a mouse device.

Structs

Cursor

Opaque handle to a GLFW cursor.

GamepadState

This describes the input state of a gamepad.

GammaRamp

Gamma ramp for a Monitor.

GLFWallocator

Image

Contains GLFW Image data.

Monitor

Opaque handle to a GLFW monitor.

VideoMode

Replicated handle to a GLFW VideoMode.

VkHandle

A handle to a Vulkan object.

Window

Opaque handle to a GLFW window.

Enums

ANGLEPlatformType

ClientApi

The context client APIs.

ConnectedState

Specifies connected state of devices.

ContextApi

The context API used to create the window context.

CursorModeValue

The GLFW cursor modes. See cursor modes.

CursorShape

Standard cursor shapes.

CursorStateAttribute

Attribute for setting CursorModeValue of the cursor.

ErrorCode

Error codes, used in the error callback.

InitHintANGLEPlatformType

InitHintBool

Initialization hints are set before Init() and affect how the library behaves until termination. Hints are set with InitHint(InitHintBool, bool).

InitHintInt

Initialization hints are set before Init() and affect how the library behaves until termination. Hints are set with InitHint(InitHintInt, int).

InitHintPlatform

InputAction

Defines event information for GLFWCallbacks.KeyCallback or GLFWCallbacks.MouseButtonCallback.

JoystickHats

Status of a joystick hat.

JoystickInputAction

Defines event information for GetJoystickButtons(int) and GetJoystickButtonsRaw(int, out int).

KeyModifiers

Key modifiers, such as Shift or CTRL.

Keys

Specifies key codes and modifiers in US keyboard layout.

LockKeyModAttribute

Attribute for setting caps and num lock bits on when setting the input mode.

MouseButton

Specifies the buttons of a mouse.

OpenGlProfile

The OpenGL context profiles.

Platform

RawMouseMotionAttribute

Attribute for setting toggling raw mouse motion.

ReleaseBehavior

The context release behaviors.

Robustness

OpenGL context robustness strategy.

StickyAttributes

Attributes related to sticky keys and buttons.

WaylandLibDecor

WindowAttribute

Used to set window related attributes.

WindowAttributeGetBool

Used to get window related attributes.

WindowAttributeGetClientApi

Used to get window related attributes.

WindowAttributeGetContextApi

Used to get window related attributes.

WindowAttributeGetInt

Used to get window related attributes.

WindowAttributeGetOpenGlProfile

Used to get window related attributes.

WindowAttributeGetReleaseBehavior

Used to get window related attributes.

WindowAttributeGetRobustness

Used to get window related attributes.

WindowHintBool

Context related boolean attributes.

WindowHintClientApi

Context related client API attribute.

WindowHintContextApi

Used to specify the context creation API.

WindowHintInt

Context related attributes.

WindowHintOpenGlProfile

Used to set the OpenGlProfile attribute.

WindowHintReleaseBehavior

Used to specify the release behavior used by the local context.

WindowHintRobustness

Used to set context robustness attribute.

WindowHintString

Window hints for the WindowHintString function.

Delegates

GLFWallocatefun

The function pointer type for memory allocation callbacks.

This is the function pointer type for memory allocation callbacks. A memory allocation callback function has the following signature:

void* function_name(size_t size, void* user)

This function must return either a memory block at least size bytes long, or NULL if allocation failed.Note that not all parts of GLFW handle allocation failures gracefully yet.

This function must support being called during @ref glfwInit but before the library is flagged as initialized, as well as during @ref glfwTerminate after the library is no longer flagged as initialized.

Any memory allocated via this function will be deallocated via the same allocator during library termination or earlier.

Any memory allocated via this function must be suitably aligned for any object type. If you are using C99 or earlier, this alignment is platform-dependent but will be the same as what malloc provides.If you are using C11 or later, this is the value of alignof(max_align_t).

The size will always be greater than zero. Allocations of size zero are filtered out before reaching the custom allocator.

If this function returns NULL, GLFW will emit OutOfMemory.

This function must not call any GLFW function.

Added in version 3.4.

GLFWCallbacks.CharCallback

The function signature for Unicode character callback functions.

GLFWCallbacks.CharModsCallback

The function signature for Unicode character with modifiers callback functions. It is called for each input character, regardless of what modifier keys are held down.

GLFWCallbacks.CursorEnterCallback

The function signature for cursor enter/leave callback functions.

GLFWCallbacks.CursorPosCallback

The function signature for cursor position callback functions.

GLFWCallbacks.DropCallback

The function signature for file drop callbacks.

GLFWCallbacks.ErrorCallback

The function signature for error callback functions.

GLFWCallbacks.FramebufferSizeCallback

The function signature for framebuffer size callback functions.

GLFWCallbacks.JoystickCallback

The function signature for joystick configuration callback functions.

GLFWCallbacks.KeyCallback

The function signature for keyboard key callback functions.

GLFWCallbacks.MonitorCallback

The function signature for monitor configuration callback functions.

GLFWCallbacks.MouseButtonCallback

The function signature for mouse button callback functions.

GLFWCallbacks.ScrollCallback

The function signature for scroll callback functions.

GLFWCallbacks.WindowCloseCallback

The function signature for window close callback functions.

GLFWCallbacks.WindowContentScaleCallback

This is the function pointer type for window content scale callbacks.

GLFWCallbacks.WindowFocusCallback

The function signature for window focus callback functions.

GLFWCallbacks.WindowIconifyCallback

The function signature for window iconify/restore callback functions.

GLFWCallbacks.WindowMaximizeCallback

The function signature for window maximize/restore callback functions.

GLFWCallbacks.WindowPosCallback

The function signature for window position callback functions.

GLFWCallbacks.WindowRefreshCallback

The function signature for window refresh functions.

GLFWCallbacks.WindowSizeCallback

The function signature for window size callback functions.

GLFWdeallocatefun

The function pointer type for memory deallocation callbacks.

This is the function pointer type for memory deallocation callbacks. A memory deallocation callback function has the following signature: @code void function_name(void* block, void* user) @endcode

This function may deallocate the specified memory block.This memory block will have been allocated with the same allocator.

This function must support being called during @ref glfwInit but before the library is flagged as initialized, as well as during @ref glfwTerminate after the library is no longer flagged as initialized.

The block address will never be NULL. Deallocations of NULL are filtered out before reaching the custom allocator.

If this function returns NULL, GLFW will emit @ref GLFW_OUT_OF_MEMORY.

This function must not call any GLFW function.

GLFWreallocatefun

The function pointer type for memory reallocation callbacks.

This is the function pointer type for memory reallocation callbacks. A memory reallocation callback function has the following signature:

void* function_name(void* block, size_t size, void* user)

This function must return a memory block at least size bytes long, or null if allocation failed. Note that not all parts of GLFW handle allocation failures gracefully yet.

This function must support being called during glfwInit() but before the library is flagged as initialized, as well as during glfwTerminate() after the library is no longer flagged as initialized.

Any memory allocated via this function will be deallocated via the same allocator during library termination or earlier.

Any memory allocated via this function must be suitably aligned for any object type. If you are using C99 or earlier, this alignment is platform-dependent but will be the same as what realloc provides.If you are using C11 or later, this is the value of alignof(max_align_t).

The block address will never be null and the size will always be greater than zero. Reallocations of a block to size zero are converted into deallocations before reaching the custom allocator.Reallocations of null to a non-zero size are converted into regular allocations before reaching the custom allocator.

If this function returns null, GLFW will emit OutOfMemory.

This function must not call any GLFW function.

In This Article
Back to top Generated by DocFX