# GLFW Readme File

| GLFW v2.6 BETA source distribution |

1. Introduction
2. Compiling GLFW and the example programs
3. Installing GLFW
4. Using GLFW
5. Version history
6. Directory structure of the GLFW distribution
7. Contacting the project
8. Acknowledgements

## 1. Introduction

Welcome to version 2.6 BETA of the GLFW OpenGL framework. GLFW is a free, open source, portable framework for OpenGL application development. In short, it is a library that constitutes a powerful API for handling operating system specific tasks, such as opening an OpenGL window, reading keyboard and mouse input, creating threads, and much more.

## 2. Compiling GLFW and the example programs

A top level makefile can be found in the root directory of the GLFW distribution that has been designed to work with several compilers. If you simply enter the GLFW root directory in a shell and type make (or nmake or gmake, depending on the name of your make tool), and a list should appear with the currently supported options for systems and compilers.

For example, one of the options is to compile GLFW for Windows with the LCC-Win32 C compiler. To do that, type make win32-lcc in the shell (as specified in the previously mentioned list). That will compile the GLFW static link library and the supplied example programs. For Windows compilers, a Win32 DLL will also be compiled.

Currently supported compilers and systems are:

1. Borland C++ Builder compiler 5.x for Windows
2. Cygwin (GCC) for Windows
3. LCC-Win32 for Windows
4. Microsoft Visual C++ 6.x for Windows
5. MinGW32 (GCC) for Windows
6. OpenWatcom for Windows
7. Pelles C for Windows
8. Unix or Unix-like systems running the X Window System (auto detect compiler, or force GCC)
9. Apple Developer Tools (GCC) for Mac OS X

If your compiler/system is not in the list, you will have to create new makefiles in the lib\win32, lib/x11 or lib/macosx directory, and in the examples directory. If you have any problems, do not hesitate to contact me (I may not know how your compiler works, but I know the GLFW source code). I would also like to add support for more compilers and verify that GLFW compiles under as many systems as possible, so if you had to make any modifications or additions to the source and/or makefiles in order to make GLFW compile successfully, I would like to know what you had to do.

### 2.1 Note for Microsoft Visual C++ users

When MSVC is installed, you are asked if it should be possible to access the compiler from the command line. For some strange reason, the default answer to this question is NO. If you answered no to this question you will have to run a file named VCVARS32.BAT, which is located in the bin directory of your Visual C++ folder, before you can use the compiler from the command line.

Note that VCVARS32.BAT must be run from the same shell as you intend to use for compiling GLFW (simply clicking on the file from the explorer will not work).

After that is done, it is possible to compile GLFW by entering the GLFW root directory and issuing nmake win32-msvc.

For instance, if MSVC is installed in the directory 'C:\Program Files\Microsoft Developer Studio\VC98', then you should be able to compile GLFW with this procedure:

1. Start a command prompt (MS-DOS prompt)
2. "CD" to the directory where you unzipped the GLFW source distribution (where this readme file is located)
3. Type "C:\Program Files\Microsoft Developer Studio\VC98\BIN\VCVARS32" (with quotation marks)
4. Type nmake win32-msvc

### 2.2 Note for MinGW/DevC++ users

Do not use the MSYS shell for compiling GLFW, because the supplied batch file "compile.bat" will only work under a Windows command prompt (or MS-DOS prompt).

Under Windows 98, the MinGW make program may set the $(MAKE) variable incorrectly. To remedy this, uncomment the line at the beginning of the top level Makefile that says MAKE = make (possibly replacing make with some other name, e.g. mingw32-make).

### 2.3 Note for Cygwin users

The Cygwin makefile was designed to run from a Cygwin bash shell. You can not use an MS-DOS prompt (or NT cmd prompt) to compile GLFW with the win32-cygwin option. Similarly, the win32-clean option will not work from a Cygwin shell, which is why there is a special cygwin-clean option.

