Module `GLFW`Source

OCaml binding for GLFW 3.3.0

Sourceval version_major : int

GLFW-OCaml version numbers.

Sourceval version_minor : int

Sourceval version_revision : int

Sourceexception NotInitialized of string

Exceptions raised by the various functions of this module.

see http://www.glfw.org/docs/latest/group__errors.html

If you ever get an InvalidEnum exception and are not using unsafe features that would be a bug in GLFW-OCaml. Please fill an issue on GitHub.

Sourceexception NoCurrentContext of string

Sourceexception InvalidEnum of string

Sourceexception InvalidValue of string

Sourceexception OutOfMemory of string

Sourceexception ApiUnavailable of string

Sourceexception VersionUnavailable of string

Sourceexception PlatformError of string

Sourceexception FormatUnavailable of string

Sourceexception NoWindowContext of string

Sourcetype key_action =

| Release
| Press
| Repeat

Key actions.

see http://www.glfw.org/docs/latest/group__input.html

Sourcetype key =

| Unknown
| Space
| Apostrophe
| Comma
| Minus
| Period
| Slash
| Num0
| Num1
| Num2
| Num3
| Num4
| Num5
| Num6
| Num7
| Num8
| Num9
| Semicolon
| Equal
| A
| B
| C
| D
| E
| F
| G
| H
| I
| J
| K
| L
| M
| N
| O
| P
| Q
| R
| S
| T
| U
| V
| W
| X
| Y
| Z
| LeftBracket
| Backslash
| RightBracket
| GraveAccent
| World1
| World2
| Escape
| Enter
| Tab
| Backspace
| Insert
| Delete
| Right
| Left
| Down
| Up
| PageUp
| PageDown
| Home
| End
| CapsLock
| ScrollLock
| NumLock
| PrintScreen
| Pause
| F1
| F2
| F3
| F4
| F5
| F6
| F7
| F8
| F9
| F10
| F11
| F12
| F13
| F14
| F15
| F16
| F17
| F18
| F19
| F20
| F21
| F22
| F23
| F24
| F25
| Kp0
| Kp1
| Kp2
| Kp3
| Kp4
| Kp5
| Kp6
| Kp7
| Kp8
| Kp9
| KpDecimal
| KpDivide
| KpMultiply
| KpSubtract
| KpAdd
| KpEnter
| KpEqual
| LeftShift
| LeftControl
| LeftAlt
| LeftSuper
| RightShift
| RightControl
| RightAlt
| RightSuper
| Menu

Keyboard keys.

see http://www.glfw.org/docs/latest/group__keys.html

Sourcetype key_mod =

| Shift
| Control
| Alt
| Super

Keyboard key and mouse button modifiers.

see http://www.glfw.org/docs/latest/group__mods.html

Sourceval mouse_button_max_count : int

Maximum number of buttons handled for a mouse.

Sourceval mouse_button_left : int

Values of common mouse buttons.

Sourceval mouse_button_right : int

Sourceval mouse_button_middle : int

Sourceval joystick_max_count : int

Maximum number of joysticks connected.

Sourcetype client_api =

| NoApi
| OpenGLApi
| OpenGLESApi

Client OpenGL API hint

Sourcetype context_robustness =

| NoRobustness
| NoResetNotification
| LoseContextOnReset

Context robustness hint

Sourcetype opengl_profile =

| AnyProfile
| CoreProfile
| CompatProfile

OpenGL profile hint

Sourcetype context_release_behavior =

| AnyReleaseBehavior
| ReleaseBehaviorFlush
| ReleaseBehaviorNone

Context release behavior hint

Sourcetype context_creation_api =

| NativeContextApi
| EGLContextApi
| OSMesaContextApi

Context creation API hint

Sourcemodule WindowHint : sig ... end

Window hints. Use with windowHint like this:

Sourcemodule WindowAttribute : sig ... end

Windows attributes. Use with getWindowAttrib in a similar manner as with window hints.

Sourcemodule WindowUpdateableAttribute : sig ... end

