caio/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-08-29 11:14:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Removed duplicate documentation.

Browse Source 
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:
Camilla Berglund
2013-01-23 19:47:05 +01:00
parent 75705ba2c5
commit 3e78570a31
35 changed files with 15 additions and 1028 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
src/monitor.c
View File

@@ -97,10 +97,6 @@ static int refreshVideoModes(_GLFWmonitor* monitor)
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Create a monitor struct from the specified information
//========================================================================
_GLFWmonitor* _glfwCreateMonitor(const char* name,
GLboolean primary,
int widthMM, int heightMM,
@@ -123,11 +119,6 @@ _GLFWmonitor* _glfwCreateMonitor(const char* name,
return monitor;
}
//========================================================================
// Destroy the specified monitor
//========================================================================
void _glfwDestroyMonitor(_GLFWmonitor* monitor)
{
if (monitor == NULL)
@@ -140,11 +131,6 @@ void _glfwDestroyMonitor(_GLFWmonitor* monitor)
free(monitor);
}
//========================================================================
// Enumerate monitors and notify user of changes
//========================================================================
void _glfwInputMonitorChange(void)
{
int i, j, monitorCount;
@@ -203,11 +189,6 @@ void _glfwInputMonitorChange(void)
_glfw.monitorCount = monitorCount;
}
//========================================================================
// Destroy all monitors
//========================================================================
void _glfwDestroyMonitors(void)
{
int i;
@@ -220,11 +201,6 @@ void _glfwDestroyMonitors(void)
_glfw.monitorCount = 0;
}
//========================================================================
// Returns the video mode closest to the desired one
//========================================================================
const GLFWvidmode* _glfwChooseVideoMode(_GLFWmonitor* monitor,
const GLFWvidmode* desired)
{
@@ -261,21 +237,11 @@ const GLFWvidmode* _glfwChooseVideoMode(_GLFWmonitor* monitor,
return closest;
}
//========================================================================
// Lexical comparison of GLFW video modes
//========================================================================
int _glfwCompareVideoModes(const GLFWvidmode* first, const GLFWvidmode* second)
{
return compareVideoModes(first, second);
}
//========================================================================
// Convert BPP to RGB bits based on "best guess"
//========================================================================
void _glfwSplitBPP(int bpp, int* red, int* green, int* blue)
{
int delta;
@@ -300,10 +266,6 @@ void _glfwSplitBPP(int bpp, int* red, int* green, int* blue)
////// GLFW public API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Return the currently connected monitors
//========================================================================
GLFWAPI GLFWmonitor** glfwGetMonitors(int* count)
{
if (!_glfwInitialized)
@@ -316,11 +278,6 @@ GLFWAPI GLFWmonitor** glfwGetMonitors(int* count)
return (GLFWmonitor**) _glfw.monitors;
}
//========================================================================
// Get the primary monitor
//========================================================================
GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void)
{
int i;
@@ -350,11 +307,6 @@ GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void)
return (GLFWmonitor*) primary;
}
//========================================================================
// Get monitor parameter
//========================================================================
GLFWAPI int glfwGetMonitorParam(GLFWmonitor* handle, int param)
{
_GLFWmonitor* monitor = (_GLFWmonitor*) handle;
@@ -382,11 +334,6 @@ GLFWAPI int glfwGetMonitorParam(GLFWmonitor* handle, int param)
return 0;
}
//========================================================================
// Get monitor string
//========================================================================
GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* handle)
{
_GLFWmonitor* monitor = (_GLFWmonitor*) handle;
@@ -400,11 +347,6 @@ GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* handle)
return monitor->name;
}
//========================================================================
// Set a callback function for monitor events
//========================================================================
GLFWAPI void glfwSetMonitorCallback(GLFWmonitorfun cbfun)
{
if (!_glfwInitialized)
@@ -416,11 +358,6 @@ GLFWAPI void glfwSetMonitorCallback(GLFWmonitorfun cbfun)
_glfw.monitorCallback = cbfun;
}
//========================================================================
// Get a list of available video modes
//========================================================================
GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* handle, int* count)
{
_GLFWmonitor* monitor = (_GLFWmonitor*) handle;
@@ -438,11 +375,6 @@ GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* handle, int* count)
return monitor->modes;
}
//========================================================================
// Get the current video mode for the specified monitor
//========================================================================
GLFWAPI GLFWvidmode glfwGetVideoMode(GLFWmonitor* handle)
{
_GLFWmonitor* monitor = (_GLFWmonitor*) handle;