### 2.4 Note for OpenWatcom users

In order to compile GLFW successfully with OpenWatcom (for Windows), execute "nmake MAKE=nmake win32-ow" in the GLFW root directory. Also make sure that you have all your environment variables set up correctly. It is the default option when installing OpenWatcom to permanently set up all the required environment variables. If nmake does not work, you probably have to run "WATCOM\setvars.bat" from the command prompt before executing nmake, where WATCOM is the directory in which you installed OpenWatcom (e.g. C:\Watcom).

### 2.5 Note for Pelles C users

To build GLFW with Pelles C, you need at lest version 2.80.3 of Pelles C (POCC and POLINK).

Type 'pomake win32-pellesc' to build GLFW.

### 2.6 Note for Unix/X11 users

Compiler and link library capabilities are auto-detected with a script called compile.sh. It has been tested under Linux Mandrake 10.1, Mac OS X 10.2, SunOS 5.6 (GCC), IRIX 5.3, FreeBSD 5.0 and QNX, but should hopefully run on the majority of available Unix/Unix-like systems and generate functional Makefiles. You do not have to run the script manually, since it is called from the top level Makefile.

### 2.8 Note for Mac OS X users

To compile GLFW for Mac OS X, you will need to have installed the BSD subsystem and the Developer Tools, which can be found on your Mac OS X CD:s. When they are installed, simply open Terminal and go to the root GLFW directory. From there, you can build the library and all the examples by running make, i.e. make macosx-gcc.

## 3. Installing GLFW

### 3.1 Windows

After compiling GLFW with MinGW or Cygwin, three files of interest should have appeared in the lib\win32 directory. They are: libglfw.a (the static link version of GLFW), glfw.dll (the DLL version of GLFW) and libglfwdll.a (the DLL import library).

To install GLFW on Cygwin (and possibly MinGW), run make with the cygwin-install target. This will generate the pkgconfig file and copy it, the header file and the library to the correct locations of your Cygwin installation. If you wish to change the installation location from its default, set the desired prefix path with the environment variable PREFIX.

If you used Borland C++ Builder, LCC-Win32, Microsoft Visual C++ or OpenWatcom, the files are named glfw.lib (the static link version of GLFW), glfw.dll (the DLL version of GLFW) and glfwdll.lib (the DLL import library).

The static link library and the DLL import library should be copied to your compiler's LIB directory (where all other link libraries are located). The DLL can be copied either to your Windows system directory (where opengl32.dll is located), or to the project directory of your GLFW-based projects (where you place your compiled EXEs).

You should also copy the GLFW include file, include\GL\glfw.h, to the GL directory of your compiler's include directory (where gl.h, glu.h etc. are located).

### 3.2 Unix

After compiling GLFW, three files named libglfw.pc.in, libglfw.a and libglfw.so should have appeared in the lib/x11 directory. This is the pkgconfig template file, the GLFW static link library and the GLFW shared library, respectively.

To install GLFW onto your system, run make as root with the x11-install build target. This will install the pkgconfig file, the static library and the header. By default, the files will be installed under /usr/local. If you wish to install to a different location, set the environment variable PREFIX appropriately when running make.

Note that the shared library is not installed by default, as you really should think twice before using it. GLFW is very small and shared library distribution on Unix outside of packaging systems is quite tricky. The GLFW license also allows static linking without requiring your to share your code.

### 3.4 Mac OS X

After compiling GLFW, three files named libglfw.pc.in, libglfw.a and libglfw.dylib should appear in the lib/macosx directory. This is the pkgconfig template file, the GLFW static link library and the GLFW dynamic library, respectively.

To install GLFW onto your system, run make with sudo and the macosx-install build target, i.e.:

sudo make macosx-install

This will install the pkgconfig file, the static library and the header. By default, the files will be installed under /usr/local. If you wish to install to a different location, set the environment variable PREFIX appropriately when running make.