Window updateable attributes. Use with setWindowAttrib in a similar manner as with window hints.

Sourcetype cursor_mode =

| Normal
| Hidden
| Disabled

Mouse cursor input mode.

Sourcetype _ input_mode =

| Cursor : cursor_mode input_mode
| StickyKeys : bool input_mode
| StickyMouseButtons : bool input_mode
| LockKeyMods : bool input_mode
| RawMouseMotion : bool input_mode

Input modes. Use with setInputMode and getInputMode in a similar manner as with window hints.

see http://www.glfw.org/docs/latest/group__input.html#gaa92336e173da9c8834558b54ee80563b

Sourcetype cursor_shape =

| ArrowCursor
| IBeamCursor
| CrosshairCursor
| HandCursor
| HResizeCursor
| VResizeCursor

Standard cursor shapes.

Sourcetype connection_event =

| Connected
| Disconnected

Joystick connection event.

Sourcetype _ init_hint =

| JoystickHatButtons : bool init_hint
| CocoaChdirResources : bool init_hint
| CocoaMenubar : bool init_hint

Initialization hints.

see http://www.glfw.org/docs/latest/intro_guide.html#init_hints

Sourcetype video_mode = {

width : int;
height : int;
red_bits : int;
green_bits : int;
blue_bits : int;
refresh_rate : int;

}

Video mode description as returned by getVideoMode(s).

see http://www.glfw.org/docs/latest/structGLFWvidmode.html

Sourcetype monitor

Sourcetype window

Sourcetype cursor

Sourcemodule GammaRamp : sig ... end

GammaRamp module. Describes the gamma ramp for a monitor.

Sourcemodule Image : sig ... end

Image data for creating custom cursors and window icons.

Sourcetype hat_status =

| HatUp
| HatRight
| HatDown
| HatLeft

Hat statuses as returned by getJoystickHats.

see http://www.glfw.org/docs/latest/group__input.html#ga2d8d0634bb81c180899aeb07477a67ea

Sourcetype gamepad_state = {

buttons : bool array;
axes : float array;

}

Gamepad state data as returned by getGamepadState.

see http://www.glfw.org/docs/latest/structGLFWgamepadstate.html

Module functions. These are mostly identical to their original GLFW counterparts.

There are no bindings for the glfwSet,Get*UserPointer functions because you would have to use unsafe features to set the correct type for your data. If you need to make user data accessible inside a callback you can instead capture it in a closure and use that closure as your callback function.

There is no binding for the glfwWindowHintString function. Simply pass your string to the windowHint function as you would for any other value type.

The window parameter of the set,getClipboardString functions has been deprecated and is no longer used. You may pass the unit value (or anything) as the window argument.

There is no binding for the glfwGetProcAddress function because it would basicaly require to write an entire OpenGL wrapper to make the functions returned by GLFW usable from OCaml. Incidentaly the glfwExtensionSupported function is not provided either. There are numerous OpenGL bindings available for OCaml that you can use instead.

The Vulkan related functions are not supported as of now but we might look into it at some point.

see http://www.glfw.org/docs/latest/glfw3_8h.html#func-members

Sourceval init : unit -> unit

Sourceval terminate : unit -> unit

Sourceval initHint : hint:'a init_hint -> value:'a -> unit

Sourceval getVersion : unit -> int * int * int

Sourceval getVersionString : unit -> string

Sourceval getMonitors : unit -> monitor list

Sourceval getPrimaryMonitor : unit -> monitor

Sourceval getMonitorPos : monitor:monitor -> int * int

Sourceval getMonitorWorkarea : monitor:monitor -> int * int * int * int

Sourceval getMonitorPhysicalSize : monitor:monitor -> int * int

Sourceval getMonitorContentScale : monitor:monitor -> float * float

Sourceval getMonitorName : monitor:monitor -> string

package glfw-ocaml

Install

Dune Dependency

Authors

Maintainers

Sources

doc/glfw-ocaml/GLFW/index.html

Module GLFWSource

Module `GLFW`Source