diff options
| author | David Robillard <d@drobilla.net> | 2012-05-01 01:15:58 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2012-05-01 01:15:58 +0000 |
| commit | 8cbedf0261ec0e1cfe51da2a7ccb7358918d967b (patch) | |
| tree | 1cc50f43041ccd072b67c993a990cc0dd2050bec | |
| parent | 0f2556e3c1cef484ebda4e2f0f2be507b2c0a482 (diff) | |
Add AUTHORS and README file.
Add doc comments for each file.
| -rw-r--r-- | AUTHORS | 5 | ||||
| -rw-r--r-- | README | 27 | ||||
| -rw-r--r-- | pugl/pugl_internal.h | 1 | ||||
| -rw-r--r-- | pugl/pugl_osx.m | 4 | ||||
| -rw-r--r-- | pugl/pugl_win.cpp | 4 | ||||
| -rw-r--r-- | pugl/pugl_x11.c | 4 |
6 files changed, 44 insertions, 1 deletions
@@ -0,0 +1,5 @@ +Author: + David Robillard <d@drobilla.net> + +Original GLX inspiration: + Ben Loftis @@ -0,0 +1,27 @@ +PUGL +==== + +Pugl is a minimal portable API for OpenGL GUIs which supports embedding and is +suitable for use in plugins. It works on X11, Mac OS X, and Windows. + +Pugl is vaguely similar to GLUT, but with some significant distinctions: + + * Minimal in scope, providing only what is necessary to draw and receive + keyboard and mouse input. + + * No reliance on static data whatsoever, so the API can be used in plugins or + multiple independent parts of a program. + + * Single implementation, which is small, liberally licensed Free / Open Source + Software, and suitable for direct inclusion in programs if avoiding a + library dependency is desired. + + * Support for embedding in other windows, so Pugl code can draw to a widget + inside a larger GUI. + + * More complete support for keyboard input, including additional "special" + keys, modifiers, and support for detecting individual modifier key presses. + +For more information, see <http://drobilla.net/software/pugl>. + + -- David Robillard <d@drobilla.net> diff --git a/pugl/pugl_internal.h b/pugl/pugl_internal.h index 6ddcdf8..5235db3 100644 --- a/pugl/pugl_internal.h +++ b/pugl/pugl_internal.h @@ -1,6 +1,5 @@ /* Copyright 2012 David Robillard <http://drobilla.net> - Copyright 2011-2012 Ben Loftis, Harrison Consoles Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above diff --git a/pugl/pugl_osx.m b/pugl/pugl_osx.m index 2a534b3..3c5425e 100644 --- a/pugl/pugl_osx.m +++ b/pugl/pugl_osx.m @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_osx.m OSX/Cocoa Pugl Implementation. +*/ + #include <stdlib.h> #import <Cocoa/Cocoa.h> diff --git a/pugl/pugl_win.cpp b/pugl/pugl_win.cpp index 03bee11..3128daf 100644 --- a/pugl/pugl_win.cpp +++ b/pugl/pugl_win.cpp @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_win.cpp Windows/WGL Pugl Implementation. +*/ + #include <windows.h> #include <windowsx.h> #include <GL/gl.h> diff --git a/pugl/pugl_x11.c b/pugl/pugl_x11.c index 35d2d42..755dd87 100644 --- a/pugl/pugl_x11.c +++ b/pugl/pugl_x11.c @@ -15,6 +15,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_x11.c X11 Pugl Implementation. +*/ + #include <stdio.h> #include <stdlib.h> #include <string.h> |