Note that the shared library is not installed by default, as you really should think twice before using it. GLFW is very small and very sutable for static linking. The GLFW license also allows static linking without requiring your to share your code.

## 4. Using GLFW

There are two aspects to using GLFW:

1. How does the GLFW API work
2. How to compile programs that use GLFW

The first point is covered in the GLFW Users Guide and the GLFW Reference Manual, and I suggest that you read at least the Users Guide, since it is a good introduction to the GLFW API.

Designing and compiling programs that use GLFW is not very difficult. A few rules for successfully designing GLFW-based programs are presented in the following sections.

### 4.1 Include <GL/glfw.h>

In your program, you should include <GL/glfw.h>. This include file defines all the necessary constants, types and prototypes that are used to interact with the GLFW API. It also includes <GL/gl.h> and <GL/glu.h>, and - this is very important - it defines all the necessary constants and types that are necessary for OpenGL to work on different platforms.

For instance, under Windows you are normally required to include <windows.h> before you include <GL/gl.h>. If you write such a program, it would not compile under e.g. Linux since <windows.h> does not exist under Linux. <GL/glfw.h> takes care of these things for you. Note however that it does not actually include <windows.h>, it merely mimics the parts of it that are needed for <GL/gl.h> and <GL/glu.h> (this way we do not get the thousands of constants, types and prototypes that could otherwise possibly interfere with our own declarations).

In other words:

- Do not include <GL/gl.h> or <GL/glu.h>! (GLFW does it for you)
- Do not include <windows.h>! (unless you really need it)

Note: If you do need to include <windows.h>, do it before including <GL/glfw.h>.

### 4.2 Link with the right libraries

#### 4.2.1 Windows static library

If you link with the static version of GLFW, it is also necessary to link with some system libraries that GLFW uses.

When linking a program under Windows that uses the static version of GLFW, you must also link with the following libraries: opengl32, user32 and kernel32. Some of these libraries may be linked with by default by your compiler. In the table below you can see the minimum required link options for each supported Windows compiler (you may want to add other libraries as well, such as glu32):

Compiler | Link options
Borland C++ Builder | glfw.lib opengl32.lib
Cygwin | See Unix static library below
LCC-Win32 | glfw.lib opengl32.lib
Microsoft Visual C++ | glfw.lib opengl32.lib user32.lib
MinGW32 | -lglfw -lopengl32
OpenWatcom | glfw.lib opengl32.lib user32.lib
Pelles C | glfw.lib opengl32.lib user32.lib kernel32.lib

#### 4.2.2 Windows DLL

To compile a program that uses the DLL version of GLFW, you need to define the GLFW_DLL constant. This can either be done with a compiler switch, typically by adding -DGLFW_DLL to the list of compiler options. You can also do it by adding the line:

#define GLFW_DLL

...to all your source files that include glfw.h, before including it.

When linking a program under Windows that uses the DLL version of GLFW, the only library you need to link with for GLFW to work is glfwdll. In the table below you can see the minimum required link options for each supported Windows compiler (you may want to add other libraries as well, such as opengl32 and glu32):

Compiler | Link options
Borland C++ Builder | glfwdll.lib
Cygwin | -lglfwdll
LCC-Win32 | glfwdll.lib
Microsoft Visual C++ | glfwdll.lib
MinGW32 | -lglfwdll
OpenWatcom | glfwdll.lib
Pelles C | glfwdll.lib

#### 4.2.3 Unix static library

GLFW now supports pkgconfig, and a libglfw.pc file is generated and installed when you install the library. For systems that do not provide pkgconfig, you should look in this file for the proper compile and link flags for your system, as determined by compile.sh at compile time.

A typical compile and link command line may look like this (using GCC):

gcc `pkg-config --cflags libglfw` -o myprog myprog.c `pkg-config --libs libglfw`

If you use GLU functions in your program you should also add -lGLU.

#### 4.2.5 Mac OS X static library

