Commit d97dddc8 authored by Camilla Berglund's avatar Camilla Berglund
Browse files

Simplified function comment headers.

parent 8ad7c456
......@@ -30,12 +30,11 @@
#include "internal.h"
#include <sys/param.h> // For MAXPATHLEN
//========================================================================
// Change to our application bundle's resources directory, if present
//========================================================================
#if defined(_GLFW_USE_CHDIR)
// Change to our application bundle's resources directory, if present
//
static void changeToResourcesDirectory(void)
{
char resourcesPath[MAXPATHLEN];
......
......@@ -88,10 +88,8 @@ static _glfwJoystick _glfwJoysticks[GLFW_JOYSTICK_LAST + 1];
static void getElementsCFArrayHandler(const void* value, void* parameter);
//========================================================================
// Adds an element to the specified joystick
//========================================================================
//
static void addJoystickElement(_glfwJoystick* joystick, CFTypeRef refElement)
{
long elementType, usagePage, usage;
......@@ -183,22 +181,16 @@ static void addJoystickElement(_glfwJoystick* joystick, CFTypeRef refElement)
}
}
//========================================================================
// Adds an element to the specified joystick
//========================================================================
//
static void getElementsCFArrayHandler(const void* value, void* parameter)
{
if (CFGetTypeID(value) == CFDictionaryGetTypeID())
addJoystickElement((_glfwJoystick*) parameter, (CFTypeRef) value);
}
//========================================================================
// Returns the value of the specified element of the specified joystick
//========================================================================
//
static long getElementValue(_glfwJoystick* joystick, _glfwJoystickElement* element)
{
IOReturn result = kIOReturnSuccess;
......@@ -224,11 +216,8 @@ static long getElementValue(_glfwJoystick* joystick, _glfwJoystickElement* eleme
return (long) hidEvent.value;
}
//========================================================================
// Removes the specified joystick
//========================================================================
//
static void removeJoystick(_glfwJoystick* joystick)
{
int i;
......@@ -271,21 +260,15 @@ static void removeJoystick(_glfwJoystick* joystick)
}
}
//========================================================================
// Callback for user-initiated joystick removal
//========================================================================
//
static void removalCallback(void* target, IOReturn result, void* refcon, void* sender)
{
removeJoystick((_glfwJoystick*) refcon);
}
//========================================================================
// Polls for joystick events and updates GLFW state
//========================================================================
//
static void pollJoystickEvents(void)
{
int i;
......@@ -326,10 +309,8 @@ static void pollJoystickEvents(void)
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Initialize joystick interface
//========================================================================
//
void _glfwInitJoysticks(void)
{
int deviceCounter = 0;
......@@ -471,11 +452,8 @@ void _glfwInitJoysticks(void)
}
}
//========================================================================
// Close all opened joystick handles
//========================================================================
//
void _glfwTerminateJoysticks(void)
{
int i;
......
......@@ -36,10 +36,8 @@
#include <IOKit/graphics/IOGraphicsLib.h>
//========================================================================
// Get the name of the specified display
//========================================================================
//
const char* getDisplayName(CGDirectDisplayID displayID)
{
char* name;
......@@ -68,11 +66,8 @@ const char* getDisplayName(CGDirectDisplayID displayID)
return name;
}
//========================================================================
// Check whether the display mode should be included in enumeration
//========================================================================
//
static GLboolean modeIsGood(CGDisplayModeRef mode)
{
uint32_t flags = CGDisplayModeGetIOFlags(mode);
......@@ -100,11 +95,8 @@ static GLboolean modeIsGood(CGDisplayModeRef mode)
return GL_TRUE;
}
//========================================================================
// Convert Core Graphics display mode to GLFW video mode
//========================================================================
//
static GLFWvidmode vidmodeFromCGDisplayMode(CGDisplayModeRef mode)
{
GLFWvidmode result;
......@@ -135,10 +127,8 @@ static GLFWvidmode vidmodeFromCGDisplayMode(CGDisplayModeRef mode)
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Change the current video mode
//========================================================================
//
GLboolean _glfwSetVideoMode(_GLFWmonitor* monitor, int* width, int* height, int* bpp)
{
CGDisplayModeRef bestMode = NULL;
......@@ -199,11 +189,8 @@ GLboolean _glfwSetVideoMode(_GLFWmonitor* monitor, int* width, int* height, int*
return GL_TRUE;
}
//========================================================================
// Restore the previously saved (original) video mode
//========================================================================
//
void _glfwRestoreVideoMode(_GLFWmonitor* monitor)
{
CGDisplaySetDisplayMode(monitor->ns.displayID, monitor->ns.previousMode, NULL);
......
......@@ -32,10 +32,8 @@
#include <mach/mach_time.h>
//========================================================================
// Return raw time
//========================================================================
//
static uint64_t getRawTime(void)
{
return mach_absolute_time();
......@@ -46,10 +44,8 @@ static uint64_t getRawTime(void)
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Initialise timer
//========================================================================
//
void _glfwInitTimer(void)
{
mach_timebase_info_data_t info;
......
......@@ -33,9 +33,9 @@
#include <crt_externs.h>
//========================================================================
//------------------------------------------------------------------------
// Delegate for window related notifications
//========================================================================
//------------------------------------------------------------------------
@interface GLFWWindowDelegate : NSObject
{
......@@ -104,9 +104,9 @@
@end
//========================================================================
//------------------------------------------------------------------------
// Delegate for application related notifications
//========================================================================
//------------------------------------------------------------------------
@interface GLFWApplicationDelegate : NSObject
@end
......@@ -144,11 +144,8 @@
@end
//========================================================================
// Converts a Mac OS X keycode to a GLFW keycode
//========================================================================
//
static int convertMacKeyCode(unsigned int macKeyCode)
{
// Keyboard symbol translation table
......@@ -292,9 +289,9 @@ static int convertMacKeyCode(unsigned int macKeyCode)
}
//========================================================================
//------------------------------------------------------------------------
// Content view class for the GLFW window
//========================================================================
//------------------------------------------------------------------------
@interface GLFWContentView : NSView
{
......@@ -497,9 +494,9 @@ static int convertMacKeyCode(unsigned int macKeyCode)
@end
//========================================================================
//------------------------------------------------------------------------
// GLFW application class
//========================================================================
//------------------------------------------------------------------------
@interface GLFWApplication : NSApplication
@end
......@@ -519,11 +516,8 @@ static int convertMacKeyCode(unsigned int macKeyCode)
@end
//========================================================================
// Try to figure out what the calling application is called
//========================================================================
//
static NSString* findAppName(void)
{
unsigned int i;
......@@ -564,17 +558,14 @@ static NSString* findAppName(void)
return @"GLFW Application";
}
#if defined(_GLFW_USE_MENUBAR)
//========================================================================
// Set up the menu bar (manually)
// This is nasty, nasty stuff -- calls to undocumented semi-private APIs that
// could go away at any moment, lots of stuff that really should be
// localize(d|able), etc. Loading a nib would save us this horror, but that
// doesn't seem like a good thing to require of GLFW's clients.
//========================================================================
#if defined(_GLFW_USE_MENUBAR)
//
static void createMenuBar(void)
{
NSString* appName = findAppName();
......@@ -636,11 +627,8 @@ static void createMenuBar(void)
#endif /* _GLFW_USE_MENUBAR */
//========================================================================
// Initialize the Cocoa Application Kit
//========================================================================
//
static GLboolean initializeAppKit(void)
{
if (NSApp)
......@@ -661,11 +649,8 @@ static GLboolean initializeAppKit(void)
return GL_TRUE;
}
//========================================================================
// Create the Cocoa window
//========================================================================
//
static GLboolean createWindow(_GLFWwindow* window,
const _GLFWwndconfig* wndconfig)
{
......
......@@ -36,10 +36,8 @@
#include <stdio.h>
//========================================================================
// Parses the client API version string and extracts the version number
//========================================================================
//
static GLboolean parseGLVersion(int* api, int* major, int* minor, int* rev)
{
int i, _api = GLFW_OPENGL_API, _major, _minor = 0, _rev = 0;
......
......@@ -35,9 +35,8 @@
#include <assert.h>
//========================================================================
// Thread local storage attribute macro
//========================================================================
//
#if defined(_MSC_VER)
#define _GLFW_TLS __declspec(thread)
#elif defined(__GNUC__)
......@@ -47,16 +46,13 @@
#endif
//========================================================================
// The per-thread current context/window pointer
//========================================================================
//
static _GLFW_TLS _GLFWwindow* _glfwCurrentWindow = NULL;
//========================================================================
// Return a description of the specified EGL error
//========================================================================
//
static const char* getErrorString(EGLint error)
{
switch (error)
......@@ -109,10 +105,8 @@ static const char* getErrorString(EGLint error)
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Initialize EGL
//========================================================================
//
int _glfwInitContextAPI(void)
{
_glfw.egl.display = eglGetDisplay(_GLFW_EGL_NATIVE_DISPLAY);
......@@ -140,21 +134,13 @@ int _glfwInitContextAPI(void)
return GL_TRUE;
}
//========================================================================
// Terminate EGL
//========================================================================
//
void _glfwTerminateContextAPI(void)
{
eglTerminate(_glfw.egl.display);
}
//========================================================================
// Prepare for creation of the OpenGL context
//========================================================================
#define setEGLattrib(attribName, attribValue) \
{ \
attribs[index++] = attribName; \
......@@ -162,6 +148,8 @@ void _glfwTerminateContextAPI(void)
assert(index < sizeof(attribs) / sizeof(attribs[0])); \
}
// Prepare for creation of the OpenGL context
//
int _glfwCreateContext(_GLFWwindow* window,
const _GLFWwndconfig* wndconfig,
const _GLFWfbconfig* fbconfig)
......@@ -357,11 +345,8 @@ int _glfwCreateContext(_GLFWwindow* window,
#undef setEGLattrib
//========================================================================
// Destroy the OpenGL context
//========================================================================
//
void _glfwDestroyContext(_GLFWwindow* window)
{
#if defined(_GLFW_X11)
......@@ -385,11 +370,8 @@ void _glfwDestroyContext(_GLFWwindow* window)
}
}
//========================================================================
// Analyzes the specified context for possible recreation
//========================================================================
//
int _glfwAnalyzeContext(const _GLFWwindow* window,
const _GLFWwndconfig* wndconfig,
const _GLFWfbconfig* fbconfig)
......
......@@ -44,9 +44,8 @@ void (*glXGetProcAddressEXT(const GLubyte* procName))();
#endif
//========================================================================
// Thread local storage attribute macro
//========================================================================
//
#if defined(__GNUC__)
#define _GLFW_TLS __thread
#else
......@@ -54,33 +53,25 @@ void (*glXGetProcAddressEXT(const GLubyte* procName))();
#endif
//========================================================================
// The X error code as provided to the X error handler
//========================================================================
//
static unsigned long _glfwErrorCode = Success;
//========================================================================
// The per-thread current context/window pointer
//========================================================================
//
static _GLFW_TLS _GLFWwindow* _glfwCurrentWindow = NULL;
//========================================================================
// Error handler used when creating a context
//========================================================================
//
static int errorHandler(Display *display, XErrorEvent* event)
{
_glfwErrorCode = event->error_code;
return 0;
}
//========================================================================
// Create the OpenGL context using legacy API
//========================================================================
//
static GLXContext createLegacyContext(_GLFWwindow* window,
GLXFBConfig fbconfig,
GLXContext share)
......@@ -108,10 +99,8 @@ static GLXContext createLegacyContext(_GLFWwindow* window,
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Initialize GLX
//========================================================================
//
int _glfwInitContextAPI(void)
{
#ifdef _GLFW_DLOPEN_LIBGL
......@@ -231,11 +220,8 @@ int _glfwInitContextAPI(void)
return GL_TRUE;
}
//========================================================================
// Terminate GLX
//========================================================================
//
void _glfwTerminateContextAPI(void)
{
// Unload libGL.so if necessary
......@@ -248,11 +234,6 @@ void _glfwTerminateContextAPI(void)
#endif
}
//========================================================================
// Prepare for creation of the OpenGL context
//========================================================================
#define setGLXattrib(attribName, attribValue) \
{ \
attribs[index++] = attribName; \
......@@ -260,6 +241,8 @@ void _glfwTerminateContextAPI(void)
assert(index < sizeof(attribs) / sizeof(attribs[0])); \
}
// Prepare for creation of the OpenGL context
//
int _glfwCreateContext(_GLFWwindow* window,
const _GLFWwndconfig* wndconfig,
const _GLFWfbconfig* fbconfig)
......@@ -517,11 +500,8 @@ int _glfwCreateContext(_GLFWwindow* window,
#undef setGLXattrib
//========================================================================
// Destroy the OpenGL context
//========================================================================
//
void _glfwDestroyContext(_GLFWwindow* window)
{
if (window->glx.visual)
......
......@@ -36,26 +36,22 @@
#include <stdarg.h>
//------------------------------------------------------------------------
// Global state shared between compilation units of GLFW
// These are documented in internal.h
//------------------------------------------------------------------------
//
GLboolean _glfwInitialized = GL_FALSE;
_GLFWlibrary _glfw;
//------------------------------------------------------------------------
// The current error callback
// This is outside of _glfw so it can be initialized and usable before
// glfwInit is called, which lets that function report errors
//------------------------------------------------------------------------
//
static GLFWerrorfun _glfwErrorCallback = NULL;
//========================================================================
// Returns a generic string representation of the specified error
//========================================================================
//
static const char* getErrorString(int error)
{
switch (error)
......
......@@ -31,10 +31,8 @@
#include "internal.h"
//========================================================================
// Sets the cursor mode for the specified window
//========================================================================
//
static void setCursorMode(_GLFWwindow* window, int newMode)
{
int width, height, oldMode, centerPosX, centerPosY;
......@@ -66,11 +64,8 @@ static void setCursorMode(_GLFWwindow* window, int newMode)
_glfwInputCursorMotion(window, window->cursorPosX, window->cursorPosY);
}
//========================================================================
// Set sticky keys mode for the specified window
//========================================================================
//
static void setStickyKeys(_GLFWwindow* window, int enabled)
{
if (window->stickyKeys == enabled)
......@@ -91,11 +86,8 @@ static void setStickyKeys(_GLFWwindow* window, int enabled)
window->stickyKeys = enabled;
}
//========================================================================
// Set sticky mouse buttons mode for the specified window
//========================================================================
//
static void setStickyMouseButtons(_GLFWwindow* window, int enabled)
{
if (window->stickyMouseButtons == enabled)
......
......@@ -40,10 +40,8 @@
#endif
//========================================================================
// Lexical comparison function for GLFW video modes, used by qsort
//========================================================================
//
static int compareVideoModes(const void* firstPtr, const void* secondPtr)
{
int firstBPP, secondBPP, firstSize, secondSize;
......@@ -70,11 +68,8 @@ static int compareVideoModes(const void* firstPtr, const void* secondPtr)
return firstSize - secondSize;
}
//========================================================================
// Retrieves the available modes for the specified monitor
//========================================================================
//
static int refreshVideoModes(_GLFWmonitor* monitor)
{
int modeCount;
......
......@@ -32,9 +32,8 @@
#include <pthread.h>
//========================================================================
// The per-thread current context/window pointer
//========================================================================
//
static pthread_key_t _glfwCurrentTLS;
......@@ -42,10 +41,8 @@ static pthread_key_t _glfwCurrentTLS;
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Initialize OpenGL support
//========================================================================
//
int _glfwInitContextAPI(void)
{
if (pthread_key_create(&_glfwCurrentTLS, NULL) != 0)
......@@ -58,21 +55,15 @@ int _glfwInitContextAPI(void)
return GL_TRUE;
}
//========================================================================
// Terminate OpenGL support
//========================================================================