Mercurial > sdl-ios-xcode
view src/video/photon/SDL_photon.h @ 5067:61d53410eb41
Fixed bug #859
CREATE_SUBDIRS helps a lot if browsing HTML documentation in a file browser.
ALWAYS_DETAILED_SEC makes sure everything has at least the automatic
documentation like function prototype and source references.
STRIP_FROM_PATH allows you to include only the relevant portions of the files'
paths, cleaning up both the file list and directory tree, though you need to
change the path listed here to match wherever you put SDL.
ALIASES avoids some warnings generated by
C:\source\svn.libsdl.org\trunk\SDL\src\joystick\darwin\10.3.9-FIX\IOHIDLib.h.
It seems Apple uses a few commands which are not normally supported by Doxygen.
BUILTIN_STL_SUPPORT adds support for parsing code which makes use of the
standard template library. There isn't a lot of C++ in SDL (some in bwindow at
least), but this still seems like a good idea.
TYPEDEF_HIDES_STRUCT means that for code like this:
typedef struct A {int B;} C;
C is documented as a structure containing B instead of a typedef mapped to A.
EXTRACT_ALL, EXTRACT_PRIVATE, EXTRACT_STATIC, EXTRACT_LOCAL_METHODS,
EXTRACT_ANON_NSPACES and INTERNAL_DOCS make sure that _everything_ is
documented.
CASE_SENSE_NAMES = NO avoids potential conflicts when building documentation on
case insensitive file systems like NTFS and FAT32.
WARN_NO_PARAMDOC lets you know when you have documented some, but not all, of
the parameters of a function. This is useful when you're working on adding
such documentation since it makes partially documented functions easier to
spot.
WARN_LOGFILE writes warnings to a seperate file instead of mixing them in with
stdout. When not running in quiet mode, these warnings can be hard to spot
without this flag.
I added *.h.in and *.h.default to FILE_PATTERNS to generate documentation for
config.h.in and config.h.default.
RECURSIVE tells doxygen to look not only in the input directory, but also in
subfolders.
EXCLUDE avoids documenting things like test programs, examples and templates
which need to be documented separately.
I've used EXCLUDE_PATTERNS to exclude non-source subdirectories that often find
their way into source folders (such as obj or .svn).
EXAMPLE_PATH lists directories doxygen will search to find included example
code. So far, SDL doesn't really use this feature, but I've listed some likely
locations.
SOURCE_BROWSER adds syntax highlighted source code to the HTML output.
USE_HTAGS is nice, but not available on Windows.
INLINE_SOURCES adds the body of a function to it's documentation so you can
quickly see exactly what it does.
ALPHABETICAL_INDEX generates an alphabetical list of all structures, functions,
etc., which makes it much easier to find what you're looking for.
IGNORE_PREFIX skips the SDL_ prefix when deciding which index page to place an
item on so you don't have everything show up under "S".
HTML_DYNAMIC_SECTIONS hides the includes/included by diagrams by default and
adds JavaScript to allow the user to show and hide them by clicking a link.
ENUM_VALUES_PER_LINE = 1 makes enums easier to read by placing each value on
it's own line.
GENERATE_TREEVIEW produces a two frame index page with a navigation tree on the
left.
I have LaTeX and man pages turned off to speed up doxygen, you may want to turn
them back on yourself.
I added _WIN32=1 to PREDEFINED to cause SDL to output documentation related to
Win32 builds of SDL. Normally, doxygen gets confused since there are multiple
definitions for various structures and formats that vary by platform. Without
this doxygen can produce broken documentation or, if you're lucky, output
documentation only for the dummy drivers, which isn't very useful. You need to
pick a platform.
GENERATE_TAGFILE produces a file which can be used to link other doxygen
documentation to the SDL documentation.
CLASS_DIAGRAMS turns on class diagrams even when dot is not available.
HAVE_DOT tells doxygen to try to use dot to generate diagrams.
TEMPLATE_RELATIONS and INCLUDE_GRAPH add additional diagrams to the
documentation.
DOT_MULTI_TARGETS speeds up dot.
OUTPUT_DIRECTORY, INPUT and other paths reflect the fact that this Doxyfile is
intended to process src as well as include and is being run from a separate
subdirectory. Doxygen produces several temporary files while it's running and
if interrupted, can leave those files behind. It's easier to clean up if there
aren't a hundred or so files in the same folder. I typically run doxygen in
SDL/doxy and set the output directory to '.'. Since doxygen puts it's output
in subfolders by type, this keeps things pretty well organised. You could use
'../doc' instead and get the same results.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Fri, 21 Jan 2011 12:57:01 -0800 |
| parents | f7b03b6838cb |
| children | be02be2ea897 |
line wrap: on
line source
/* SDL - Simple DirectMedia Layer Copyright (C) 1997-2010 Sam Lantinga This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Sam Lantinga slouken@libsdl.org QNX Photon GUI SDL driver Copyright (C) 2009 Mike Gorchak (mike@malva.ua, lestat@i.com.ua) */ #ifndef __SDL_PHOTON_H__ #define __SDL_PHOTON_H__ /* GF headers must be included first for the Photon GF functions */ #if defined(SDL_VIDEO_OPENGL_ES) #include <gf/gf.h> #include <GLES/egl.h> #endif /* SDL_VIDEO_OPENGL_ES */ #include "SDL_config.h" #include "../SDL_sysvideo.h" #include <Ph.h> #include <Pt.h> #include <photon/PkKeyDef.h> /* Maximum display devices, which can handle SDL Photon driver */ #define SDL_VIDEO_PHOTON_MAX_RIDS 16 typedef struct SDL_VideoData { PhRid_t rid[SDL_VIDEO_PHOTON_MAX_RIDS]; uint32_t avail_rids; uint32_t current_device_id; #if defined(SDL_VIDEO_OPENGL_ES) gf_dev_t gfdev; /* GF device handle */ gf_dev_info_t gfdev_info; /* GF device information */ SDL_bool gfinitialized; /* GF device initialization status */ EGLDisplay egldisplay; /* OpenGL ES display connection */ uint32_t egl_refcount; /* OpenGL ES reference count */ uint32_t swapinterval; /* OpenGL ES default swap interval */ EGLContext lgles_context; /* Last used OpenGL ES context */ EGLSurface lgles_surface; /* Last used OpenGL ES target surface */ #endif /* SDL_VIDEO_OPENGL_ES */ } SDL_VideoData; /* This is hardcoded value in photon/Pg.h */ #define SDL_VIDEO_PHOTON_DEVICENAME_MAX 41 #define SDL_VIDEO_PHOTON_MAX_CURSOR_SIZE 128 /* Maximum event message size with data payload */ #define SDL_VIDEO_PHOTON_EVENT_SIZE 8192 /* Current video mode graphics capabilities */ #define SDL_VIDEO_PHOTON_CAP_ALPHA_BLEND 0x00000001 #define SDL_VIDEO_PHOTON_CAP_SCALED_BLIT 0x00000002 typedef struct SDL_DisplayData { uint32_t device_id; uint32_t custom_refresh; /* Custom refresh rate for all modes */ SDL_DisplayMode current_mode; /* Current video mode */ uint8_t description[SDL_VIDEO_PHOTON_DEVICENAME_MAX]; /* Device description */ uint32_t caps; /* Device capabilities */ PhCursorDef_t *cursor; /* Global cursor settings */ SDL_bool cursor_visible; /* SDL_TRUE if cursor visible */ uint32_t cursor_size; /* Cursor size in memory w/ structure */ uint32_t mode_2dcaps; /* Current video mode 2D capabilities */ SDL_bool direct_mode; /* Direct mode state */ #if defined(SDL_VIDEO_OPENGL_ES) gf_display_t display; /* GF display handle */ gf_display_info_t display_info; /* GF display information */ #endif /* SDL_VIDEO_OPENGL_ES */ } SDL_DisplayData; /* Maximum amount of OpenGL ES framebuffer configurations */ #define SDL_VIDEO_GF_OPENGLES_CONFS 32 typedef struct SDL_WindowData { SDL_bool uses_gles; /* if true window must support OpenGL ES */ PtWidget_t *window; /* window handle */ #if defined(SDL_VIDEO_OPENGL_ES) EGLConfig gles_configs[SDL_VIDEO_GF_OPENGLES_CONFS]; /* OpenGL ES framebuffer confs */ EGLint gles_config; /* OpenGL ES configuration index */ EGLContext gles_context; /* OpenGL ES context */ EGLint gles_attributes[256]; /* OpenGL ES attributes for context */ EGLSurface gles_surface; /* OpenGL ES target rendering surface */ gf_surface_t gfsurface; /* OpenGL ES GF's surface */ PdOffscreenContext_t *phsurface; /* OpenGL ES Photon's surface */ #endif /* SDL_VIDEO_OPENGL_ES */ } SDL_WindowData; /****************************************************************************/ /* Low level Photon graphics driver capabilities */ /****************************************************************************/ typedef struct Photon_DeviceCaps { uint8_t *name; uint32_t caps; } Photon_DeviceCaps; #define SDL_PHOTON_UNACCELERATED 0x00000000 #define SDL_PHOTON_ACCELERATED 0x00000001 #define SDL_PHOTON_UNACCELERATED_3D 0x00000000 #define SDL_PHOTON_ACCELERATED_3D 0x00000004 /****************************************************************************/ /* SDL_VideoDevice functions declaration */ /****************************************************************************/ /* Display and window functions */ int photon_videoinit(_THIS); void photon_videoquit(_THIS); void photon_getdisplaymodes(_THIS); int photon_setdisplaymode(_THIS, SDL_DisplayMode * mode); int photon_setdisplaypalette(_THIS, SDL_Palette * palette); int photon_getdisplaypalette(_THIS, SDL_Palette * palette); int photon_setdisplaygammaramp(_THIS, Uint16 * ramp); int photon_getdisplaygammaramp(_THIS, Uint16 * ramp); int photon_createwindow(_THIS, SDL_Window * window); int photon_createwindowfrom(_THIS, SDL_Window * window, const void *data); void photon_setwindowtitle(_THIS, SDL_Window * window); void photon_setwindowicon(_THIS, SDL_Window * window, SDL_Surface * icon); void photon_setwindowposition(_THIS, SDL_Window * window); void photon_setwindowsize(_THIS, SDL_Window * window); void photon_showwindow(_THIS, SDL_Window * window); void photon_hidewindow(_THIS, SDL_Window * window); void photon_raisewindow(_THIS, SDL_Window * window); void photon_maximizewindow(_THIS, SDL_Window * window); void photon_minimizewindow(_THIS, SDL_Window * window); void photon_restorewindow(_THIS, SDL_Window * window); void photon_setwindowgrab(_THIS, SDL_Window * window); void photon_destroywindow(_THIS, SDL_Window * window); /* Window manager function */ SDL_bool photon_getwindowwminfo(_THIS, SDL_Window * window, struct SDL_SysWMinfo *info); /* OpenGL/OpenGL ES functions */ int photon_gl_loadlibrary(_THIS, const char *path); void *photon_gl_getprocaddres(_THIS, const char *proc); void photon_gl_unloadlibrary(_THIS); SDL_GLContext photon_gl_createcontext(_THIS, SDL_Window * window); int photon_gl_makecurrent(_THIS, SDL_Window * window, SDL_GLContext context); int photon_gl_setswapinterval(_THIS, int interval); int photon_gl_getswapinterval(_THIS); void photon_gl_swapwindow(_THIS, SDL_Window * window); void photon_gl_deletecontext(_THIS, SDL_GLContext context); /* Helper function, which re-creates surface, not an API */ int photon_gl_recreatesurface(_THIS, SDL_Window * window, uint32_t width, uint32_t height); /* Event handling function */ void photon_pumpevents(_THIS); /* Screen saver related function */ void photon_suspendscreensaver(_THIS); #endif /* __SDL_PHOTON_H__ */ /* vi: set ts=4 sw=4 expandtab: */