When compiling and linking a program under Mac OS X that uses GLFW, you must also link with the following frameworks: Carbon.framework, AGL.framework and OpenGL.framework.

If you are using Xcode, you simply add the GLFW library libglfw.a and these frameworks to your project. If, however, you are building your program from the command line, there are two methods for correctly linking your GLFW program.

GLFW now supports pkgconfig, and a libglfw.pc file is generated and installed when you install the library. You can find pkgconfig in most packaging systems, such as Fink and DarwinPorts, so if you have one of them installed, simply install pkgconfig. Once you have pkgconfig available, the command line for compiling and linking your program is:

gcc `pkg-config --cflags libglfw` -o myprog myprog.c `pkg-config --libs libglfw`

If you do not wish to use pkgconfig, you will need to add the required frameworks and libraries to your command line using the -l and -framework switches, i.e.:

gcc -o myprog myprog.c -lglfw -framework Carbon -framework AGL -framework OpenGL

Note that you do not add the .framework extension to a framework when adding it from the command line.

These frameworks contain all GL and GLU functions, so there is no need to add additional libraries or frameworks when using GLU functionality. Also note that even though your machine may have Unix-style GL libraries, they are for use with the X Window System, and will not work with the Mac OS X native version of GLFW.

## 5. Version history

### v2.6

- Added `GLFW_FSAA_SAMPLES` multisampling hint (implemented on all platforms)
- Added `GLFW_WINDOW_NO_RESIZE` hint for non-resizable windows (implemented on all platforms)
- Added install targets for all Unix-like build targets
- Added `glfwReadMemoryImage` function for creating a `GLFWImage` object from an image file in a memory buffer
- Added `glfwLoadMemoryTexture2D` function for decoding an image file in a memory buffer into a texture
- Added `glfwLoadTextureImage2D` function for loading a `GLFWImage` object into a texture
- Added cross-compilation support for MinGW under a Unix-like host
- Updates to the D bindings and all examples ported to modern D
- Bugfix: The interaction between key repeat and window focus code caused duplicate presses
- [Win32] Added pkgconfig file generation for Cygwin
- [Win32] Added version number to WNDCLASS name
- [Win32] Bugfix: Very small sleep periods were forced to higher value
- [Win32] Bugfix: The nmake makefile did not handle paths with spaces correctly
- [Win32] Bugfix: Removed assembly RDTSC timing code
- [Win32] Bugfix: Hidden cursor was not clipped to windowed windows
- [X11] Added XRandR code path for fullscreen windows
- [X11] Added building of shared library
- [X11] Added ICCCM WM fullscreen hints
- [X11] Added support for the `_NET_WM_PING` protocol
- [X11] Added pkgconfig file generation
- [X11] Added setting of WM size hints
- [X11] Bugfix: Removed assembly RDTSC timing code
- [X11] Bugfix: Window re-opening now works properly (including fullscreen windows)
- [X11] Bugfix: Potential crash bug in video mode matching code
- [X11] Bugfix: Static buffers imposed an invisible limit on reported video mode count
- [MacOSX] Added pkgconfig file generation
- [MacOSX] Added building of shared library
- [MacOSX] Added building of Universal libraries
- [MacOSX] Replaced fullscreen code path with CGL version
- [MacOSX] Bugfix: Replaced Carbon event time source with `gettimeofday`
- [MacOSX] Bugfix: Added code to minimize the dreaded OpenGL application startup jump
- [MacOSX] Bugfix: Fixed broken implementation of `glfwSetMousePos` for windowed mode
- [MacOSX] Bugfix: Fixed broken implementation of hidden cursor
- [AmigaOS] Obsoleted platform due to lack of maintainer and community interest
- [DOS] Obsoleted platform due to lack of maintainer and community interest

### v2.5

