GLFW (u.7547f2c8e15a901686c29d24aa5bc0db.glfw-ocaml.3.3.1-2.doc.glfw-ocaml.GLFW)

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 A : sig ... end

Window hints and attributes. Use with windowHint, getWindowAttrib and setWindowAttrib like this:

include module type of A

Sourcetype ('a, _) window_attr =

| Focused : (bool, [< `hint | `attr ]) window_attr
| Iconified : (bool, [< `attr ]) window_attr
| Resizable : (bool, [< `hint | `attr | `update ]) window_attr
| Visible : (bool, [< `hint | `attr ]) window_attr
| Decorated : (bool, [< `hint | `attr | `update ]) window_attr
| AutoIconify : (bool, [< `hint | `attr | `update ]) window_attr
| Floating : (bool, [< `hint | `attr | `update ]) window_attr
| Maximized : (bool, [< `hint | `attr ]) window_attr
| CenterCursor : (bool, [< `hint ]) window_attr
| TransparentFramebuffer : (bool, [< `hint | `attr ]) window_attr
| Hovered : (bool, [< `attr ]) window_attr
| FocusOnShow : (bool, [< `hint | `attr | `update ]) window_attr
| RedBits : (int option, [< `hint ]) window_attr
| GreenBits : (int option, [< `hint ]) window_attr
| BlueBits : (int option, [< `hint ]) window_attr
| AlphaBits : (int option, [< `hint ]) window_attr
| DepthBits : (int option, [< `hint ]) window_attr
| StencilBits : (int option, [< `hint ]) window_attr
| AccumRedBits : (int option, [< `hint ]) window_attr
| AccumGreenBits : (int option, [< `hint ]) window_attr
| AccumBlueBits : (int option, [< `hint ]) window_attr
| AccumAlphaBits : (int option, [< `hint ]) window_attr
| AuxBuffers : (int option, [< `hint ]) window_attr
| Stereo : (bool, [< `hint ]) window_attr
| Samples : (int option, [< `hint ]) window_attr
| SrgbCapable : (bool, [< `hint ]) window_attr
| RefreshRate : (int option, [< `hint ]) window_attr
| DoubleBuffer : (bool, [< `hint ]) window_attr
| ClientApi : (client_api, [< `hint | `attr ]) window_attr
| ContextVersionMajor : (int, [< `hint | `attr ]) window_attr
| ContextVersionMinor : (int, [< `hint | `attr ]) window_attr
| ContextRevision : (int, [< `attr ]) window_attr
| ContextRobustness : (context_robustness, [< `hint | `attr ]) window_attr
| OpenGLForwardCompat : (bool, [< `hint | `attr ]) window_attr
| OpenGLDebugContext : (bool, [< `hint | `attr ]) window_attr
| OpenGLProfile : (opengl_profile, [< `hint | `attr ]) window_attr
| ContextReleaseBehavior : (context_release_behavior, [< `hint ]) window_attr
| ContextNoError : (bool, [< `hint ]) window_attr
| ContextCreationApi : (context_creation_api, [< `hint | `attr ]) window_attr
| ScaleToMonitor : (bool, [< `hint ]) window_attr
| CocoaRetinaFramebuffer : (bool, [< `hint ]) window_attr
| CocoaFrameName : (string, [< `hint ]) window_attr
| CocoaGraphicsSwitching : (bool, [< `hint ]) window_attr
| X11ClassName : (string, [< `hint ]) window_attr
| X11InstanceName : (string, [< `hint ]) window_attr

Sourcemodule type S = sig ... end

Deprecated window hints and attributes modules.

Sourcemodule WindowHint : S with type 'a t = ('a, [ `hint ]) window_attr

Sourcemodule WindowAttribute : S with type 'a t = ('a, [ `attr ]) window_attr

Source

module WindowUpdateableAttribute : 
  S with type 'a t = ('a, [ `update ]) window_attr

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. 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

Source

