Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-26 03:52:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add paragraphs on GL helpers not being for Vulkan

Browse Source
This commit is contained in:
Camilla Berglund 2016-02-19 09:13:56 +01:00
parent 3b64bae323
commit 001c50cfc6
1 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
include/GLFW/glfw3.h
View File

@ -3532,14 +3532,18 @@ GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
/*! @brief Swaps the front and back buffers of the specified window. /*! @brief Swaps the front and back buffers of the specified window.
* *
* This function swaps the front and back buffers of the specified window. If * This function swaps the front and back buffers of the specified window when
* the swap interval is greater than zero, the GPU driver waits the specified * rendering with OpenGL or OpenGL ES. If the swap interval is greater than
* number of screen updates before swapping the buffers. * zero, the GPU driver waits the specified number of screen updates before
* swapping the buffers.
* *
* The specified window must have an OpenGL or OpenGL ES context. Specifying * The specified window must have an OpenGL or OpenGL ES context. Specifying
* a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT * a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT
* error. * error.
* *
* This function does not apply to Vulkan. If you are rendering with Vulkan,
* see `vkQueuePresentKHR` instead.
*
* @param[in] window The window whose buffers to swap. * @param[in] window The window whose buffers to swap.
* *
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
@ -3562,11 +3566,11 @@ GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
/*! @brief Sets the swap interval for the current context. /*! @brief Sets the swap interval for the current context.
* *
* This function sets the swap interval for the current context, i.e. the * This function sets the swap interval for the current OpenGL or OpenGL ES
* number of screen updates to wait from the time @ref glfwSwapBuffers was * context, i.e. the number of screen updates to wait from the time @ref
* called before swapping the buffers and returning. This is sometimes called * glfwSwapBuffers was called before swapping the buffers and returning. This
* _vertical synchronization_, _vertical retrace synchronization_ or just * is sometimes called _vertical synchronization_, _vertical retrace
* _vsync_. * synchronization_ or just _vsync_.
* *
* Contexts that support either of the `WGL_EXT_swap_control_tear` and * Contexts that support either of the `WGL_EXT_swap_control_tear` and
* `GLX_EXT_swap_control_tear` extensions also accept negative swap intervals, * `GLX_EXT_swap_control_tear` extensions also accept negative swap intervals,
@ -3578,6 +3582,9 @@ GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
* A context must be current on the calling thread. Calling this function * A context must be current on the calling thread. Calling this function
* without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error. * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
* *
* This function does not apply to Vulkan. If you are rendering with Vulkan,
* see the present mode of your swapchain instead.
*
* @param[in] interval The minimum number of screen updates to wait for * @param[in] interval The minimum number of screen updates to wait for
* until the buffers are swapped by @ref glfwSwapBuffers. * until the buffers are swapped by @ref glfwSwapBuffers.
* *
@ -3607,9 +3614,9 @@ GLFWAPI void glfwSwapInterval(int interval);
/*! @brief Returns whether the specified extension is available. /*! @brief Returns whether the specified extension is available.
* *
* This function returns whether the specified * This function returns whether the specified
* [client API extension](@ref context_glext) is supported by the current * [API extension](@ref context_glext) is supported by the current OpenGL or
* OpenGL or OpenGL ES context. It searches both for OpenGL and OpenGL ES * OpenGL ES context. It searches both for client API extension and context
* extension and platform-specific context creation API extensions. * creation API extensions.
* *
* A context must be current on the calling thread. Calling this function * A context must be current on the calling thread. Calling this function
* without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error. * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
@ -3619,6 +3626,10 @@ GLFWAPI void glfwSwapInterval(int interval);
* frequently. The extension strings will not change during the lifetime of * frequently. The extension strings will not change during the lifetime of
* a context, so there is no danger in doing this. * a context, so there is no danger in doing this.
* *
* This function does not apply to Vulkan. If you are using Vulkan, see @ref
* glfwGetRequiredInstanceExtensions, `vkEnumerateInstanceExtensionProperties`
* and `vkEnumerateDeviceExtensionProperties` instead.
*
* @param[in] extension The ASCII encoded name of the extension. * @param[in] extension The ASCII encoded name of the extension.
* @return `GLFW_TRUE` if the extension is available, or `GLFW_FALSE` * @return `GLFW_TRUE` if the extension is available, or `GLFW_FALSE`
* otherwise. * otherwise.
@ -3641,13 +3652,17 @@ GLFWAPI int glfwExtensionSupported(const char* extension);
/*! @brief Returns the address of the specified function for the current /*! @brief Returns the address of the specified function for the current
* context. * context.
* *
* This function returns the address of the specified * This function returns the address of the specified OpenGL or OpenGL ES
* [core or extension function](@ref context_glext), if it is supported * [core or extension function](@ref context_glext), if it is supported
* by the current context. * by the current context.
* *
* A context must be current on the calling thread. Calling this function * A context must be current on the calling thread. Calling this function
* without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error. * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
* *
* This function does not apply to Vulkan. If you are rendering with Vulkan,
* see @ref glfwGetInstanceProcAddress, `vkGetInstanceProcAddr` and
* `vkGetDeviceProcAddr` instead.
*
* @param[in] procname The ASCII encoded name of the function. * @param[in] procname The ASCII encoded name of the function.
* @return The address of the function, or `NULL` if an * @return The address of the function, or `NULL` if an
* [error](@ref error_handling) occurred. * [error](@ref error_handling) occurred.