- Added the function glfwWaitEvents
- Added window close callback, which enables a program to prevent a user from closing a window with the window manager
- Added window refresh callback, which is called when the window needs to be refreshed
- Added support for loading alpha textures (GLFW_ALPHA_MAP_BIT)
- Added support for the Lua programming language
- Added support for the D programming language
- Added support for the Pelles C compiler for Windows
- Added API level support for up to eight mouse buttons
- [Win32] Added support for up to five mouse buttons
- [Win32] Mouse down events capture mouse input
- [Win32] Bugfix: The DLL now exports glfwSetTime
- [Win32] Fix: The GLFW window is now placed in the upper left corner of the desktop working area
- [Win32/X11] Bugfix: More robust check for SwapInterval
- [X11] Added support for USB joysticks under Linux (/dev/input/js*)
- [X11] Bugfix: Added support for GLX extensions in glfwExtensionSupported
- [X11] Bugfix: More robust fullscreen mode (?)
- [X11] Bugfix: Runtime check of XF86VidMode support for the active display
- [X11] Bugfix: Some mouse button events were reported incorrectly
- [MacOSX] Added support for the input char callback.
- [MacOSX] Added video mode validation and duplicate elimination.
- [MacOSX] Switched to a new MakeBundle.sh script.
- [MacOSX] Added emulation of the window refresh callback.
- [MacOSX] Bugfix: The window and its associated resources are now properly released.
- [MacOSX] Bugfix: Removed support for more than eight mouse buttons.
- [x86 CPUs] Improved Intel mobile CPU detection (e.g. disables RDTSC timing on Centrino systems)

### v2.4.2

- Preliminary native Mac OS X support (via the Carbon interface)
- Preliminary DOS support (DJGPP + Mesa)
- Changed license to the zlib license (almost identical to the previous GLFW license), so now GLFW is OSI Certified
- Rewrote the GLFW documentation in LaTeX, meaning several improvements (both visual and practical)
- Added the support folder to the distribution, which includes support for various languages
- [Win32] Added OpenWatcom compiler support (thanks Sebastian Schuberth!)
- [Win32] Changed fallback timer from GetTickCount to timeGetTime, which usually provides better resolution
- [Win32] Bugfix: Accumulator buffer selection should be more robust
- [Win32] Bugfix: If stereo rendering is requested, and no stereo pixel format could be created, glfwOpenWindow now fails
- [Win32] Bugfix: glfwSetWindowSize now sets the size of the client area, NOT the entire window, meaning that there is a 1:1 relationship between glfwSetWindowSize and glfwGetWindowSize
- [X11] Added FreeBSD and QNX support
- [X11] Added support for non-pthread capable systems
- [X11] Hopefully more robust configuration script (compile.sh)
- [X11] Bugfix: When mouse cursor is hidden, mouse sensitivity is no longer degraded
- [X11] Bugfix: Source files EOL was PC style (CR/LF) in v2.4.1 (blame my WinCVS configuration)
- [X11] Bugfix: When a GLFW window is closed, input focus is properly released
- [X11] Bugfix: Iconification of fullscreen windows should now work properly
- [x86 CPUs] Improved RDTSC timing (e.g. RDTSC support on single-CPU Intel Hyper-Threading enabled systmes)
- [AmigaOS] Added joystick support
- [AmigaOS] Mouse cursor positioning is now implemented
- [AmigaOS] Added support for Geek Gadgets GCC
- [AmigaOS] Bugfix: glfwGetWindowParam now returns proper values for all parameters (except for GLFW_ACCELERATED)

### v2.4.1

- Added AmigaOS support (preliminary)
- GLFW for the X Window System now works under Mac OS X
- [Win32] Bugfix: glfwWaitCond treated the timeout as milliseconds instead of seconds
- [X11] Bugfix: GLFW should now compile under IRIX v5.3
- [X11] Bugfix: GLFW should now compile with Kylix

### v2.4

