From 3af1c411ca72db97734dd4aa46219adeb0c01338 Mon Sep 17 00:00:00 2001
From: Camilla Berglund <elmindreda@elmindreda.org>
Date: Thu, 19 Sep 2013 21:37:01 +0200
Subject: [PATCH] Added notes on swap interval defaults.

---
 include/GLFW/glfw3.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h
index 8b11c2fc..477fd2c3 100644
--- a/include/GLFW/glfw3.h
+++ b/include/GLFW/glfw3.h
@@ -1243,6 +1243,10 @@ GLFWAPI void glfwWindowHint(int target, int hint);
  *  information from the application's bundle.  For more information on bundles,
  *  see the Bundle Programming Guide provided by Apple.
  *
+ *  @remarks The swap interval is not set during window creation, but is left at
+ *  the default value for that platform.  For more information, see @ref
+ *  glfwSwapInterval.
+ *
  *  @note This function may only be called from the main thread.
  *
  *  @sa glfwDestroyWindow
@@ -2201,6 +2205,11 @@ GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
  *
  *  @remarks This function may be called from secondary threads.
  *
+ *  @note This function is not called during window creation, leaving the swap
+ *  interval set to whatever is the default on that platform.  This is done
+ *  because some swap interval extensions used by GLFW do not allow the swap
+ *  interval to be reset to zero once it has been set to a non-zero value.
+ *
  *  @note Some GPU drivers do not honor the requested swap interval, either
  *  because of user settings that override the request or due to bugs in the
  *  driver.