Namespace OpenTK.Platform

Classes

Bitmap

Represents a simple bitmap in a RGBA8 format.

ClipboardUpdateEventArgs

This event is triggered when the contents of the clipboard is changed.

CloseEventArgs

This event is triggered when the user presses the exit button of a window.

DisplayConnectionChangedEventArgs

This event is triggered when a display is connected or disconnected from the system.

EventQueue

Event queue for interacting with platform events.

FileDropEventArgs

This event is triggered when a user drags files into a window.

FocusEventArgs

This event is triggered when a window gets or loses input focus.

GraphicsApiHints

Hints provided for an abstraction layer about the graphics context being created.

This event is triggered when the input language is changed. This can change the keyboard layout. When this event occurs the values from GetKeyFromScancode(Scancode) and GetScancodeFromKey(Key) are updated to reflect the new layout keyboard layout.

JoystickHandle

Handle to a joystick.

KeyDownEventArgs

This event is triggered when a keyboard key is pressed.

KeyUpEventArgs

This event is triggered when a keyboard key is released.

MouseButtonDownEventArgs

This event is triggered when a mouse button is pressed.

MouseButtonUpEventArgs

This event is triggered when a mouse button is released.

MouseEnterEventArgs

This event is triggered when the mouse cursor enters or exits a window.

MouseHandle

Handle to a mouse.

MouseMoveEventArgs

This event is triggered when the mouse moves.

OpenGLContextHandle

Handle to an OpenGL context.

OpenGLGraphicsApiHints

Graphics API hints for OpenGL family of APIs.

Pal2BindingsContext

An IBindingsContext to use with PAL2.

PalException

Exception type for platform abstraction layer drivers.

PalHandle

Base class for all PAL handle objects.

PalNotImplementedException

Exception type when an optional feature is invoked in an abstraction layer driver which does not implement it.

PlatformException

Defines a platform-specific exception.

PowerStateChangeEventArgs

This event is triggered when the power state of the system changes.

RawMouseMoveEventArgs

This event is triggered when the mouse moves and raw mouse motion is enabled.

ScrollEventArgs

This event is triggered when the scrollwheel on a mouse is used.

SurfaceHandle

Handle to a rendering surface.

TextEditingEventArgs

This event is triggered when the user is composing text using something like IME (e.g. Chinese, Japanese, or Korean).

TextInputEventArgs

This event is triggered when the user has typed text.

ThemeChangeEventArgs

This event is triggered when a user changes the preferred theme.

Toolkit

Provides static access to all OpenTK platform abstraction interfaces. This is the main way to access the OpenTK PAL2 api.

ToolkitOptions

Options used to initialize OpenTK with.

ToolkitOptions.MacOSOptions

macOS backend specific options.

ToolkitOptions.WindowsOptions

Windows backend specific options.

ToolkitOptions.X11Options

X11 backend specific options.

VulkanGraphicsApiHints

Graphics API hints for the Vulkan API.

WindowEventArgs

Base class for OpenTK window event arguments.

WindowFramebufferResizeEventArgs

This event is triggered when a window has its framebuffer change size. This event can occur for different reasons, not only the window changing size.

WindowHandle

Handle to a window object.

WindowModeChangeEventArgs

This event is triggered when the window mode of a window changes.

WindowMoveEventArgs

This event is triggered when a window has its position changed on screen.

WindowResizeEventArgs

This event is triggered when a window has its size changed on screen.

WindowScaleChangeEventArgs

This event is triggered when the DPI of a window changes. This can happen if the window is moved between monitors with different DPI scaling settings or if the user changes DPI settings.

Structs

BatteryInfo

A struct containing information about the battery status of the computer.

ContextValues

DialogFileFilter

Describes a file filter used to filter visible files/folders in a file dialog.

DisplayResolution

Represents a display resolution.

GamepadBatteryInfo

Contains information about a gamepads battery.

MouseState

A struct to contain information about the current mouse state.

SystemMemoryInfo

Contains information about the current state of physical memory.

ThemeInfo

Represents theme info.

VideoMode

This structure represents a display video mode.

Interfaces

IClipboardComponent

Interface for drivers which provide the clipboard component of the platform abstraction layer.

ICursorComponent

Interface for creating and interacting with cursor images.

IDialogComponent

Interface for creating and interacting with modal dialogs.

IDisplayComponent

Interface for drivers which provide the display component.

IIconComponent

Interface creatiing and interacting with window icon images.

IJoystickComponent

Interface for interacting with joysticks.

IKeyboardComponent

Interaface for keyboard interaction, keyboard layouts and IME.

IMouseComponent

Interace for getting mouse input and setting mouse position.

IOpenGLComponent

Interface for creating and interacting with OpenGL contexts.

IPalComponent

Common interface for all platform abstraction layer components.

IShellComponent

Interface for interacting with operating system features.

ISurfaceComponent

Interface for creating and interacting with surfaces.

IVulkanComponent

Interface for interacting with Vulkan in a more convenient way.

IWindowComponent

Interface for abstraction layer drivers which implement the window component.

Enums

AppTheme

Enum representing a theme setting.

BatteryStatus

Whether the computer has a battery or if it doesn't, or if the computers battery status is unknown.

ClipboardFormat

Represents a clipboard data format.

ContextDepthBits

Represents the number of depth bits of the context depth backbuffer.

ContextPixelFormat

Defined the pixel format type of the context. This is used to differentiate between "normal" fixed point LDR formats and floating point HDR formats.

ContextReleaseBehaviour

See KHR_context_flush_control extension for details.

ContextResetNotificationStrategy

See GL_ARB_robustness extension for details.

ContextStencilBits

Represents the number of depth bits of the context stencil backbuffer.

ContextSwapMethod

Defines differnet semantics for what happens to the backbuffer after a swap.

CursorCaptureMode

Cursor capture modes.

GamepadBatteryType

Represents a type of battery in a gamepad.

GraphicsApi

Graphics API types.

HitType

Type of window hit.

JoystickAxis

Represents a joysick axis.

JoystickButton

Represents a button on a joystick.

Key

KeyModifier

Flags indicating keyboard modifiers.

MessageBoxButton

Represents a message box button.

MessageBoxType

Message box types deciding the default icon and button layout.

MouseButton

Enumeration of mouse buttons.

MouseButtonFlags

Mouse button flags.

OpenDialogOptions

Options for open dialogs.

OpenGLProfile

OpenGL Profile.

PalComponents

Enumeration for all available platform abstraction layer components.

PlatformEventType

Enumeration of all OpenTK window events.

SaveDialogOptions

Options for save dialogs.

Scancode

SurfaceType

Enumeration of surface types.

SystemCursorType

Represents system mouse cursor icons.

SystemIconType

Enumeration of system icons based on the Win32 base icon set.

WindowBorderStyle

The window border style.

WindowMode

An enumeration of OpenTK window modes.

WindowTransparencyMode

Represent possible transparency modes.

Delegates

ContextValueSelector

Delegate used to select appropriate context values to use.

HitTest

A delegate for hit testing.

Hit testing is not always done in respone to the user clicking the mouse. The operating system can do hit testing for any reason and doesn't need to be in respose to some user action. It is recommended to keep this code efficient as it will be called often.

PlatformEventHandler

An event handler delegate for platform events.

WindowEventHandler

Event handler delegate for processing window events.