- Major source code rearrangement - much code is now shared between different platforms, and it should be easier to port GLFW to new platforms
- Added a Unicode keyboard text input interface (CharCallback)
- Keyboard key input is now slightly more internationalized: GLFW now uses 8-bit ISO-8859-1 encoding for keys representing printable characters (e.g. "Ö", "§", etc), as opposed to the previous 7-bit US-ASCII encoding
- Added more key constants (F13-F25, keypad '=')
- Added an enable/disable swicth for automatic event polling from glfwSwapBuffers
- [X11] Added support for sysctl for querying the number of processors in the system (if POSIX sysconf is not supported)
- [X11] Bugfix: compile.sh now works with Sun sh (and hopefully others too)
- [X11] Bugfix: compile.sh now detects the need for -ldl when dlopen is used
- [Win32] Bugfix: When closing a fullscreen window under Win 9x/NT4, the task bar icon now disappears properly
- [Win32] Bugfix: GLFW should now compile on a wider range of MSVC compilers (e.g. .NET) - Thanks Tim Little!

### v2.3.2

- Removed the silly limitation of 100 threads (the thread information is now kept in a linked list)
- General source cleanup (window state is now kept in a single struct, plus some other minor changes)
- [X11] Added Solaris gethrtime() support (not tested yet), which should give an improved timer for Sun/Solaris stations
- [X11] Some fixes to the 'compile.sh' script (-O for non-gcc compilers and 'make x11-gcc' should now really force GCC)

### v2.3.1

- [X11] A minimalist configuration script was added that solves the issue with glXGetProcAddressARB, and unifies all Unix/X11 Makefiles into one template Makefile (well, one for GLFW, and one for the examples)

### v2.3

- Added OpenGL stereo rendering support
- Added a function for parsing the OpenGL version string (glfwGetGLVersion)
- [x86] Bugfix: Hopefully the CPU core clock dependent timer RDTSC will never be used on CPUs with variable core frequencies anymore
- [X11] Bugfix: GLFW could create stereo rendering capable windows, even if it was not requested (GLFW v2.2.x did not support selection of stereo rendering)
- [X11] Bugfix: glfwGetProcAddress returned NULL on most systems (even on those that supported glXGetProcAddressARB). Now GLFW assumes that glXGetProcAddressARB is supported on all systems, which solves the bug, but may result in compiler errors on some systems (please let me know if you have any related problems).

### v2.2.3

- Bugfix: Checking for GL_SGIS_generate_mipmap is more robust
- Bugfix: glfwLoadTexture2D will now fail if no window is opened
- [Win32] Bugfix: Right shift was not detected under Win 9x/ME (it is still not as good as under NT/2K/XP, but at least you get right shifts)
- [X11] Bugfix: Visuals are now selected more accurately. For instance, glfwOpenWindow will no longer fail if you request a 24-bit color buffer if only 16-bit color visuals are avilable (which means that pong3d should work on 16-bit displays).

### v2.2.2

- [Win32] Bugfix: Windows did not always get focus (this was a tough one!)
- [Win32] Bugfix: glfwGetWindowParam did not work with GLFW_ACCUM_*_BITS or GLFW_AUX_BUFFERS
- [X11] Bugfix: Linux joystick Y axis positions were reversed

### v2.2.1

- [X11] Added joystick support for Linux

### v2.2

- Added joystick support (only supported under Windows so far)
- Added joystick controls to pong3d.c (only 3 more lines of code)
- Added glfwOpenWindowHint() function
- It is now possible to specify a desired vertical monitor refresh rate (for fullscreen windows)
- It is now possible to request an accumulator buffer and auxiliary buffers
- Added glfwSetTime() function
- Added a GLFW conversion of the MESA/GLUT gears.c demo to the example programs
- [Win32] gdi32.dll and winmm.dll are now loaded dynamically when glfwInit() is called. This means that there is no need to link with gdi32.lib or winmm.lib when using the static version of GLFW, which should make GLFW usage more convenient.
- [Win32] Bugfix: Greatly improved keyboard input (detect left/right CTRL etc)
- [Win32] Bugfix: glfwExtensionSupported now detects all WGL extensions (e.g. WGL_ARB_pbuffer)
- [Win32] Bugfix: Mouse cursor was not re-hidden when a GLFW window was deselected and then selected again (with ALT+TAB)
- [X11] Bugfix: Minor bug in the SGI timer - and ugly (unintended) SGI timer debug info removed
- [X11] Bugfix: glfwGetDesktopMode and glfwGetVideoModes no longer give segmentation faults if no X server is available

