mirror of
https://github.com/glfw/glfw.git
synced 2026-09-19 23:43:15 +00:00
Removed duplicate documentation.
The public, platform, native, event and utility functions are already documented in-source. Having duplicate documentation inevitably means having them contradict one another. Furthermore, most of the function descriptions simply repeated the name of the function.
This commit is contained in:
+1
-51
@@ -92,10 +92,6 @@ static GLboolean parseGLVersion(int* api, int* major, int* minor, int* rev)
|
||||
////// GLFW internal API //////
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
|
||||
//========================================================================
|
||||
// Checks whether the client API part of the window config is sane
|
||||
//========================================================================
|
||||
|
||||
GLboolean _glfwIsValidContextConfig(_GLFWwndconfig* wndconfig)
|
||||
{
|
||||
if (wndconfig->clientAPI != GLFW_OPENGL_API &&
|
||||
@@ -210,11 +206,6 @@ GLboolean _glfwIsValidContextConfig(_GLFWwndconfig* wndconfig)
|
||||
return GL_TRUE;
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Reads back context properties
|
||||
//========================================================================
|
||||
|
||||
GLboolean _glfwRefreshContextParams(void)
|
||||
{
|
||||
_GLFWwindow* window = _glfwPlatformGetCurrentContext();
|
||||
@@ -315,11 +306,6 @@ GLboolean _glfwRefreshContextParams(void)
|
||||
return GL_TRUE;
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Checks whether the current context fulfils the specified requirements
|
||||
//========================================================================
|
||||
|
||||
GLboolean _glfwIsValidContext(_GLFWwndconfig* wndconfig)
|
||||
{
|
||||
_GLFWwindow* window = _glfwPlatformGetCurrentContext();
|
||||
@@ -342,13 +328,7 @@ GLboolean _glfwIsValidContext(_GLFWwndconfig* wndconfig)
|
||||
return GL_TRUE;
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Check if a string can be found in a client API extension string
|
||||
//========================================================================
|
||||
|
||||
int _glfwStringInExtensionString(const char* string,
|
||||
const GLubyte* extensions)
|
||||
int _glfwStringInExtensionString(const char* string, const GLubyte* extensions)
|
||||
{
|
||||
const GLubyte* start;
|
||||
GLubyte* where;
|
||||
@@ -382,10 +362,6 @@ int _glfwStringInExtensionString(const char* string,
|
||||
////// GLFW public API //////
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
|
||||
//========================================================================
|
||||
// Make the context associated with the specified window current
|
||||
//========================================================================
|
||||
|
||||
GLFWAPI void glfwMakeContextCurrent(GLFWwindow* handle)
|
||||
{
|
||||
_GLFWwindow* window = (_GLFWwindow*) handle;
|
||||
@@ -402,11 +378,6 @@ GLFWAPI void glfwMakeContextCurrent(GLFWwindow* handle)
|
||||
_glfwPlatformMakeContextCurrent(window);
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Returns the window whose context is current
|
||||
//========================================================================
|
||||
|
||||
GLFWAPI GLFWwindow* glfwGetCurrentContext(void)
|
||||
{
|
||||
if (!_glfwInitialized)
|
||||
@@ -418,11 +389,6 @@ GLFWAPI GLFWwindow* glfwGetCurrentContext(void)
|
||||
return (GLFWwindow*) _glfwPlatformGetCurrentContext();
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Swap buffers (double-buffering)
|
||||
//========================================================================
|
||||
|
||||
GLFWAPI void glfwSwapBuffers(GLFWwindow* handle)
|
||||
{
|
||||
_GLFWwindow* window = (_GLFWwindow*) handle;
|
||||
@@ -436,11 +402,6 @@ GLFWAPI void glfwSwapBuffers(GLFWwindow* handle)
|
||||
_glfwPlatformSwapBuffers(window);
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Set double buffering swap interval (0 = vsync off)
|
||||
//========================================================================
|
||||
|
||||
GLFWAPI void glfwSwapInterval(int interval)
|
||||
{
|
||||
if (!_glfwInitialized)
|
||||
@@ -458,11 +419,6 @@ GLFWAPI void glfwSwapInterval(int interval)
|
||||
_glfwPlatformSwapInterval(interval);
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Check if a client API extension is available at runtime
|
||||
//========================================================================
|
||||
|
||||
GLFWAPI int glfwExtensionSupported(const char* extension)
|
||||
{
|
||||
const GLubyte* extensions;
|
||||
@@ -523,12 +479,6 @@ GLFWAPI int glfwExtensionSupported(const char* extension)
|
||||
return _glfwPlatformExtensionSupported(extension);
|
||||
}
|
||||
|
||||
|
||||
//========================================================================
|
||||
// Get the function pointer to a client API function
|
||||
// This can be used to get access to client API extension functions
|
||||
//========================================================================
|
||||
|
||||
GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname)
|
||||
{
|
||||
if (!_glfwInitialized)
|
||||
|
||||
Reference in New Issue
Block a user