package glfw-ocaml
-
glfw-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package glfw-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Deprecated window hints and attributes modules.
These modules used to wrap separate types that had some identical constructor names, allowing type safety for the window hints and attributes functions. Compared to the current implementation using GADTs and polymorphic variant types, it had two major disadvantages:
* It required adding module name prefixes when using the constructors; * Constructors related to a same feature would be duplicated across some totally incompatible types.
These modules are provided for API backward-compatibility and will be removed in the future (probably on the next major version). Most probably, updating your code is very straightforward and you simply need to remove the module name prefixes when using those constructors.
include module type of A with type ('a, 'k) window_attr = ('a, 'k) window_attr
Window hints and attributes. Use with windowHint, getWindowAttrib and setWindowAttrib like this:
windowHint ~hint:Resizable ~value:false windowHint ~hint:OpenGLProfile ~value:CoreProfile windowHint ~hint:RefreshRate ~value:(Some 60) windowHint ~hint:DepthBits ~value:None windowHint ~hint:X11ClassName ~value:"MyApplicationName"
getWindowAttrib ~attribute:Resizable : bool getWindowAttrib ~attribute:OpenGLProfile : opengl_profile getWindowAttrib ~attribute:Hovered : bool getWindowAttrib ~attribute:ContextRevision : int
setWindowAttrib ~attribute:Resizable ~value:true
This type is wrapped inside a module only for technical reasons related to backward-compatibility. That module is opened right after it is declared and it is intended that you use the constructor names unprefixed as shown in the previous examples. It will be removed together with the old modules in the future (probably on the next major version).
type ('a, 'k) window_attr = ('a, 'k) 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