### v2.1

- Added image and texture loading capabilities (support for the TGA file format at the moment)
- Added a new example program (mipmaps.c) for showing off the automatic mipmap generation and texture loading capabilities of GLFW 2.1
- Removed the separate TGA loader (tga.c in the examples directory) since texture loading is supported natively by GLFW. Also updated the Pong3D demo to use GLFW texture loading instead of tga.c.
- Improved keyboard handling (e.g. numeric keypad keys can be detected)
- Added a new example program, keytest.c
- Changed the GLFWvidmode structure and the corresponding API functions to report pure color bits instead of the confusing (and unportable) "BPP" field
- Changed glfwSetWindowSize so that it operates in fullscreen mode too
- Added mouse wheel support under Windows (not Win95) and X11
- Added window iconification functions (glfwInconifyWindow and glfwRestoreWindow)
- Improved iconification and deactivation handling under both Windows and X11
- Made it possible to turn on/off key repeat (the default is now no key repeat)
- Added SGI hardware timer support (CLOCK_SGI_CYCLE) for improved timer resolution for SGI computers
- Added support for the free Borland C++ Builder 5.x compiler for Windows
- Made it possible to compiler GLFW as a Windows DLL using any of the supported compilers
- Some constants have changed names (e.g. GLFW_REDBITS is now called GLFW_RED_BITS)
- Updated GLFW documentation (GLFW Users Guide and GLFW Reference Manual) to reflect the changes in the API
- [Win32] Bugfix: Corrected Cygwin toplevel makefile entry
- [Win32] Bugfix: Fixed event lag bug
- [Win32] Bugfix: Fixed Radeon 8500 crash
- [X11] Bugfix: Fixed the window close bug
- [X11] Bugfix: Iconification/deactivation is now detected
- [X11] Bugfix: Non-OpenGL visuals are not listed anymore
- [XFree86] Bugfix: Undesired video mode changes are now prevented

### v2.0.3

- Added precise CPU cycle based timing support (RDTSC) for x86 CPUs (under both Windows and Unix)
- Added a makefile option for building for Windows with Cygwin
- Corrected the CC for Unix/X11 makefiles (-Wall is usually not a supported flag for CC, so it was removed from the CFLAGS list)

### v2.0.2

- Added a makefile option for building for X11 with 'cc' rather than 'gcc' (useful for IRIX users for instance).
- [Win32] Bugfix: Mouse coordinates are now relative to the window upper left corner, which also means that disabling the mouse cursor in windowed mode should work much better.
- [X11] Bugfix: Added a bunch of more keys that are recognized by GLFW.
- [X11] Bugfix: glfwGetNumberOfProcessors now works for IRIX (earlier versions of GLFW would not compile under IRIX).

### v2.0.1

- glfwTerminate() will now be called automatically upon normal program termination (using atexit())
- [Win32] Bugfix: Buffer-swapping did not work if a window lost focus.
- [Win32] Bugfix: Top level Makefile did not work under Windows 9x.
- [Win32] Bugfix: NULL declaratoin in glfw.h was not MSVC 7.x compatible.
- [X11] Bugfix: GLFW would not build with C++ (e.g. g++).

### v2.0

- GLFW is no longer a single source file, but an entire link library.
- Added multi threading support.
- Added more window control.
- New distribution layout (both Win32 and X11 version in same archive).
- Added GLFW Users Manual and GLFW Reference Manual as PDF files.
- Some bugfixes.