val setMonitorCallback : 
  f:(monitor -> connection_event -> unit) option ->
  (monitor -> connection_event -> unit) option

Sourceval getVideoModes : monitor:monitor -> video_mode list

Sourceval getVideoMode : monitor:monitor -> video_mode

Sourceval setGamma : monitor:monitor -> gamma:float -> unit

Sourceval getGammaRamp : monitor:monitor -> GammaRamp.t

Sourceval setGammaRamp : monitor:monitor -> gamma_ramp:GammaRamp.t -> unit

Sourceval defaultWindowHints : unit -> unit

Sourceval windowHint : hint:('a, [ `hint ]) window_attr -> value:'a -> unit

Source

val createWindow : 
  width:int ->
  height:int ->
  title:string ->
  ?monitor:monitor ->
  ?share:window ->
  unit ->
  window

Sourceval destroyWindow : window:window -> unit

Sourceval windowShouldClose : window:window -> bool

Sourceval setWindowShouldClose : window:window -> b:bool -> unit

Sourceval setWindowTitle : window:window -> title:string -> unit

Sourceval setWindowIcon : window:window -> images:Image.t list -> unit

Sourceval getWindowPos : window:window -> int * int

Sourceval setWindowPos : window:window -> xpos:int -> ypos:int -> unit

Sourceval getWindowSize : window:window -> int * int

Source

val setWindowSizeLimits : 
  window:window ->
  minWidth:int option ->
  minHeight:int option ->
  maxWidth:int option ->
  maxHeight:int option ->
  unit

Sourceval setWindowAspectRatio : window:window -> numer:int -> denom:int -> unit

Sourceval setWindowSize : window:window -> width:int -> height:int -> unit

Sourceval getFramebufferSize : window:window -> int * int

Sourceval getWindowFrameSize : window:window -> int * int * int * int

Sourceval getWindowContentScale : window:window -> float * float

Sourceval getWindowOpacity : window:window -> float

Sourceval setWindowOpacity : window:window -> opacity:float -> unit

Sourceval iconifyWindow : window:window -> unit

Sourceval restoreWindow : window:window -> unit

Sourceval maximizeWindow : window:window -> unit

Sourceval showWindow : window:window -> unit

Sourceval hideWindow : window:window -> unit

Sourceval focusWindow : window:window -> unit

Sourceval requestWindowAttention : window:window -> unit

Sourceval getWindowMonitor : window:window -> monitor option

Source

val setWindowMonitor : 
  window:window ->
  monitor:monitor option ->
  xpos:int ->
  ypos:int ->
  width:int ->
  height:int ->
  refreshRate:int option ->
  unit

Source

val getWindowAttrib : 
  window:window ->
  attribute:('a, [ `attr ]) window_attr ->
  'a

Source

val setWindowAttrib : 
  window:window ->
  attribute:('a, [ `update ]) window_attr ->
  value:'a ->
  unit

Source

val setWindowPosCallback : 
  window:window ->
  f:(window -> int -> int -> unit) option ->
  (window -> int -> int -> unit) option

Source

val setWindowSizeCallback : 
  window:window ->
  f:(window -> int -> int -> unit) option ->
  (window -> int -> int -> unit) option

Source

val setWindowCloseCallback : 
  window:window ->
  f:(window -> unit) option ->
  (window -> unit) option

Source

val setWindowRefreshCallback : 
  window:window ->
  f:(window -> unit) option ->
  (window -> unit) option

Source

val setWindowFocusCallback : 
  window:window ->
  f:(window -> bool -> unit) option ->
  (window -> bool -> unit) option

Source

val setWindowIconifyCallback : 
  window:window ->
  f:(window -> bool -> unit) option ->
  (window -> bool -> unit) option

Source

val setWindowMaximizeCallback : 
  window:window ->
  f:(window -> bool -> unit) option ->
  (window -> bool -> unit) option

Source

val setFramebufferSizeCallback : 
  window:window ->
  f:(window -> int -> int -> unit) option ->
  (window -> int -> int -> unit) option

Source

val setWindowContentScaleCallback : 
  window:window ->
  f:(window -> float -> float -> unit) option ->
  (window -> float -> float -> unit) option

Sourceval pollEvents : unit -> unit

Sourceval waitEvents : unit -> unit

Sourceval waitEventsTimeout : timeout:float -> unit

Sourceval postEmptyEvent : unit -> unit

Sourceval getInputMode : window:window -> mode:'a input_mode -> 'a

Sourceval setInputMode : window:window -> mode:'a input_mode -> value:'a -> unit

Sourceval rawMouseMotionSupported : unit -> bool

Sourceval getKeyName : key:key -> scancode:int -> string option

Sourceval getKeyScancode : key:key -> int

Sourceval getKey : window:window -> key:key -> bool

Sourceval getMouseButton : window:window -> button:int -> bool

Sourceval getCursorPos : window:window -> float * float

Sourceval setCursorPos : window:window -> xpos:float -> ypos:float -> unit

Sourceval createCursor : image:Image.t -> xhot:int -> yhot:int -> cursor

Sourceval createStandardCursor : shape:cursor_shape -> cursor

Sourceval destroyCursor : cursor:cursor -> unit

Sourceval setCursor : window:window -> cursor:cursor -> unit

Source

val setKeyCallback : 
  window:window ->
  f:(window -> key -> int -> key_action -> key_mod list -> unit) option ->
  (window -> key -> int -> key_action -> key_mod list -> unit) option

Source

val setCharCallback : 
  window:window ->
  f:(window -> int -> unit) option ->
  (window -> int -> unit) option

Source

val setCharModsCallback : 
  window:window ->
  f:(window -> int -> key_mod list -> unit) option ->
  (window -> int -> key_mod list -> unit) option

deprecated

Source

val setMouseButtonCallback : 
  window:window ->
  f:(window -> int -> bool -> key_mod list -> unit) option ->
  (window -> int -> bool -> key_mod list -> unit) option

Source

val setCursorPosCallback : 
  window:window ->
  f:(window -> float -> float -> unit) option ->
  (window -> float -> float -> unit) option

Source

val setCursorEnterCallback : 
  window:window ->
  f:(window -> bool -> unit) option ->
  (window -> bool -> unit) option

Source

val setScrollCallback : 
  window:window ->
  f:(window -> float -> float -> unit) option ->
  (window -> float -> float -> unit) option

Source

val setDropCallback : 
  window:window ->
  f:(window -> string list -> unit) option ->
  (window -> string list -> unit) option

Sourceval joystickPresent : joy:int -> bool

Sourceval getJoystickAxes : joy:int -> float array

Sourceval getJoystickButtons : joy:int -> bool array

Sourceval getJoystickHats : joy:int -> hat_status list array

Sourceval getJoystickName : joy:int -> string option

Sourceval getJoystickGUID : joy:int -> string option

Sourceval joystickIsGamepad : joy:int -> bool

Source

val setJoystickCallback : 
  f:(int -> connection_event -> unit) option ->
  (int -> connection_event -> unit) option

Sourceval updateGamepadMappings : string:string -> unit

Sourceval getGamepadName : joy:int -> string option

Sourceval getGamepadState : joy:int -> gamepad_state

Sourceval setClipboardString : window:_ -> string:string -> unit

Sourceval getClipboardString : window:_ -> string

Sourceval getTime : unit -> float

Sourceval setTime : time:float -> unit

Sourceval getTimerValue : unit -> int64

Sourceval getTimerFrequency : unit -> int64

Sourceval makeContextCurrent : window:window option -> unit

Sourceval getCurrentContext : unit -> window option

Sourceval swapBuffers : window:window -> unit

Sourceval swapInterval : interval:int -> unit

Sourceval extensionSupported : extension:string -> bool