Unit Neslib.Glfw3

Description

Uses

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

Overview

Classes, Interfaces, Objects and Records

Name	Description
record `TGLFWvidmode`	Video mode type.
record `TGLFWgammaramp`	Describes the gamma ramp for a monitor.
record `TGLFWimage`	Image data.

Functions and Procedures

function glfwInit(): Integer; cdecl external GLFW3_LIB name _PU + 'glfwInit';

procedure glfwTerminate(); cdecl external GLFW3_LIB name _PU + 'glfwTerminate';

procedure glfwGetVersion(major, minor, rev: PInteger); cdecl external GLFW3_LIB name _PU + 'glfwGetVersion';

function glfwGetVersionString(): PAnsiChar; cdecl external GLFW3_LIB name _PU + 'glfwGetVersionString';

function glfwSetErrorCallback(cbfun: TGLFWerrorfun): TGLFWerrorfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetErrorCallback';

function glfwGetMonitors(out count: Integer): PPGLFWmonitor; cdecl external GLFW3_LIB name _PU + 'glfwGetMonitors';

function glfwGetPrimaryMonitor(): PGLFWmonitor; cdecl external GLFW3_LIB name _PU + 'glfwGetPrimaryMonitor';

procedure glfwGetMonitorPos(monitor: PGLFWmonitor; xpos, ypos: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetMonitorPos';

procedure glfwGetMonitorPhysicalSize(monitor: PGLFWmonitor; widthMM, heightMM: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetMonitorPhysicalSize';

function glfwGetMonitorName(monitor: PGLFWmonitor): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetMonitorName';

function glfwSetMonitorCallback(cbfun: TGLFWmonitorfun): TGLFWmonitorfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetMonitorCallback';

function glfwGetVideoModes(monitor: PGLFWmonitor; out count: Integer): PGLFWvidmode; cdecl  external GLFW3_LIB name _PU + 'glfwGetVideoModes';

function glfwGetVideoMode(monitor: PGLFWmonitor): PGLFWvidmode; cdecl external GLFW3_LIB name _PU + 'glfwGetVideoMode';

procedure glfwSetGamma(monitor: PGLFWmonitor; gamma: Single); cdecl external GLFW3_LIB name _PU + 'glfwSetGamma';

function glfwGetGammaRamp(monitor: PGLFWmonitor): PGLFWgammaramp; cdecl  external GLFW3_LIB name _PU + 'glfwGetGammaRamp';

procedure glfwSetGammaRamp(monitor: PGLFWmonitor; const ramp: PGLFWgammaramp); cdecl  external GLFW3_LIB name _PU + 'glfwSetGammaRamp';

procedure glfwDefaultWindowHints(); cdecl external GLFW3_LIB name _PU + 'glfwDefaultWindowHints';

procedure glfwWindowHint(hint: Integer; value: Integer); cdecl external GLFW3_LIB name _PU + 'glfwWindowHint';

function glfwCreateWindow(width: Integer; height: Integer; const title: PAnsiChar; monitor: PGLFWmonitor; share: PGLFWwindow): PGLFWwindow; cdecl  external GLFW3_LIB name _PU + 'glfwCreateWindow';

procedure glfwDestroyWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwDestroyWindow';

function glfwWindowShouldClose(window: PGLFWwindow): Integer; cdecl  external GLFW3_LIB name _PU + 'glfwWindowShouldClose';

procedure glfwSetWindowShouldClose(window: PGLFWwindow; value: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowShouldClose';

procedure glfwSetWindowTitle(window: PGLFWwindow; const title: PAnsiChar); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowTitle';

procedure glfwSetWindowIcon(window: PGLFWwindow; count: Integer; const images: PGLFWimage); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowIcon';

procedure glfwGetWindowPos(window: PGLFWwindow; xpos, ypos: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowPos';

procedure glfwSetWindowPos(window: PGLFWwindow; xpos, ypos: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowPos';

procedure glfwGetWindowSize(window: PGLFWwindow; width, height: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowSize';

procedure glfwSetWindowSizeLimits(window: PGLFWwindow; minwidth, minheight, maxwidth, maxheight: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowSizeLimits';

procedure glfwSetWindowAspectRatio(window: PGLFWwindow; numer, denom: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowAspectRatio';

procedure glfwSetWindowSize(window: PGLFWwindow; width, height: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowSize';

procedure glfwGetFramebufferSize(window: PGLFWwindow; width, height: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetFramebufferSize';

procedure glfwGetWindowFrameSize(window: PGLFWwindow; left, top, right, bottom: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowFrameSize';

procedure glfwIconifyWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwIconifyWindow';

procedure glfwRestoreWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwRestoreWindow';

procedure glfwMaximizeWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwMaximizeWindow';

procedure glfwShowWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwShowWindow';

procedure glfwHideWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwHideWindow';

procedure glfwFocusWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwFocusWindow';

function glfwGetWindowMonitor(window: PGLFWwindow): PGLFWmonitor; cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowMonitor';

procedure glfwSetWindowMonitor(window: PGLFWwindow; monitor: PGLFWmonitor; xpos, ypos, width, height, refreshRate: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowMonitor';

function glfwGetWindowAttrib(window: PGLFWwindow; attrib: Integer): Integer; cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowAttrib';

procedure glfwSetWindowUserPointer(window: PGLFWwindow; pointer: Pointer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowUserPointer';

function glfwGetWindowUserPointer(window: PGLFWwindow): Pointer; cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowUserPointer';

function glfwSetWindowPosCallback(window: PGLFWwindow; cbfun: TGLFWwindowposfun): TGLFWwindowposfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowPosCallback';

function glfwSetWindowSizeCallback(window: PGLFWwindow; cbfun: TGLFWwindowsizefun): TGLFWwindowsizefun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowSizeCallback';

function glfwSetWindowCloseCallback(window: PGLFWwindow; cbfun: TGLFWwindowclosefun): TGLFWwindowclosefun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowCloseCallback';

function glfwSetWindowRefreshCallback(window: PGLFWwindow; cbfun: TGLFWwindowrefreshfun): TGLFWwindowrefreshfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowRefreshCallback';

function glfwSetWindowFocusCallback(window: PGLFWwindow; cbfun: TGLFWwindowfocusfun): TGLFWwindowfocusfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowFocusCallback';

function glfwSetWindowIconifyCallback(window: PGLFWwindow; cbfun: TGLFWwindowiconifyfun): TGLFWwindowiconifyfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowIconifyCallback';

function glfwSetFramebufferSizeCallback(window: PGLFWwindow; cbfun: TGLFWframebuffersizefun): TGLFWframebuffersizefun; cdecl  external GLFW3_LIB name _PU + 'glfwSetFramebufferSizeCallback';

procedure glfwPollEvents(); cdecl external GLFW3_LIB name _PU + 'glfwPollEvents';

procedure glfwWaitEvents(); cdecl external GLFW3_LIB name _PU + 'glfwWaitEvents';

procedure glfwWaitEventsTimeout(timeout: Double); cdecl external GLFW3_LIB name _PU + 'glfwWaitEventsTimeout';

procedure glfwPostEmptyEvent(); cdecl external GLFW3_LIB name _PU + 'glfwPostEmptyEvent';

function glfwGetInputMode(window: PGLFWwindow; mode: Integer): Integer; cdecl  external GLFW3_LIB name _PU + 'glfwGetInputMode';

procedure glfwSetInputMode(window: PGLFWwindow; mode, value: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetInputMode';

function glfwGetKeyName(key: Integer; scancode: Integer): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetKeyName';

function glfwGetKey(window: PGLFWwindow; key: Integer): Integer; cdecl external GLFW3_LIB name _PU + 'glfwGetKey';

function glfwGetMouseButton(window: PGLFWwindow; button: Integer): Integer; cdecl  external GLFW3_LIB name _PU + 'glfwGetMouseButton';

procedure glfwGetCursorPos(window: PGLFWwindow; xpos, ypos: PDouble); cdecl  external GLFW3_LIB name _PU + 'glfwGetCursorPos';

procedure glfwSetCursorPos(window: PGLFWwindow; xpos, ypos: Double); cdecl  external GLFW3_LIB name _PU + 'glfwSetCursorPos';

function glfwCreateCursor(const image: PGLFWimage; xhot: Integer; yhot: Integer): PGLFWcursor; cdecl  external GLFW3_LIB name _PU + 'glfwCreateCursor';

function glfwCreateStandardCursor(shape: Integer): PGLFWcursor; cdecl  external GLFW3_LIB name _PU + 'glfwCreateStandardCursor';

procedure glfwDestroyCursor(cursor: PGLFWcursor); cdecl external GLFW3_LIB name _PU + 'glfwDestroyCursor';

procedure glfwSetCursor(window: PGLFWwindow; cursor: PGLFWcursor); cdecl external GLFW3_LIB name _PU + 'glfwSetCursor';

function glfwSetKeyCallback(window: PGLFWwindow; cbfun: TGLFWkeyfun): TGLFWkeyfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetKeyCallback';

function glfwSetCharCallback(window: PGLFWwindow; cbfun: TGLFWcharfun): TGLFWcharfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCharCallback';

function glfwSetCharModsCallback(window: PGLFWwindow; cbfun: TGLFWcharmodsfun): TGLFWcharmodsfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCharModsCallback';

function glfwSetMouseButtonCallback(window: PGLFWwindow; cbfun: TGLFWmousebuttonfun): TGLFWmousebuttonfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetMouseButtonCallback';

function glfwSetCursorPosCallback(window: PGLFWwindow; cbfun: TGLFWcursorposfun): TGLFWcursorposfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCursorPosCallback';

function glfwSetCursorEnterCallback(window: PGLFWwindow; cbfun: TGLFWcursorenterfun): TGLFWcursorenterfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCursorEnterCallback';

function glfwSetScrollCallback(window: PGLFWwindow; cbfun: TGLFWscrollfun): TGLFWscrollfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetScrollCallback';

function glfwSetDropCallback(window: PGLFWwindow; cbfun: TGLFWdropfun): TGLFWdropfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetDropCallback';

function glfwJoystickPresent(joy: Integer): Integer; cdecl external GLFW3_LIB name _PU + 'glfwJoystickPresent';

function glfwGetJoystickAxes(joy: Integer; out count: Integer): PSingle; cdecl  external GLFW3_LIB name _PU + 'glfwGetJoystickAxes';

function glfwGetJoystickButtons(joy: Integer; out count: Integer): PByte; cdecl  external GLFW3_LIB name _PU + 'glfwGetJoystickButtons';

function glfwGetJoystickName(joy: Integer): PAnsiChar; cdecl external GLFW3_LIB name _PU + 'glfwGetJoystickName';

function glfwSetJoystickCallback(cbfun: TGLFWjoystickfun): TGLFWjoystickfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetJoystickCallback';

procedure glfwSetClipboardString(window: PGLFWwindow; const text: PAnsiChar); cdecl  external GLFW3_LIB name _PU + 'glfwSetClipboardString';

function glfwGetClipboardString(window: PGLFWwindow): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetClipboardString';

function glfwGetTime(): Double; cdecl external GLFW3_LIB name _PU + 'glfwGetTime';

procedure glfwSetTime(time: Double); cdecl external GLFW3_LIB name _PU + 'glfwSetTime';

function glfwGetTimerValue(): UInt64; cdecl external GLFW3_LIB name _PU + 'glfwGetTimerValue';

function glfwGetTimerFrequency(): UInt64; cdecl external GLFW3_LIB name _PU + 'glfwGetTimerFrequency';

procedure glfwMakeContextCurrent(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwMakeContextCurrent';

function glfwGetCurrentContext(): PGLFWwindow; cdecl external GLFW3_LIB name _PU + 'glfwGetCurrentContext';

procedure glfwSwapBuffers(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwSwapBuffers';

procedure glfwSwapInterval(interval: Integer); cdecl external GLFW3_LIB name _PU + 'glfwSwapInterval';

function glfwExtensionSupported(const extension: PAnsiChar): Integer; cdecl  external GLFW3_LIB name _PU + 'glfwExtensionSupported';

function glfwGetProcAddress(const procname: PAnsiChar): TGLFWglproc; cdecl  external GLFW3_LIB name _PU + 'glfwGetProcAddress';

function glfwVulkanSupported(): Integer; cdecl external GLFW3_LIB name _PU + 'glfwVulkanSupported';

function glfwGetRequiredInstanceExtensions(out count: UInt32): PPAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetRequiredInstanceExtensions';

function glfwGetWin32Adapter(monitor: PGLFWmonitor): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetWin32Adapter';

function glfwGetWin32Monitor(monitor: PGLFWmonitor): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetWin32Monitor';

function glfwGetWin32Window(window: PGLFWwindow): HWND; cdecl external GLFW3_LIB name _PU + 'glfwGetWin32Window';

function glfwGetWGLContext(window: PGLFWwindow): HGLRC; cdecl external GLFW3_LIB name _PU + 'glfwGetWGLContext';

function glfwGetCocoaMonitor(monitor: PGLFWmonitor): CGDirectDisplayID; cdecl  external GLFW3_LIB name _PU + 'glfwGetCocoaMonitor';

function glfwGetCocoaWindow(window: PGLFWwindow): Id; cdecl external GLFW3_LIB name _PU + 'glfwGetCocoaWindow';

function glfwGetNSGLContext(window: PGLFWwindow): Id; cdecl external GLFW3_LIB name _PU + 'glfwGetNSGLContext';

Types

TGLFWglproc = procedure(); cdecl;

PGLFWmonitor = Pointer;

PPGLFWmonitor = ˆPGLFWmonitor;

PGLFWwindow = Pointer;

PPGLFWwindow = ˆPGLFWwindow;

PGLFWcursor = Pointer;

PPGLFWcursor = ˆPGLFWcursor;

TGLFWerrorfun = procedure(error: Integer; const description: PAnsiChar); cdecl;

TGLFWwindowposfun = procedure(window: PGLFWwindow; xpos, ypos: Integer); cdecl;

TGLFWwindowsizefun = procedure(window: PGLFWwindow; width, height: Integer); cdecl;

TGLFWwindowclosefun = procedure(window: PGLFWwindow); cdecl;

TGLFWwindowrefreshfun = procedure(window: PGLFWwindow); cdecl;

TGLFWwindowfocusfun = procedure(window: PGLFWwindow; focused: Integer); cdecl;

TGLFWwindowiconifyfun = procedure(window: PGLFWwindow; iconified: Integer); cdecl;

TGLFWframebuffersizefun = procedure(window: PGLFWwindow; width, height: Integer); cdecl;

TGLFWmousebuttonfun = procedure(window: PGLFWwindow; button, action, mods: Integer); cdecl;

TGLFWcursorposfun = procedure(window: PGLFWwindow; xpos, ypos: Double); cdecl;

TGLFWcursorenterfun = procedure(window: PGLFWwindow; entered: Integer); cdecl;

TGLFWscrollfun = procedure(window: PGLFWwindow; xoffset, yoffset: Double); cdecl;

TGLFWkeyfun = procedure(window: PGLFWwindow; key, scancode, action, mods: Integer); cdecl;

TGLFWcharfun = procedure(window: PGLFWwindow; codepoint: Cardinal); cdecl;

TGLFWcharmodsfun = procedure(window: PGLFWwindow; codepoint: Cardinal; mods: Integer); cdecl;

TGLFWdropfun = procedure(window: PGLFWwindow; count: Integer; const paths: PPAnsiChar); cdecl;

TGLFWmonitorfun = procedure(monitor: PGLFWmonitor; event: Integer); cdecl;

TGLFWjoystickfun = procedure(joy, event: Integer); cdecl;

PGLFWvidmode = ˆTGLFWvidmode;

PPGLFWvidmode = ˆPGLFWvidmode;

PGLFWgammaramp = ˆTGLFWgammaramp;

PPGLFWgammaramp = ˆPGLFWgammaramp;

PGLFWimage = ˆTGLFWimage;

PPGLFWimage = ˆPGLFWimage;

Constants

GLFW_VERSION_MAJOR = 3;

GLFW_VERSION_MINOR = 2;

GLFW_VERSION_REVISION = 1;

GLFW_TRUE = 1;

GLFW_FALSE = 0;

GLFW_RELEASE = 0;

GLFW_PRESS = 1;

GLFW_REPEAT = 2;

GLFW_KEY_UNKNOWN = -1;

GLFW_KEY_SPACE = 32;

GLFW_KEY_APOSTROPHE = 39;

GLFW_KEY_COMMA = 44;

GLFW_KEY_MINUS = 45;

GLFW_KEY_PERIOD = 46;

GLFW_KEY_SLASH = 47;

GLFW_KEY_0 = 48;

GLFW_KEY_1 = 49;

GLFW_KEY_2 = 50;

GLFW_KEY_3 = 51;

GLFW_KEY_4 = 52;

GLFW_KEY_5 = 53;

GLFW_KEY_6 = 54;

GLFW_KEY_7 = 55;

GLFW_KEY_8 = 56;

GLFW_KEY_9 = 57;

GLFW_KEY_SEMICOLON = 59;

GLFW_KEY_EQUAL = 61;

GLFW_KEY_A = 65;

GLFW_KEY_B = 66;

GLFW_KEY_C = 67;

GLFW_KEY_D = 68;

GLFW_KEY_E = 69;

GLFW_KEY_F = 70;

GLFW_KEY_G = 71;

GLFW_KEY_H = 72;

GLFW_KEY_I = 73;

GLFW_KEY_J = 74;

GLFW_KEY_K = 75;

GLFW_KEY_L = 76;

GLFW_KEY_M = 77;

GLFW_KEY_N = 78;

GLFW_KEY_O = 79;

GLFW_KEY_P = 80;

GLFW_KEY_Q = 81;

GLFW_KEY_R = 82;

GLFW_KEY_S = 83;

GLFW_KEY_T = 84;

GLFW_KEY_U = 85;

GLFW_KEY_V = 86;

GLFW_KEY_W = 87;

GLFW_KEY_X = 88;

GLFW_KEY_Y = 89;

GLFW_KEY_Z = 90;

GLFW_KEY_LEFT_BRACKET = 91;

GLFW_KEY_BACKSLASH = 92;

GLFW_KEY_RIGHT_BRACKET = 93;

GLFW_KEY_GRAVE_ACCENT = 96;

GLFW_KEY_WORLD_1 = 161;

GLFW_KEY_WORLD_2 = 162;

GLFW_KEY_ESCAPE = 256;

GLFW_KEY_ENTER = 257;

GLFW_KEY_TAB = 258;

GLFW_KEY_BACKSPACE = 259;

GLFW_KEY_INSERT = 260;

GLFW_KEY_DELETE = 261;

GLFW_KEY_RIGHT = 262;

GLFW_KEY_LEFT = 263;

GLFW_KEY_DOWN = 264;

GLFW_KEY_UP = 265;

GLFW_KEY_PAGE_UP = 266;

GLFW_KEY_PAGE_DOWN = 267;

GLFW_KEY_HOME = 268;

GLFW_KEY_END = 269;

GLFW_KEY_CAPS_LOCK = 280;

GLFW_KEY_SCROLL_LOCK = 281;

GLFW_KEY_NUM_LOCK = 282;

GLFW_KEY_PRINT_SCREEN = 283;

GLFW_KEY_PAUSE = 284;

GLFW_KEY_F1 = 290;

GLFW_KEY_F2 = 291;

GLFW_KEY_F3 = 292;

GLFW_KEY_F4 = 293;

GLFW_KEY_F5 = 294;

GLFW_KEY_F6 = 295;

GLFW_KEY_F7 = 296;

GLFW_KEY_F8 = 297;

GLFW_KEY_F9 = 298;

GLFW_KEY_F10 = 299;

GLFW_KEY_F11 = 300;

GLFW_KEY_F12 = 301;

GLFW_KEY_F13 = 302;

GLFW_KEY_F14 = 303;

GLFW_KEY_F15 = 304;

GLFW_KEY_F16 = 305;

GLFW_KEY_F17 = 306;

GLFW_KEY_F18 = 307;

GLFW_KEY_F19 = 308;

GLFW_KEY_F20 = 309;

GLFW_KEY_F21 = 310;

GLFW_KEY_F22 = 311;

GLFW_KEY_F23 = 312;

GLFW_KEY_F24 = 313;

GLFW_KEY_F25 = 314;

GLFW_KEY_KP_0 = 320;

GLFW_KEY_KP_1 = 321;

GLFW_KEY_KP_2 = 322;

GLFW_KEY_KP_3 = 323;

GLFW_KEY_KP_4 = 324;

GLFW_KEY_KP_5 = 325;

GLFW_KEY_KP_6 = 326;

GLFW_KEY_KP_7 = 327;

GLFW_KEY_KP_8 = 328;

GLFW_KEY_KP_9 = 329;

GLFW_KEY_KP_DECIMAL = 330;

GLFW_KEY_KP_DIVIDE = 331;

GLFW_KEY_KP_MULTIPLY = 332;

GLFW_KEY_KP_SUBTRACT = 333;

GLFW_KEY_KP_ADD = 334;

GLFW_KEY_KP_ENTER = 335;

GLFW_KEY_KP_EQUAL = 336;

GLFW_KEY_LEFT_SHIFT = 340;

GLFW_KEY_LEFT_CONTROL = 341;

GLFW_KEY_LEFT_ALT = 342;

GLFW_KEY_LEFT_SUPER = 343;

GLFW_KEY_RIGHT_SHIFT = 344;

GLFW_KEY_RIGHT_CONTROL = 345;

GLFW_KEY_RIGHT_ALT = 346;

GLFW_KEY_RIGHT_SUPER = 347;

GLFW_KEY_MENU = 348;

GLFW_KEY_LAST = GLFW_KEY_MENU;

GLFW_MOD_SHIFT = $0001;

GLFW_MOD_CONTROL = $0002;

GLFW_MOD_ALT = $0004;

GLFW_MOD_SUPER = $0008;

GLFW_MOUSE_BUTTON_1 = 0;

GLFW_MOUSE_BUTTON_2 = 1;

GLFW_MOUSE_BUTTON_3 = 2;

GLFW_MOUSE_BUTTON_4 = 3;

GLFW_MOUSE_BUTTON_5 = 4;

GLFW_MOUSE_BUTTON_6 = 5;

GLFW_MOUSE_BUTTON_7 = 6;

GLFW_MOUSE_BUTTON_8 = 7;

GLFW_MOUSE_BUTTON_LAST = GLFW_MOUSE_BUTTON_8;

GLFW_MOUSE_BUTTON_LEFT = GLFW_MOUSE_BUTTON_1;

GLFW_MOUSE_BUTTON_RIGHT = GLFW_MOUSE_BUTTON_2;

GLFW_MOUSE_BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_3;

GLFW_JOYSTICK_1 = 0;

GLFW_JOYSTICK_2 = 1;

GLFW_JOYSTICK_3 = 2;

GLFW_JOYSTICK_4 = 3;

GLFW_JOYSTICK_5 = 4;

GLFW_JOYSTICK_6 = 5;

GLFW_JOYSTICK_7 = 6;

GLFW_JOYSTICK_8 = 7;

GLFW_JOYSTICK_9 = 8;

GLFW_JOYSTICK_10 = 9;

GLFW_JOYSTICK_11 = 10;

GLFW_JOYSTICK_12 = 11;

GLFW_JOYSTICK_13 = 12;

GLFW_JOYSTICK_14 = 13;

GLFW_JOYSTICK_15 = 14;

GLFW_JOYSTICK_16 = 15;

GLFW_JOYSTICK_LAST = GLFW_JOYSTICK_16;

GLFW_NOT_INITIALIZED = $00010001;

GLFW_NO_CURRENT_CONTEXT = $00010002;

GLFW_INVALID_ENUM = $00010003;

GLFW_INVALID_VALUE = $00010004;

GLFW_OUT_OF_MEMORY = $00010005;

GLFW_API_UNAVAILABLE = $00010006;

GLFW_VERSION_UNAVAILABLE = $00010007;

GLFW_PLATFORM_ERROR = $00010008;

GLFW_FORMAT_UNAVAILABLE = $00010009;

GLFW_NO_WINDOW_CONTEXT = $0001000A;

GLFW_FOCUSED = $00020001;

GLFW_ICONIFIED = $00020002;

GLFW_RESIZABLE = $00020003;

GLFW_VISIBLE = $00020004;

GLFW_DECORATED = $00020005;

GLFW_AUTO_ICONIFY = $00020006;

GLFW_FLOATING = $00020007;

GLFW_MAXIMIZED = $00020008;

GLFW_RED_BITS = $00021001;

GLFW_GREEN_BITS = $00021002;

GLFW_BLUE_BITS = $00021003;

GLFW_ALPHA_BITS = $00021004;

GLFW_DEPTH_BITS = $00021005;

GLFW_STENCIL_BITS = $00021006;

GLFW_ACCUM_RED_BITS = $00021007;

GLFW_ACCUM_GREEN_BITS = $00021008;

GLFW_ACCUM_BLUE_BITS = $00021009;

GLFW_ACCUM_ALPHA_BITS = $0002100A;

GLFW_AUX_BUFFERS = $0002100B;

GLFW_STEREO = $0002100C;

GLFW_SAMPLES = $0002100D;

GLFW_SRGB_CAPABLE = $0002100E;

GLFW_REFRESH_RATE = $0002100F;

GLFW_DOUBLEBUFFER = $00021010;

GLFW_CLIENT_API = $00022001;

GLFW_CONTEXT_VERSION_MAJOR = $00022002;

GLFW_CONTEXT_VERSION_MINOR = $00022003;

GLFW_CONTEXT_REVISION = $00022004;

GLFW_CONTEXT_ROBUSTNESS = $00022005;

GLFW_OPENGL_FORWARD_COMPAT = $00022006;

GLFW_OPENGL_DEBUG_CONTEXT = $00022007;

GLFW_OPENGL_PROFILE = $00022008;

GLFW_CONTEXT_RELEASE_BEHAVIOR = $00022009;

GLFW_CONTEXT_NO_ERROR = $0002200A;

GLFW_CONTEXT_CREATION_API = $0002200B;

GLFW_NO_API = 0;

GLFW_OPENGL_API = $00030001;

GLFW_OPENGL_ES_API = $00030002;

GLFW_NO_ROBUSTNESS = 0;

GLFW_NO_RESET_NOTIFICATION = $00031001;

GLFW_LOSE_CONTEXT_ON_RESET = $00031002;

GLFW_OPENGL_ANY_PROFILE = 0;

GLFW_OPENGL_CORE_PROFILE = $00032001;

GLFW_OPENGL_COMPAT_PROFILE = $00032002;

GLFW_CURSOR = $00033001;

GLFW_STICKY_KEYS = $00033002;

GLFW_STICKY_MOUSE_BUTTONS = $00033003;

GLFW_CURSOR_NORMAL = $00034001;

GLFW_CURSOR_HIDDEN = $00034002;

GLFW_CURSOR_DISABLED = $00034003;

GLFW_ANY_RELEASE_BEHAVIOR = 0;

GLFW_RELEASE_BEHAVIOR_FLUSH = $00035001;

GLFW_RELEASE_BEHAVIOR_NONE = $00035002;

GLFW_NATIVE_CONTEXT_API = $00036001;

GLFW_EGL_CONTEXT_API = $00036002;

GLFW_ARROW_CURSOR = $00036001;

GLFW_IBEAM_CURSOR = $00036002;

GLFW_CROSSHAIR_CURSOR = $00036003;

GLFW_HAND_CURSOR = $00036004;

GLFW_HRESIZE_CURSOR = $00036005;

GLFW_VRESIZE_CURSOR = $00036006;

GLFW_CONNECTED = $00040001;

GLFW_DISCONNECTED = $00040002;

GLFW_DONT_CARE = -1;

Description

Functions and Procedures

function glfwInit(): Integer; cdecl external GLFW3_LIB name _PU + 'glfwInit';

Initializes the GLFW library.

This function initializes the GLFW library. Before most GLFW functions can be used, GLFW must be initialized, and before an application terminates GLFW should be terminated in order to free any resources allocated during or after initialization.

If this function fails, it calls glfwTerminate before returning. If it succeeds, you should call glfwTerminate before the application exits.

Additional calls to this function after successful initialization but before termination will return GLFW_TRUE immediately.

Possible errors include GLFW_PLATFORM_ERROR.

On macOS, this function will change the current directory of the application to the Contents/Resources subdirectory of the application's bundle, if present.

This function must only be called from the main thread.

Added in version 1.0.

Returns

GLFW_TRUE if successful, or GLFW_FALSE if an error occurred.

Parameters

major: Where to store the major version number, or nil.
minor: Where to store the minor version number, or nil.
rev: Where to store the revision number, or nil.

Returns

The ASCII encoded GLFW version string.

Parameters

cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set.

function glfwGetMonitors(out count: Integer): PPGLFWmonitor; cdecl external GLFW3_LIB name _PU + 'glfwGetMonitors';

Returns the currently connected monitors.

This function returns an array of handles for all currently connected monitors. The primary monitor is always first in the returned array. If no monitors were found, this function returns nil.

Possible errors include GLFW_NOT_INITIALIZED.

The returned array is allocated and freed by GLFW. You should not free it yourself. It is guaranteed to be valid only until the monitor configuration changes or the library is terminated.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

count: Where to store the number of monitors in the returned array. This is set to zero if an error occurred.

Returns

An array of monitor handles, or nil if no monitors were found or if an error occurred.

Returns

The primary monitor, or nil if no monitors were found or if an error occurred.

Parameters

monitor: The monitor to query.
xpos: Where to store the monitor x-coordinate, or nil.
ypos: Where to store the monitor y-coordinate, or nil.

procedure glfwGetMonitorPhysicalSize(monitor: PGLFWmonitor; widthMM, heightMM: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetMonitorPhysicalSize';

Returns the physical size of the monitor.

This function returns the size, in millimetres, of the display area of the specified monitor.

Some systems do not provide accurate monitor size information, either because the monitor EDID (https://en.wikipedia.org/wiki/Extended_display_identification_data) data is incorrect or because the driver does not report it accurately.

Any or all of the size arguments may be nil. If an error occurs, all non-nil size arguments will be set to zero.

Possible errors include GLFW_NOT_INITIALIZED.

On Windows, calculates the returned physical size from the current resolution and system DPI instead of querying the monitor EDID data.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

monitor: The monitor to query.
widthMM: Where to store the width, in millimetres, of the monitor's display area, or nil.
heightMM: Where to store the height, in millimetres, of the monitor's display area, or nil.

function glfwGetMonitorName(monitor: PGLFWmonitor): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetMonitorName';

Returns the name of the specified monitor.

This function returns a human-readable name, encoded as UTF-8, of the specified monitor. The name typically reflects the make and model of the monitor and is not guaranteed to be unique among the connected monitors.

Possible errors include GLFW_NOT_INITIALIZED.

The returned string is allocated and freed by GLFW. You should not free it yourself. It is valid until the specified monitor is disconnected or the library is terminated.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

monitor: The monitor to query.

Returns

The UTF-8 encoded name of the monitor, or nil if an error occurred.

function glfwSetMonitorCallback(cbfun: TGLFWmonitorfun): TGLFWmonitorfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetMonitorCallback';

Sets the monitor configuration callback.

This function sets the monitor configuration callback, or removes the currently set callback. This is called when a monitor is connected to or disconnected from the system.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwGetVideoModes(monitor: PGLFWmonitor; out count: Integer): PGLFWvidmode; cdecl  external GLFW3_LIB name _PU + 'glfwGetVideoModes';

Returns the available video modes for the specified monitor.

This function returns an array of all video modes supported by the specified monitor. The returned array is sorted in ascending order, first by color bit depth (the sum of all channel depths) and then by resolution area (the product of width and height).

Possible errors include ref GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

The returned array is allocated and freed by GLFW. You should not free it yourself. It is valid until the specified monitor is disconnected, this function is called again for that monitor or the library is terminated.

This function must only be called from the main thread.

Added in version 1.0. GLFW3 changed to return an array of modes for a specific monitor.

Parameters

monitor: The monitor to query.
count: Where to store the number of video modes in the returned array. This is set to zero if an error occurred.

Returns

An array of video modes, or nil if an error occurred.

Parameters

monitor: The monitor to query.

Returns

The current mode of the monitor, or nil if an error occurred.

Parameters

monitor: The monitor whose gamma ramp to set.
gamma: The desired exponent.

function glfwGetGammaRamp(monitor: PGLFWmonitor): PGLFWgammaramp; cdecl  external GLFW3_LIB name _PU + 'glfwGetGammaRamp';

Returns the current gamma ramp for the specified monitor.

This function returns the current gamma ramp of the specified monitor.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

The returned structure and its arrays are allocated and freed by GLFW. You should not free them yourself. They are valid until the specified monitor is disconnected, this function is called again for that monitor or the library is terminated.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

monitor: The monitor to query.

Returns

The current gamma ramp, or nil if an error occurred.

procedure glfwSetGammaRamp(monitor: PGLFWmonitor; const ramp: PGLFWgammaramp); cdecl  external GLFW3_LIB name _PU + 'glfwSetGammaRamp';

Sets the current gamma ramp for the specified monitor.

This function sets the current gamma ramp for the specified monitor. The original gamma ramp for that monitor is saved by GLFW the first time this function is called and is restored by glfwTerminate.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Gamma ramp sizes other than 256 are not supported by all platforms or graphics hardware.

On Windows, the gamma ramp size must be 256.

The specified gamma ramp is copied before this function returns.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

monitor: The monitor whose gamma ramp to set.
ramp: The gamma ramp to use.

procedure glfwDefaultWindowHints(); cdecl external GLFW3_LIB name _PU + 'glfwDefaultWindowHints';

Resets all window hints to their default values.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

hint: The window hint to set.
value: The new value of the window hint.

Parameters

width: The desired width, in screen coordinates, of the window. This must be greater than zero.
height: The desired height, in screen coordinates, of the window. This must be greater than zero.
title: The initial, UTF-8 encoded window title.
monitor: The monitor to use for full screen mode, or nil for windowed mode.
share: The window whose context to share resources with, or nil to not share resources.

Returns

The handle of the created window, or nil if an error occurred.

Parameters

window: The window to destroy.

Parameters

window: The window to query.

Returns

The value of the close flag.

procedure glfwSetWindowShouldClose(window: PGLFWwindow; value: Integer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowShouldClose';

Sets the close flag of the specified window.

This function sets the value of the close flag of the specified window. This can be used to override the user's attempt to close the window, or to signal that it should be closed.

Possible errors include GLFW_NOT_INITIALIZED.

This function may be called from any thread. Access is not synchronized.

Added in version 3.0.

Parameters

window: The window whose flag to change.
value: The new value.

procedure glfwSetWindowTitle(window: PGLFWwindow; const title: PAnsiChar); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowTitle';

Sets the title of the specified window.

This function sets the window title, encoded as UTF-8, of the specified window.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

On macOS, the window title will not be updated until the next time you process events.

This function must only be called from the main thread.

Added in version 1.0. GLFW3 Added window handle parameter.

Parameters

window: The window whose title to change.
title: The UTF-8 encoded window title.

procedure glfwSetWindowIcon(window: PGLFWwindow; count: Integer; const images: PGLFWimage); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowIcon';

Sets the icon for the specified window.

This function sets the icon of the specified window. If passed an array of candidate images, those of or closest to the sizes desired by the system are selected. If no images are specified, the window reverts to its default icon.

The desired image sizes varies depending on platform and system settings. The selected images will be rescaled as needed. Good sizes include 16x16, 32x32 and 48x48.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

The specified image data is copied before this function returns.

On macOS, the GLFW window has no icon, as it is not a document window, so this function does nothing. The dock icon will be the same as the application bundle's icon. For more information on bundles, see the Bundle Programming Guide (https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/) in the Mac Developer Library.

This function must only be called from the main thread.

Added in version 3.2.

Parameters

window: The window whose icon to set.
count: The number of images in the specified array, or zero to revert to the default window icon.
images: The images to create the icon from. This is ignored if count is zero.

procedure glfwGetWindowPos(window: PGLFWwindow; xpos, ypos: PInteger); cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowPos';

Retrieves the position of the client area of the specified window.

This function retrieves the position, in screen coordinates, of the upper-left corner of the client area of the specified window.

Any or all of the position arguments may be nil. If an error occurs, all non-nil position arguments will be set to zero.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

window: The window to query.
xpos: Where to store the x-coordinate of the upper-left corner of the client area, or nil.
ypos: Where to store the y-coordinate of the upper-left corner of the client area, or nil.

Parameters

window: The window to query.
xpos: The x-coordinate of the upper-left corner of the client area.
ypos: The y-coordinate of the upper-left corner of the client area.

Parameters

window: The window whose size to retrieve.
width: Where to store the width, in screen coordinates, of the client area, or nil.
height: Where to store the height, in screen coordinates, of the client area, or nil.

Parameters

window: The window to set limits for.
minwidth: The minimum width, in screen coordinates, of the client area, or GLFW_DONT_CARE.
minheight: The minimum height, in screen coordinates, of the client area, or GLFW_DONT_CARE.
maxwidth: The maximum width, in screen coordinates, of the client area, or GLFW_DONT_CARE.
maxheight: The maximum height, in screen coordinates, of the client area, or GLFW_DONT_CARE.

Parameters

window: The window to set limits for.
numer: The numerator of the desired aspect ratio, or GLFW_DONT_CARE.
denom: The denominator of the desired aspect ratio, or GLFW_DONT_CARE.

Parameters

window: The window to resize.
width: The desired width, in screen coordinates, of the window client area.
height: The desired height, in screen coordinates, of the window client area.

Parameters

window: The window whose framebuffer to query.
width: Where to store the width, in pixels, of the framebuffer, or nil.
height: Where to store the height, in pixels, of the framebuffer, or nil.

Parameters

window: The window whose frame size to query.
left: Where to store the size, in screen coordinates, of the left edge of the window frame, or nil.
top: Where to store the size, in screen coordinates, of the top edge of the window frame, or nil.
right: Where to store the size, in screen coordinates, of the right edge of the window frame, or nil.
bottom: Where to store the size, in screen coordinates, of the bottom edge of the window frame, or nil.

procedure glfwIconifyWindow(window: PGLFWwindow); cdecl external GLFW3_LIB name _PU + 'glfwIconifyWindow';

Iconifies the specified window.

This function iconifies (minimizes) the specified window if it was previously restored. If the window is already iconified, this function does nothing.

If the specified window is a full screen window, the original monitor resolution is restored until the window is restored.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

This function must only be called from the main thread.

Added in version 2.1. GLFW3 added window handle parameter.

Parameters

window: The window to iconify.

Parameters

window: The window to restore.

Parameters

window: The window to maximize.

Parameters

window: The window to make visible.

Parameters

window: The window to hide.

Parameters

window: The window to give input focus.

function glfwGetWindowMonitor(window: PGLFWwindow): PGLFWmonitor; cdecl  external GLFW3_LIB name _PU + 'glfwGetWindowMonitor';

Returns the monitor that the window uses for full screen mode.

This function returns the handle of the monitor that the specified window is in full screen on.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

window: The window to query.

Returns

The monitor, or nil if the window is in windowed mode or an error occurred.

Parameters

window: The window whose monitor, size or video mode to set.
monitor: The desired monitor, or nil to set windowed mode.
xpos: The desired x-coordinate of the upper-left corner of the client area.
ypos: The desired y-coordinate of the upper-left corner of the client area.
width: The desired with, in screen coordinates, of the client area or video mode.
height: The desired height, in screen coordinates, of the client area or video mode.
refreshRate: The desired refresh rate, in Hz, of the video mode, or GLFW_DONT_CARE.

Parameters

window: The window to query.
attrib: The window attribute whose value to return.

Returns

The value of the attribute, or zero if an error occurred.

procedure glfwSetWindowUserPointer(window: PGLFWwindow; pointer: Pointer); cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowUserPointer';

Sets the user pointer of the specified window.

This function sets the user-defined pointer of the specified window. The current value is retained until the window is destroyed. The initial value is nil.

Possible errors include GLFW_NOT_INITIALIZED.

This function may be called from any thread. Access is not synchronized.

Added in version 3.0.

Parameters

window: The window whose pointer to set.
pointer: The new value.

Parameters

window: The window whose pointer to return.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetWindowSizeCallback(window: PGLFWwindow; cbfun: TGLFWwindowsizefun): TGLFWwindowsizefun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowSizeCallback';

Sets the size callback for the specified window.

This function sets the size callback of the specified window, which is called when the window is resized. The callback is provided with the size, in screen coordinates, of the client area of the window.

Returns: The previously set callback, or nil if no callback was set or the library had not been initialized.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 1.0. GLFW3 added window handle parameter and return value.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

function glfwSetWindowCloseCallback(window: PGLFWwindow; cbfun: TGLFWwindowclosefun): TGLFWwindowclosefun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowCloseCallback';

Sets the close callback for the specified window.

This function sets the close callback of the specified window, which is called when the user attempts to close the window, for example by clicking the close widget in the title bar.

The close flag is set before this callback is called, but you can modify it at any time with glfwSetWindowShouldClose.

The close callback is not triggered by glfwDestroyWindow.

Possible errors include GLFW_NOT_INITIALIZED.

On macOS, selecting Quit from the application menu will trigger the close callback for all windows.

This function must only be called from the main thread.

Added in version 2.5. GLFW3 added window handle parameter and return value.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetWindowRefreshCallback(window: PGLFWwindow; cbfun: TGLFWwindowrefreshfun): TGLFWwindowrefreshfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowRefreshCallback';

Sets the refresh callback for the specified window.

This function sets the refresh callback of the specified window, which is called when the client area of the window needs to be redrawn, for example if the window has been exposed after having been covered by another window.

On compositing window systems such as Aero, Compiz or Aqua, where the window contents are saved off-screen, this callback may be called only very infrequently or never at all.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 2.5. GLFW3 added window handle parameter and return value.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetWindowFocusCallback(window: PGLFWwindow; cbfun: TGLFWwindowfocusfun): TGLFWwindowfocusfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowFocusCallback';

Sets the focus callback for the specified window.

This function sets the focus callback of the specified window, which is called when the window gains or loses input focus.

After the focus callback is called for a window that lost input focus, synthetic key and mouse button release events will be generated for all such that had been pressed. For more information, see glfwSetKeyCallback and glfwSetMouseButtonCallback.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetWindowIconifyCallback(window: PGLFWwindow; cbfun: TGLFWwindowiconifyfun): TGLFWwindowiconifyfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetWindowIconifyCallback';

Sets the iconify callback for the specified window.

This function sets the iconification callback of the specified window, which is called when the window is iconified or restored.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetFramebufferSizeCallback(window: PGLFWwindow; cbfun: TGLFWframebuffersizefun): TGLFWframebuffersizefun; cdecl  external GLFW3_LIB name _PU + 'glfwSetFramebufferSizeCallback';

Sets the framebuffer resize callback for the specified window.

This function sets the framebuffer resize callback of the specified window, which is called when the framebuffer of the specified window is resized.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

procedure glfwPollEvents(); cdecl external GLFW3_LIB name _PU + 'glfwPollEvents';

Processes all pending events.

This function processes only those events that are already in the event queue and then returns immediately. Processing events will cause the window and input callbacks associated with those events to be called.

On some platforms, a window move, resize or menu operation will cause event processing to block. This is due to how event processing is designed on those platforms. You can use the window refresh callback to redraw the contents of your window when necessary during such operations.

On some platforms, certain events are sent directly to the application without going through the event queue, causing callbacks to be called outside of a call to one of the event processing functions.

Event processing is not required for joystick input to work.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

This function must not be called from a callback.

This function must only be called from the main thread.

Added in version 1.0.

Parameters

timeout: The maximum amount of time, in seconds, to wait.

Parameters

window: The window to query.
mode: One of GLFW_CURSOR, GLFW_STICKY_KEYS or GLFW_STICKY_MOUSE_BUTTONS.

Parameters

window: The window whose input mode to set.
mode: One of GLFW_CURSOR, GLFW_STICKY_KEYS or GLFW_STICKY_MOUSE_BUTTONS.
value: The new value of the specified input mode.

Parameters

key: The key to query, or GLFW_KEY_UNKNOWN.
scancode: The scancode of the key to query.

Returns

The localized name of the key, or nil.

function glfwGetKey(window: PGLFWwindow; key: Integer): Integer; cdecl external GLFW3_LIB name _PU + 'glfwGetKey';

Returns the last reported state of a keyboard key for the specified window.

This function returns the last state reported for the specified key to the specified window. The returned state is one of GLFW_PRESS or GLFW_RELEASE. The higher-level action GLFW_REPEAT is only reported to the key callback.

If the GLFW_STICKY_KEYS input mode is enabled, this function returns GLFW_PRESS the first time you call it for a key that was pressed, even if that key has already been released.

The key functions deal with physical keys, with key tokens named after their use on the standard US keyboard layout. If you want to input text, use the Unicode character callback instead.

The modifier key bit masks are not key tokens and cannot be used with this function.

Do not use this function to implement text input.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.

This function must only be called from the main thread.

Added in version 1.0. GLFW3 added window handle parameter.

Parameters

window: The desired window.
key: The desired keyboard key. GLFW_KEY_UNKNOWN is not a valid key for this function.

Returns

One of GLFW_PRESS or GLFW_RELEASE.

function glfwGetMouseButton(window: PGLFWwindow; button: Integer): Integer; cdecl  external GLFW3_LIB name _PU + 'glfwGetMouseButton';

Returns the last reported state of a mouse button for the specified window.

This function returns the last state reported for the specified mouse button to the specified window. The returned state is one of GLFW_PRESS or GLFW_RELEASE.

If the GLFW_STICKY_MOUSE_BUTTONS input mode is enabled, this function GLFW_PRESS the first time you call it for a mouse button that was pressed, even if that mouse button has already been released.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.

This function must only be called from the main thread.

Added in version 1.0. GLFW3 added window handle parameter.

Parameters

window: The desired window.
button: The desired mouse button.

Returns

One of GLFW_PRESS or GLFW_RELEASE.

procedure glfwGetCursorPos(window: PGLFWwindow; xpos, ypos: PDouble); cdecl  external GLFW3_LIB name _PU + 'glfwGetCursorPos';

Retrieves the position of the cursor relative to the client area of the window.

This function returns the position of the cursor, in screen coordinates, relative to the upper-left corner of the client area of the specified window.

If the cursor is disabled (with GLFW_CURSOR_DISABLED) then the cursor position is unbounded and limited only by the minimum and maximum values of a double.

The coordinate can be converted to their integer equivalents with the floor function. Casting directly to an integer type works for positive coordinates, but fails for negative ones.

Any or all of the position arguments may be nil. If an error occurs, all non-nil position arguments will be set to zero.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

This function must only be called from the main thread.

Added in version 3.0. Replaces glfwGetMousePos.

Parameters

window: The desired window.
xpos: Where to store the cursor x-coordinate, relative to the left edge of the client area, or nil.
ypos: Where to store the cursor y-coordinate, relative to the to top edge of the client area, or nil.

Parameters

window: The desired window.
xpos: The desired x-coordinate, relative to the left edge of the client area.
ypos: The desired y-coordinate, relative to the top edge of the client area.

Parameters

image: The desired cursor image.
xhot: The desired x-coordinate, in pixels, of the cursor hotspot.
yhot: The desired y-coordinate, in pixels, of the cursor hotspot.

Returns

The handle of the created cursor, or nil if an error occurred.

Parameters

shape: One of the standard shapes.

Returns

A new cursor ready to use or nil if an error occurred.

Parameters

cursor: The cursor object to destroy.

Parameters

window: The window to set the cursor for.
cursor: The cursor to set, or nil to switch back to the default arrow cursor.

function glfwSetKeyCallback(window: PGLFWwindow; cbfun: TGLFWkeyfun): TGLFWkeyfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetKeyCallback';

Sets the key callback.

This function sets the key callback of the specified window, which is called when a key is pressed, repeated or released.

The key functions deal with physical keys, with layout independent key tokens named after their values in the standard US keyboard layout. If you want to input text, use the character callback instead.

When a window loses input focus, it will generate synthetic key release events for all pressed keys. You can tell these events from user-generated events by the fact that the synthetic ones are generated after the focus loss event has been processed, i.e. after the window focus callback (glfwSetWindowFocusCallback) has been called.

The scancode of a key is specific to that platform or sometimes even to that machine. Scancodes are intended to allow users to bind keys that don't have a GLFW key token. Such keys have key set to GLFW_KEY_UNKNOWN, their state is not saved and so it cannot be queried with glfwGetKey.

Sometimes GLFW needs to generate synthetic key events, in which case the scancode may be zero.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 1.0. GLFW3 added window handle parameter and return value.

Parameters

window: The window whose callback to set.
cbfun: The new key callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetCharCallback(window: PGLFWwindow; cbfun: TGLFWcharfun): TGLFWcharfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCharCallback';

Sets the Unicode character callback.

This function sets the character callback of the specified window, which is called when a Unicode character is input.

The character callback is intended for Unicode text input. As it deals with characters, it is keyboard layout dependent, whereas the key callback (glfwSetKeyCallback) is not. Characters do not map 1:1 to physical keys, as a key may produce zero, one or more characters. If you want to know whether a specific physical key was pressed or released, see the key callback instead.

The character callback behaves as system text input normally does and will not be called if modifier keys are held down that would prevent normal text input on that platform, for example a Super (Command) key on OS X or Alt key on Windows. There is a character with modifiers callback (glfwSetCharModsCallback) that receives these events.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 2.4. GLFW3 added window handle parameter and return value.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetCharModsCallback(window: PGLFWwindow; cbfun: TGLFWcharmodsfun): TGLFWcharmodsfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCharModsCallback';

Sets the Unicode character with modifiers callback.

This function sets the character with modifiers callback of the specified window, which is called when a Unicode character is input regardless of what modifier keys are used.

The character with modifiers callback is intended for implementing custom Unicode character input. For regular Unicode text input, see the character callback (glfwSetCharCallback). Like the character callback, the character with modifiers callback deals with characters and is keyboard layout dependent. Characters do not map 1:1 to physical keys, as a key may produce zero, one or more characters. If you want to know whether a specific physical key was pressed or released, see the key callback (glfwSetKeyCallback) instead.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.1.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or an error occurred.

function glfwSetMouseButtonCallback(window: PGLFWwindow; cbfun: TGLFWmousebuttonfun): TGLFWmousebuttonfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetMouseButtonCallback';

Sets the mouse button callback.

This function sets the mouse button callback of the specified window, which is called when a mouse button is pressed or released.

When a window loses input focus, it will generate synthetic mouse button release events for all pressed mouse buttons. You can tell these events from user-generated events by the fact that the synthetic ones are generated after the focus loss event has been processed, i.e. after the window focus callback (glfwSetWindowFocusCallback) has been called.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 1.0. GLFW3 added window handle parameter and return value.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetCursorPosCallback(window: PGLFWwindow; cbfun: TGLFWcursorposfun): TGLFWcursorposfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCursorPosCallback';

Sets the cursor position callback.

This function sets the cursor position callback of the specified window, which is called when the cursor is moved. The callback is provided with the position, in screen coordinates, relative to the upper-left corner of the client area of the window.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0. Replaces glfwSetMousePosCallback.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetCursorEnterCallback(window: PGLFWwindow; cbfun: TGLFWcursorenterfun): TGLFWcursorenterfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetCursorEnterCallback';

Sets the cursor enter/exit callback.

This function sets the cursor boundary crossing callback of the specified window, which is called when the cursor enters or leaves the client area of the window.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

window: The window whose callback to set.
cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetScrollCallback(window: PGLFWwindow; cbfun: TGLFWscrollfun): TGLFWscrollfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetScrollCallback';

Sets the scroll callback.

This function sets the scroll callback of the specified window, which is called when a scrolling device is used, such as a mouse wheel or scrolling area of a touchpad.

The scroll callback receives all scrolling input, like that from a mouse wheel or a touchpad scrolling area.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.0. Replaces glfwSetMouseWheelCallback.

Parameters

window: The window whose callback to set.
cbfun: The new scroll callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwSetDropCallback(window: PGLFWwindow; cbfun: TGLFWdropfun): TGLFWdropfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetDropCallback';

Sets the file drop callback.

This function sets the file drop callback of the specified window, which is called when one or more dragged files are dropped on the window.

Because the path array and its strings may have been generated specifically for that event, they are not guaranteed to be valid after the callback has returned. If you wish to use them after the callback returns, you need to make a deep copy.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.1.

Parameters

window: The window whose callback to set.
cbfun: The new file drop callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

function glfwJoystickPresent(joy: Integer): Integer; cdecl external GLFW3_LIB name _PU + 'glfwJoystickPresent';

Returns whether the specified joystick is present.

This function returns whether the specified joystick is present.

Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.

This function must only be called from the main thread.

Added in version 3.0. Replaces glfwGetJoystickParam.

Parameters

joy: The joystick to query.

Returns

GLFW_TRUE if the joystick is present, or GLFW_FALSE otherwise.

function glfwGetJoystickAxes(joy: Integer; out count: Integer): PSingle; cdecl  external GLFW3_LIB name _PU + 'glfwGetJoystickAxes';

Returns the values of all axes of the specified joystick.

This function returns the values of all axes of the specified joystick. Each element in the array is a value between -1.0 and 1.0.

Querying a joystick slot with no device present is not an error, but will cause this function to return nil. Call glfwJoystickPresent to check device presence.

Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.

The returned array is allocated and freed by GLFW. You should not free it yourself. It is valid until the specified joystick is disconnected, this function is called again for that joystick or the library is terminated.

This function must only be called from the main thread.

Added in version 3.0. Replaces glfwGetJoystickPos.

Parameters

joy: The joystick to query.
count: Where to store the number of axis values in the returned array. This is set to zero if the joystick is not present or an error occurred.

Returns

An array of axis values, or nil if the joystick is not present or an error occurred.

function glfwGetJoystickButtons(joy: Integer; out count: Integer): PByte; cdecl  external GLFW3_LIB name _PU + 'glfwGetJoystickButtons';

Returns the state of all buttons of the specified joystick.

This function returns the state of all buttons of the specified joystick. Each element in the array is either GLFW_PRESS or GLFW_RELEASE.

Querying a joystick slot with no device present is not an error, but will cause this function to return nil. Call glfwJoystickPresent to check device presence.

Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.

This function must only be called from the main thread.

Added in version 2.2. GLFW3 changed to return a dynamic array.

Parameters

joy: The joystick to query.
count: Where to store the number of button states in the returned array. This is set to zero if the joystick is not present or an error occurred.

Returns

An array of button states, or nil if the joystick is not present or an error occurred.

function glfwGetJoystickName(joy: Integer): PAnsiChar; cdecl external GLFW3_LIB name _PU + 'glfwGetJoystickName';

Returns the name of the specified joystick.

This function returns the name, encoded as UTF-8, of the specified joystick. The returned string is allocated and freed by GLFW. You should not free it yourself.

Querying a joystick slot with no device present is not an error, but will cause this function to return nil. Call glfwJoystickPresent to check device presence.

Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.

The returned string is allocated and freed by GLFW. You should not free it yourself. It is valid until the specified joystick is disconnected, this function is called again for that joystick or the library is terminated.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

joy: The joystick to query.

Returns

The UTF-8 encoded name of the joystick, or nil if the joystick is not present or an error occurred.

function glfwSetJoystickCallback(cbfun: TGLFWjoystickfun): TGLFWjoystickfun; cdecl  external GLFW3_LIB name _PU + 'glfwSetJoystickCallback';

Sets the joystick configuration callback.

This function sets the joystick configuration callback, or removes the currently set callback. This is called when a joystick is connected to or disconnected from the system.

Possible errors include GLFW_NOT_INITIALIZED.

This function must only be called from the main thread.

Added in version 3.2.

Parameters

cbfun: The new callback, or nil to remove the currently set callback.

Returns

The previously set callback, or nil if no callback was set or the library had not been initialized.

procedure glfwSetClipboardString(window: PGLFWwindow; const text: PAnsiChar); cdecl  external GLFW3_LIB name _PU + 'glfwSetClipboardString';

Sets the clipboard to the specified string.

This function sets the system clipboard to the specified, UTF-8 encoded string.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

The specified string is copied before this function returns.

This function must only be called from the main thread.

Added in version 3.0.

Parameters

window: The window that will own the clipboard contents.
text: string A UTF-8 encoded string.

Parameters

window: The window that will request the clipboard contents.

Returns

The contents of the clipboard as a UTF-8 encoded string, or nil if an error occurred.

Parameters

time: The new value, in seconds.

function glfwGetTimerValue(): UInt64; cdecl external GLFW3_LIB name _PU + 'glfwGetTimerValue';

Returns the current value of the raw timer.

This function returns the current value of the raw timer, measured in 1/frequency seconds. To get the frequency, call glfwGetTimerFrequency.

Returns: The value of the timer, or zero if an error occurred.

Possible errors include GLFW_NOT_INITIALIZED.

This function may be called from any thread.

Added in version 3.2.

Returns

The frequency of the timer, in Hz, or zero if an error occurred.

Parameters

window: The window whose context to make current, or nil to detach the current context.

Parameters

window: The window whose buffers to swap.

Parameters

interval: The minimum number of screen updates to wait for until the buffers are swapped by glfwSwapBuffers.

Parameters

extension: The ASCII encoded name of the extension.

Returns

GLFW_TRUE if the extension is available, or GLFW_FALSE otherwise.

Parameters

procname: The ASCII encoded name of the function.

Returns

The address of the function, or nil if an error occurred.

Returns

GLFW_TRUE if Vulkan is available, or GLFW_FALSE otherwise.

function glfwGetRequiredInstanceExtensions(out count: UInt32): PPAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetRequiredInstanceExtensions';

Returns the Vulkan instance extensions required by GLFW.

This function returns an array of names of Vulkan instance extensions required by GLFW for creating Vulkan surfaces for GLFW windows. If successful, the list will always contains VK_KHR_surface, so if you don't require any additional extensions you can pass this list directly to the VkInstanceCreateInfo struct.

If Vulkan is not available on the machine, this function returns nil and generates a GLFW_API_UNAVAILABLE error. Call glfwVulkanSupported to check whether Vulkan is available.

If Vulkan is available but no set of extensions allowing window surface creation was found, this function returns nil. You may still use Vulkan for off-screen rendering and compute work.

Possible errors include GLFW_NOT_INITIALIZED and GLFW_API_UNAVAILABLE.

Additional extensions may be required by future versions of GLFW. You should check if any extensions you wish to enable are already in the returned array, as it is an error to specify an extension more than once in the VkInstanceCreateInfo struct.

The returned array is allocated and freed by GLFW. You should not free it yourself. It is guaranteed to be valid only until the library is terminated.

This function may be called from any thread.

Added in version 3.2.

Parameters

count: Where to store the number of extensions in the returned array. This is set to zero if an error occurred.

Returns

An array of ASCII encoded extension names, or nil if an error occurred.

function glfwGetWin32Adapter(monitor: PGLFWmonitor): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetWin32Adapter';

Returns the adapter device name of the specified monitor.

Returns: The UTF-8 encoded adapter device name (for example \\.\DISPLAY1) of the specified monitor, or nil if an error occurred.

This function may be called from any thread. Access is not synchronized.

Added in version 3.1.

function glfwGetWin32Monitor(monitor: PGLFWmonitor): PAnsiChar; cdecl  external GLFW3_LIB name _PU + 'glfwGetWin32Monitor';

Returns the display device name of the specified monitor.

Returns: The UTF-8 encoded display device name (for example \\.\DISPLAY1\Monitor0) of the specified monitor, or nil if an error occurred.

This function may be called from any thread. Access is not synchronized.

Added in version 3.1.

function glfwGetWin32Window(window: PGLFWwindow): HWND; cdecl external GLFW3_LIB name _PU + 'glfwGetWin32Window';

Returns the HWND of the specified window.

Returns: The HWND of the specified window, or nil if an error occurred.

This function may be called from any thread. Access is not synchronized.

Added in version 3.0.

function glfwGetWGLContext(window: PGLFWwindow): HGLRC; cdecl external GLFW3_LIB name _PU + 'glfwGetWGLContext';

Returns the HGLRC of the specified window.

Returns: The HGLRC of the specified window, or nil if an error occurred.

This function may be called from any thread. Access is not synchronized.

Added in version 3.0.

function glfwGetCocoaMonitor(monitor: PGLFWmonitor): CGDirectDisplayID; cdecl  external GLFW3_LIB name _PU + 'glfwGetCocoaMonitor';

Returns the CGDirectDisplayID of the specified monitor.

Returns: The CGDirectDisplayID of the specified monitor, or kCGNullDirectDisplay if an error occurred.

This function may be called from any thread. Access is not synchronized.

Added in version 3.1.

function glfwGetCocoaWindow(window: PGLFWwindow): Id; cdecl external GLFW3_LIB name _PU + 'glfwGetCocoaWindow';

Returns the NSWindow of the specified window.

Returns: The NSWindow of the specified window, or nil if an error occurred.

This function may be called from any thread. Access is not synchronized.

Added in version 3.0.

function glfwGetNSGLContext(window: PGLFWwindow): Id; cdecl external GLFW3_LIB name _PU + 'glfwGetNSGLContext';

Returns the NSOpenGLContext of the specified window.

Returns: The NSOpenGLContext of the specified window, or nil if an error occurred.

This function may be called from any thread. Access is not synchronized.

Added in version 3.0.

Types

TGLFWglproc = procedure(); cdecl;

Client API function pointer type.

Generic function pointer used for returning client API function pointers without forcing a cast from a regular pointer.

Added in version 3.0.

Parameters

error: An error code.
description: A UTF-8 encoded string describing the error.

Parameters

window: The window that was moved.
xpos: The new x-coordinate, in screen coordinates, of the upper-left corner of the client area of the window.
ypos: The new y-coordinate, in screen coordinates, of the upper-left corner of the client area of the window.

Parameters

window: The window that was resized.
width: The new width, in screen coordinates, of the window.
height: The new height, in screen coordinates, of the window.

Parameters

window: The window that the user attempted to close.

Parameters

window: The window whose content needs to be refreshed.

Parameters

window: The window that gained or lost input focus.
focused: GLFW_TRUE if the window was given input focus, or GLFW_FALSE if it lost it.

Parameters

window: The window that was iconified or restored.
iconified: GLFW_TRUE if the window was iconified, or GLFW_FALSE if it was restored.

Parameters

window: The window whose framebuffer was resized.
width: The new width, in pixels, of the framebuffer.
height: The new height, in pixels, of the framebuffer.

Parameters

window: The window that received the event.
button: The mouse button that was pressed or released.
action: One of GLFW_PRESS or GLFW_RELEASE.
mods: Bit field describing which modifier keys were held down.

Parameters

window: The window that received the event.
xpos: The new cursor x-coordinate, relative to the left edge of the client area.
ypos: The new cursor y-coordinate, relative to the top edge of the client area.

Parameters

window: The window that received the event.
entered: GLFW_TRUE if the cursor entered the window's client area, or GLFW_FALSE if it left it.

Parameters

window: The window that received the event.
xoffset: The scroll offset along the x-axis.
yoffset: The scroll offset along the y-axis.

Parameters

window: The window that received the event.
key: The keyboard key that was pressed or released.
scancode: The system-specific scancode of the key.
action: GLFW_PRESS, GLFW_RELEASE or GLFW_REPEAT.
mods: Bit field describing which modifier keys were held down.

Parameters

window: The window that received the event.
codepoint: The Unicode code point of the character.

Parameters

window: The window that received the event.
codepoint: The Unicode code point of the character.
mods: Bit field describing which modifier keys were held down.

Parameters

window: The window that received the event.
count: The number of dropped files.
paths: The UTF-8 encoded file and/or directory path names.

Parameters

monitor: The monitor that was connected or disconnected.
event: One of GLFW_CONNECTED or GLFW_DISCONNECTED.

Parameters

joy: The joystick that was connected or disconnected.
event: One of GLFW_CONNECTED or GLFW_DISCONNECTED.

Constants

GLFW_VERSION_MAJOR = 3;

The major version number of the GLFW library. This is incremented when the API is changed in non-compatible ways.

GLFW_VERSION_MINOR = 2;

The minor version number of the GLFW library.

This is incremented when features are added to the API but it remains backward-compatible.

GLFW_VERSION_REVISION = 1;

The revision number of the GLFW library.

This is incremented when a bug fix release is made that does not contain any API changes.

GLFW_TRUE = 1;

One.

One. Seriously. You don't need to use this symbol in your code. It's just semantic sugar for the number 1. You can use 1 or GL_TRUE or whatever you want.

GLFW_FALSE = 0;

Zero.

Zero. Seriously. You don't need to use this symbol in your code. It's just just semantic sugar for the number 0. You can use 0 or GL_FALSE or whatever you want.

GLFW_RELEASE = 0;

The key or mouse button was released.

GLFW_PRESS = 1;

The key or mouse button was pressed.

GLFW_REPEAT = 2;

The key was held down until it repeated.

GLFW_KEY_UNKNOWN = -1;

The unknown key

GLFW_KEY_SPACE = 32;

Printable keys

GLFW_KEY_APOSTROPHE = 39;

GLFW_KEY_COMMA = 44;

GLFW_KEY_MINUS = 45;

GLFW_KEY_PERIOD = 46;

GLFW_KEY_SLASH = 47;

GLFW_KEY_0 = 48;

GLFW_KEY_1 = 49;

GLFW_KEY_2 = 50;

GLFW_KEY_3 = 51;

GLFW_KEY_4 = 52;

GLFW_KEY_5 = 53;

GLFW_KEY_6 = 54;

GLFW_KEY_7 = 55;

GLFW_KEY_8 = 56;

GLFW_KEY_9 = 57;

GLFW_KEY_SEMICOLON = 59;

GLFW_KEY_EQUAL = 61;

GLFW_KEY_A = 65;

GLFW_KEY_B = 66;

GLFW_KEY_C = 67;

GLFW_KEY_D = 68;

GLFW_KEY_E = 69;

GLFW_KEY_F = 70;

GLFW_KEY_G = 71;

GLFW_KEY_H = 72;

GLFW_KEY_I = 73;

GLFW_KEY_J = 74;

GLFW_KEY_K = 75;

GLFW_KEY_L = 76;

GLFW_KEY_M = 77;

GLFW_KEY_N = 78;

GLFW_KEY_O = 79;

GLFW_KEY_P = 80;

GLFW_KEY_Q = 81;

GLFW_KEY_R = 82;

GLFW_KEY_S = 83;

GLFW_KEY_T = 84;

GLFW_KEY_U = 85;

GLFW_KEY_V = 86;

GLFW_KEY_W = 87;

GLFW_KEY_X = 88;

GLFW_KEY_Y = 89;

GLFW_KEY_Z = 90;

GLFW_KEY_LEFT_BRACKET = 91;

GLFW_KEY_BACKSLASH = 92;

GLFW_KEY_RIGHT_BRACKET = 93;

GLFW_KEY_GRAVE_ACCENT = 96;

GLFW_KEY_WORLD_1 = 161;

GLFW_KEY_WORLD_2 = 162;

GLFW_KEY_ESCAPE = 256;

Function keys

GLFW_KEY_ENTER = 257;

GLFW_KEY_TAB = 258;

GLFW_KEY_BACKSPACE = 259;

GLFW_KEY_INSERT = 260;

GLFW_KEY_DELETE = 261;

GLFW_KEY_RIGHT = 262;

GLFW_KEY_LEFT = 263;

GLFW_KEY_DOWN = 264;

GLFW_KEY_UP = 265;

GLFW_KEY_PAGE_UP = 266;

GLFW_KEY_PAGE_DOWN = 267;

GLFW_KEY_HOME = 268;

GLFW_KEY_END = 269;

GLFW_KEY_CAPS_LOCK = 280;

GLFW_KEY_SCROLL_LOCK = 281;

GLFW_KEY_NUM_LOCK = 282;

GLFW_KEY_PRINT_SCREEN = 283;

GLFW_KEY_PAUSE = 284;

GLFW_KEY_F1 = 290;

GLFW_KEY_F2 = 291;

GLFW_KEY_F3 = 292;

GLFW_KEY_F4 = 293;

GLFW_KEY_F5 = 294;

GLFW_KEY_F6 = 295;

GLFW_KEY_F7 = 296;

GLFW_KEY_F8 = 297;

GLFW_KEY_F9 = 298;

GLFW_KEY_F10 = 299;

GLFW_KEY_F11 = 300;

GLFW_KEY_F12 = 301;

GLFW_KEY_F13 = 302;

GLFW_KEY_F14 = 303;

GLFW_KEY_F15 = 304;

GLFW_KEY_F16 = 305;

GLFW_KEY_F17 = 306;

GLFW_KEY_F18 = 307;

GLFW_KEY_F19 = 308;

GLFW_KEY_F20 = 309;

GLFW_KEY_F21 = 310;

GLFW_KEY_F22 = 311;

GLFW_KEY_F23 = 312;

GLFW_KEY_F24 = 313;

GLFW_KEY_F25 = 314;

GLFW_KEY_KP_0 = 320;

GLFW_KEY_KP_1 = 321;

GLFW_KEY_KP_2 = 322;

GLFW_KEY_KP_3 = 323;

GLFW_KEY_KP_4 = 324;

GLFW_KEY_KP_5 = 325;

GLFW_KEY_KP_6 = 326;

GLFW_KEY_KP_7 = 327;

GLFW_KEY_KP_8 = 328;

GLFW_KEY_KP_9 = 329;

GLFW_KEY_KP_DECIMAL = 330;

GLFW_KEY_KP_DIVIDE = 331;

GLFW_KEY_KP_MULTIPLY = 332;

GLFW_KEY_KP_SUBTRACT = 333;

GLFW_KEY_KP_ADD = 334;

GLFW_KEY_KP_ENTER = 335;

GLFW_KEY_KP_EQUAL = 336;

GLFW_KEY_LEFT_SHIFT = 340;

GLFW_KEY_LEFT_CONTROL = 341;

GLFW_KEY_LEFT_ALT = 342;

GLFW_KEY_LEFT_SUPER = 343;

GLFW_KEY_RIGHT_SHIFT = 344;

GLFW_KEY_RIGHT_CONTROL = 345;

GLFW_KEY_RIGHT_ALT = 346;

GLFW_KEY_RIGHT_SUPER = 347;

GLFW_KEY_MENU = 348;

GLFW_KEY_LAST = GLFW_KEY_MENU;

GLFW_MOD_SHIFT = $0001;

If this bit is set one or more Shift keys were held down.

GLFW_MOD_CONTROL = $0002;

If this bit is set one or more Control keys were held down.

GLFW_MOD_ALT = $0004;

If this bit is set one or more Alt keys were held down.

GLFW_MOD_SUPER = $0008;

If this bit is set one or more Super keys were held down.

GLFW_MOUSE_BUTTON_1 = 0;

Mouse buttons

GLFW_MOUSE_BUTTON_2 = 1;

GLFW_MOUSE_BUTTON_3 = 2;

GLFW_MOUSE_BUTTON_4 = 3;

GLFW_MOUSE_BUTTON_5 = 4;

GLFW_MOUSE_BUTTON_6 = 5;

GLFW_MOUSE_BUTTON_7 = 6;

GLFW_MOUSE_BUTTON_8 = 7;

GLFW_MOUSE_BUTTON_LAST = GLFW_MOUSE_BUTTON_8;

GLFW_MOUSE_BUTTON_LEFT = GLFW_MOUSE_BUTTON_1;

GLFW_MOUSE_BUTTON_RIGHT = GLFW_MOUSE_BUTTON_2;

GLFW_MOUSE_BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_3;

GLFW_JOYSTICK_1 = 0;

Joysticks

GLFW_JOYSTICK_2 = 1;

GLFW_JOYSTICK_3 = 2;

GLFW_JOYSTICK_4 = 3;

GLFW_JOYSTICK_5 = 4;

GLFW_JOYSTICK_6 = 5;

GLFW_JOYSTICK_7 = 6;

GLFW_JOYSTICK_8 = 7;

GLFW_JOYSTICK_9 = 8;

GLFW_JOYSTICK_10 = 9;

GLFW_JOYSTICK_11 = 10;

GLFW_JOYSTICK_12 = 11;

GLFW_JOYSTICK_13 = 12;

GLFW_JOYSTICK_14 = 13;

GLFW_JOYSTICK_15 = 14;

GLFW_JOYSTICK_16 = 15;

GLFW_JOYSTICK_LAST = GLFW_JOYSTICK_16;

GLFW_NOT_INITIALIZED = $00010001;

GLFW has not been initialized.

This occurs if a GLFW function was called that must not be called unless the library is initialized.

Application programmer error. Initialize GLFW before calling any function that requires initialization.

GLFW_NO_CURRENT_CONTEXT = $00010002;

No context is current for this thread.

This occurs if a GLFW function was called that needs and operates on the current OpenGL or OpenGL ES context but no context is current on the calling thread. One such function is glfwSwapInterval.

Application programmer error. Ensure a context is current before calling functions that require a current context.

GLFW_INVALID_ENUM = $00010003;

One of the arguments to the function was an invalid enum value.

One of the arguments to the function was an invalid enum value, for example requesting GLFW_RED_BITS with glfwGetWindowAttrib.

Application programmer error. Fix the offending call.

GLFW_INVALID_VALUE = $00010004;

One of the arguments to the function was an invalid value.

One of the arguments to the function was an invalid value, for example requesting a non-existent OpenGL or OpenGL ES version like 2.7.

Requesting a valid but unavailable OpenGL or OpenGL ES version will instead result in a GLFW_VERSION_UNAVAILABLE error.

Application programmer error. Fix the offending call.

GLFW_OUT_OF_MEMORY = $00010005;

A memory allocation failed.

A bug in GLFW or the underlying operating system. Report the bug to our issue tracker (https://github.com/glfw/glfw/issues).

GLFW_API_UNAVAILABLE = $00010006;

GLFW could not find support for the requested API on the system.

The installed graphics driver does not support the requested API, or does not support it via the chosen context creation backend. Below are a few examples.

Some pre-installed Windows graphics drivers do not support OpenGL. AMD only supports OpenGL ES via EGL, while Nvidia and Intel only support it via a WGL or GLX extension. OS X does not provide OpenGL ES at all. The Mesa EGL, OpenGL and OpenGL ES libraries do not interface with the Nvidia binary driver. Older graphics drivers do not support Vulkan.

GLFW_VERSION_UNAVAILABLE = $00010007;

The requested OpenGL or OpenGL ES version is not available.

The requested OpenGL or OpenGL ES version (including any requested context or framebuffer hints) is not available on this machine.

The machine does not support your requirements. If your application is sufficiently flexible, downgrade your requirements and try again. Otherwise, inform the user that their machine does not match your requirements.

Future invalid OpenGL and OpenGL ES versions, for example OpenGL 4.8 if 5.0 comes out before the 4.x series gets that far, also fail with this error and not GLFW_INVALID_VALUE, because GLFW cannot know what future versions will exist.

GLFW_PLATFORM_ERROR = $00010008;

A platform-specific error occurred that does not match any of the more specific categories.

A bug or configuration error in GLFW, the underlying operating system or its drivers, or a lack of required resources. Report the issue to our issue tracker (https://github.com/glfw/glfw/issues).

GLFW_FORMAT_UNAVAILABLE = $00010009;

The requested format is not supported or available.

If emitted during window creation, the requested pixel format is not supported.

If emitted when querying the clipboard, the contents of the clipboard could not be converted to the requested format.

If emitted during window creation, one or more hard constraints did not match any of the available pixel formats. If your application is sufficiently flexible, downgrade your requirements and try again. Otherwise, inform the user that their machine does not match your requirements.

If emitted when querying the clipboard, ignore the error or report it to the user, as appropriate.

GLFW_NO_WINDOW_CONTEXT = $0001000A;

The specified window does not have an OpenGL or OpenGL ES context.

A window that does not have an OpenGL or OpenGL ES context was passed to a function that requires it to have one.

Application programmer error. Fix the offending call.

GLFW_FOCUSED = $00020001;

GLFW_ICONIFIED = $00020002;

GLFW_RESIZABLE = $00020003;

GLFW_VISIBLE = $00020004;

GLFW_DECORATED = $00020005;

GLFW_AUTO_ICONIFY = $00020006;

GLFW_FLOATING = $00020007;

GLFW_MAXIMIZED = $00020008;

GLFW_RED_BITS = $00021001;

GLFW_GREEN_BITS = $00021002;

GLFW_BLUE_BITS = $00021003;

GLFW_ALPHA_BITS = $00021004;

GLFW_DEPTH_BITS = $00021005;

GLFW_STENCIL_BITS = $00021006;

GLFW_ACCUM_RED_BITS = $00021007;

GLFW_ACCUM_GREEN_BITS = $00021008;

GLFW_ACCUM_BLUE_BITS = $00021009;

GLFW_ACCUM_ALPHA_BITS = $0002100A;

GLFW_AUX_BUFFERS = $0002100B;

GLFW_STEREO = $0002100C;

GLFW_SAMPLES = $0002100D;

GLFW_SRGB_CAPABLE = $0002100E;

GLFW_REFRESH_RATE = $0002100F;

GLFW_DOUBLEBUFFER = $00021010;

GLFW_CLIENT_API = $00022001;

GLFW_CONTEXT_VERSION_MAJOR = $00022002;

GLFW_CONTEXT_VERSION_MINOR = $00022003;

GLFW_CONTEXT_REVISION = $00022004;

GLFW_CONTEXT_ROBUSTNESS = $00022005;

GLFW_OPENGL_FORWARD_COMPAT = $00022006;

GLFW_OPENGL_DEBUG_CONTEXT = $00022007;

GLFW_OPENGL_PROFILE = $00022008;

GLFW_CONTEXT_RELEASE_BEHAVIOR = $00022009;

GLFW_CONTEXT_NO_ERROR = $0002200A;

GLFW_CONTEXT_CREATION_API = $0002200B;

GLFW_NO_API = 0;

GLFW_OPENGL_API = $00030001;

GLFW_OPENGL_ES_API = $00030002;

GLFW_NO_ROBUSTNESS = 0;

GLFW_NO_RESET_NOTIFICATION = $00031001;

GLFW_LOSE_CONTEXT_ON_RESET = $00031002;

GLFW_OPENGL_ANY_PROFILE = 0;

GLFW_OPENGL_CORE_PROFILE = $00032001;

GLFW_OPENGL_COMPAT_PROFILE = $00032002;

GLFW_CURSOR = $00033001;

GLFW_STICKY_KEYS = $00033002;

GLFW_STICKY_MOUSE_BUTTONS = $00033003;

GLFW_CURSOR_NORMAL = $00034001;

GLFW_CURSOR_HIDDEN = $00034002;

GLFW_CURSOR_DISABLED = $00034003;

GLFW_ANY_RELEASE_BEHAVIOR = 0;

GLFW_RELEASE_BEHAVIOR_FLUSH = $00035001;

GLFW_RELEASE_BEHAVIOR_NONE = $00035002;

GLFW_NATIVE_CONTEXT_API = $00036001;

GLFW_EGL_CONTEXT_API = $00036002;

GLFW_ARROW_CURSOR = $00036001;

The regular arrow cursor shape.

GLFW_IBEAM_CURSOR = $00036002;

The text input I-beam cursor shape.

GLFW_CROSSHAIR_CURSOR = $00036003;

The crosshair shape.

GLFW_HAND_CURSOR = $00036004;

The hand shape.

GLFW_HRESIZE_CURSOR = $00036005;

The horizontal resize arrow shape.

GLFW_VRESIZE_CURSOR = $00036006;

The vertical resize arrow shape.

GLFW_CONNECTED = $00040001;

GLFW_DISCONNECTED = $00040002;

GLFW_DONT_CARE = -1;

Generated by PasDocEx, based on PasDoc 0.14.0.

DephiGlfw

Unit Neslib.Glfw3

Description

Overview

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Description

Functions and Procedures

Returns

See also

See also

Parameters

See also

Returns

See also

Parameters

Returns

Parameters

Returns

See also

Returns

See also

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

See also

Parameters

Returns

See also

Parameters

Parameters

Returns

Parameters

See also

Parameters

See also

Parameters

Returns

See also

Parameters

See also

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

See also

Parameters

Parameters