### v1.0.2

- Improved fullscreen functionality.
- Added fullscreen support for X11.

### v1.0.1

- Added support for the X Window System.
- Fixed bugs.

### v1.0.0

- First release.
- Only supported Windows.

## 6. Directory structure of the GLFW distribution

Here is an overview of the directory structure of the GLFW distribution:

docs |  | GLFW manuals in PDF format
examples |  | Several example programs in C
images |  | Images for this HTML document
include |  |
GL |  | Here is the GLFW C/C++ include file
lib |  | The source code for GLFW
amigaos |  | AmigaOS specific implementation (obsoleted)
dos |  | DOS specific implementation (obsoleted)
macosx |  | Mac OS X specific implementation
win32 |  | Windows specific implementation
x11 |  | Unix/X11 specific implementation
support |  |
d |  | D support
delphi |  | Delphi support
lua |  | Lua support
masm |  | MASM32 support
visualbasic |  | Visual Basic support

## 7. Contacting the project

The official GLFW web site can be found here: http://glfw.sourceforge.net/. It contains the latest version of GLFW, news and other information that is useful for OpenGL development.

If you have questions related to the use of GLFW, we have a user's web forum, and a user's mailing list on SF.net, and the IRC channel `#glfw` on Freenode.

If you have a bug to report or a feature you'd like to request, please file it in the SF.net trackers.

Finally, if you're interested in helping out with the development of GLFW or porting it to your favorite platform, we have a developer's mailing list, or you could join us on `#glfw`.

## 8. Acknowledgements

GLFW would not be what it is today without the help from:

- Marcus Geelnard, the orignal author and long-time maintainer of GLFW, without whose brilliant work none of this would have happened.
- Robin Leffmann, for his work on Mac OS X and other platforms, and his invaluable support.
- Keith Bauer, for his invaluable help with porting GLFW to Mac OS X, and for his many ideas.
- Ozzy @ Orkysquad, for his dedication to GLFW, for debugging my source, and for his valuable experience with game development.
- Jeff Molofee, the author of the excellent OpenGL tutorials at NeHe Productions. Much of the Windows code of GLFW was originally based on Jeff's code.
- Douglas C. Schmidt and Irfan Pyarali, for their excellent article Strategies for Implementing POSIX Condition Variables on Win32, which is the basis for the Win32 condition variable implementation in GLFW.
- Bobyshev Alexander and Martins Mozeiko, for the original proposal of an FSAA hint and their work on the Win32 implementation of FSAA.
- Gerald Franz, who made GLFW compile under IRIX, and supplied patches for the X11 keyboard translation routine.
- Bradley Smith, for his updates of the D support and his ports of the remaining examples to the D language.
- Olivier Delannoy, for the initial implementation of FSAA support on X11, cross-compiling support for MinGW and very timely nagging.
- Glenn Lewis, for helping out with support for the D programming language.
- David Medlock, for doing the initial Lua port.
- Frank Wille, for helping me with the AmigaOS port and making GLFW compile under IRIX 5.3.
- Matt Sealey, for helping me with the MorphOS port.
- Paul R. Deppe, who helped me with Cygwin support, and made an adaption of PLIB so that it can use GLFW (instead of GLUT).
- Jarrod Davis, for the Delphi port of GLFW.
- Toni Jovanoski, for helping me with the MASM32 port of GLFW, and supplying the example program and fixed OpenGL and GLU bindings for MASM32.
- Sebastian Schuberth, for the OpenWatcom makefiles.
- Dmitri Shuralyov, Samuli Tuomola, Santi Zupancic, Sylvain Hellegouarch, and many others for support, bug reports and testing.
- www.opengl.org, and all the people on the discussion forums there that have provided help during the development of GLFW.
- The MSDN Online Linrary, which was used extensively for Windows development.
- All the feedback from the GLFW community - thank you!