Browse Source

Moved public headers to the GLFW directory.

Camilla Berglund 12 years ago
parent
commit
15ed715f4e

+ 1 - 1
CMakeLists.txt

@@ -394,7 +394,7 @@ configure_file(${GLFW_SOURCE_DIR}/src/config.h.in
 # Install the public headers
 # The src directory's CMakeLists.txt file installs the library
 #--------------------------------------------------------------------
-install(DIRECTORY include/GL DESTINATION include 
+install(DIRECTORY include/GLFW DESTINATION include 
         FILES_MATCHING PATTERN glfw3.h PATTERN glfw3native.h)
 
 #--------------------------------------------------------------------

+ 2 - 1
README.md

@@ -107,7 +107,7 @@ The first point is covered in the WIP
 In the files of your program where you use OpenGL or GLFW, you should include
 the GLFW 3 header file, i.e.:
 
-    #include <GL/glfw3.h>
+    #include <GLFW/glfw3.h>
 
 This defines all the constants, types and function prototypes of the GLFW API.
 It also includes the chosen client API header files (by default OpenGL), and
@@ -327,6 +327,7 @@ GLFW.
    modes for the specified monitor
  * Changed cursor position to double-precision floating-point
  * Changed default cursor mode for fullscreen to normal
+ * Renamed header directory `GL` to `GLFW`
  * Renamed `glfw.h` to `glfw3.h` to avoid conflicts with 2.x series
  * Renamed `glfwOpenWindowHint` to `glfwWindowHint`
  * Renamed `GLFW_ACTIVE` to `GLFW_FOCUSED`

+ 1 - 1
docs/Doxyfile.in

@@ -668,7 +668,7 @@ WARN_LOGFILE           = @GLFW_BINARY_DIR@/docs/warnings.txt
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = @GLFW_DOC_HEADERS@ @GLFW_SOURCE_DIR@/include/GL/ @GLFW_SOURCE_DIR@/docs/
+INPUT                  = @GLFW_DOC_HEADERS@ @GLFW_SOURCE_DIR@/include/GLFW/ @GLFW_SOURCE_DIR@/docs/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

+ 5 - 5
docs/moving.dox

@@ -236,11 +236,11 @@ terminated and re-initialized.
 
 @subsection moving_renamed_files Library and header file
 
-The GLFW 3 header is named @ref glfw3.h, to avoid collisions with the GLFW 2
-`glfw.h` header, in case they are both installed.  Similarly, the GLFW 3 library
-is named `glfw3,` except when it's installed as a shared library on Unix-like
-systems, where it uses the [soname](https://en.wikipedia.org/wiki/soname)
-`libglfw.so.3`.
+The GLFW 3 header is named @ref glfw3.h and moved to the `GLFW` directory, to
+avoid collisions with the headers of other major versions.  Similarly, the GLFW
+3 library is named `glfw3,` except when it's installed as a shared library on
+Unix-like systems, where it uses the
+[soname](https://en.wikipedia.org/wiki/soname) `libglfw.so.3`.
 
 
 @subsection moving_renamed_functions Functions

+ 2 - 2
docs/quick.dox

@@ -20,7 +20,7 @@ In the files of your program where you use OpenGL or GLFW, you need to include
 the GLFW 3 header file.
 
 @code
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 @endcode
 
 This defines all the constants, types and function prototypes of the GLFW API.
@@ -50,7 +50,7 @@ inclusion of the GLFW header.
 
 @code
 #define GLFW_INCLUDE_GLU
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 @endcode
 
 

+ 1 - 1
examples/boing.c

@@ -32,7 +32,7 @@
 #include <math.h>
 
 #define GLFW_INCLUDE_GLU
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 
 /*****************************************************************************

+ 1 - 1
examples/gears.c

@@ -26,7 +26,7 @@
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #ifndef M_PI
 #define M_PI 3.141592654

+ 1 - 1
examples/heightmap.c

@@ -30,7 +30,7 @@
 #include <stddef.h>
 #include "getopt.h"
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 #include <GL/glext.h>
 
 /* OpenGL function pointers */

+ 1 - 1
examples/simple.c

@@ -24,7 +24,7 @@
 //========================================================================
 //! [code]
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdlib.h>
 #include <stdio.h>

+ 1 - 1
examples/splitview.c

@@ -11,7 +11,7 @@
 //========================================================================
 
 #define GLFW_INCLUDE_GLU
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <math.h>
 #include <stdio.h>

+ 1 - 1
examples/wave.c

@@ -13,7 +13,7 @@
 #include <math.h>
 
 #define GLFW_INCLUDE_GLU
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #ifndef M_PI
  #define M_PI 3.1415926535897932384626433832795

+ 0 - 0
include/GL/glfw3.h → include/GLFW/glfw3.h


+ 0 - 0
include/GL/glfw3native.h → include/GLFW/glfw3native.h


+ 1 - 1
src/CMakeLists.txt

@@ -7,7 +7,7 @@ if (MSVC)
     add_definitions(-D_CRT_SECURE_NO_WARNINGS)
 endif()
 
-set(common_HEADERS ${GLFW_SOURCE_DIR}/include/GL/glfw3.h internal.h)
+set(common_HEADERS ${GLFW_SOURCE_DIR}/include/GLFW/glfw3.h internal.h)
 set(common_SOURCES clipboard.c context.c gamma.c init.c input.c joystick.c
                    monitor.c time.c window.c)
 

+ 1 - 1
src/internal.h

@@ -48,7 +48,7 @@
 // inclusion of our own, newer glext.h below
 #define GL_GLEXT_LEGACY
 
-#include "../include/GL/glfw3.h"
+#include "../include/GLFW/glfw3.h"
 
 #if defined(_GLFW_USE_OPENGL)
  // This path may need to be changed if you build GLFW using your own setup

+ 1 - 1
tests/accuracy.c

@@ -30,7 +30,7 @@
 //========================================================================
 
 #define GLFW_INCLUDE_GLU
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/clipboard.c

@@ -27,7 +27,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/defaults.c

@@ -29,7 +29,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 #include <GL/glext.h>
 
 #include <stdio.h>

+ 1 - 1
tests/events.c

@@ -31,7 +31,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/fsaa.c

@@ -30,7 +30,7 @@
 //========================================================================
 
 #define GLFW_INCLUDE_GLU
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 #include <GL/glext.h>
 
 #include <stdio.h>

+ 1 - 1
tests/gamma.c

@@ -28,7 +28,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/glfwinfo.c

@@ -29,7 +29,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 #include <GL/glext.h>
 
 #include <stdio.h>

+ 1 - 1
tests/iconify.c

@@ -28,7 +28,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/joysticks.c

@@ -28,7 +28,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <string.h>

+ 1 - 1
tests/modes.c

@@ -27,7 +27,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <string.h>

+ 1 - 1
tests/peter.c

@@ -30,7 +30,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/reopen.c

@@ -33,7 +33,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/sharing.c

@@ -28,7 +28,7 @@
 //========================================================================
 
 #define GLFW_INCLUDE_GLU
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/tearing.c

@@ -28,7 +28,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/threads.c

@@ -30,7 +30,7 @@
 
 #include "tinycthread.h"
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/title.c

@@ -27,7 +27,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>

+ 1 - 1
tests/windows.c

@@ -27,7 +27,7 @@
 //
 //========================================================================
 
-#include <GL/glfw3.h>
+#include <GLFW/glfw3.h>
 
 #include <stdio.h>
 #include <stdlib.h>