annotate src/video/SDL_shape_internals.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 14870d46ee2d
children
rev   line source
4814
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
1 /*
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
2 SDL - Simple DirectMedia Layer
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
3 Copyright (C) 2010 Eli Gottlieb
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
4
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
5 This library is free software; you can redistribute it and/or
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
6 modify it under the terms of the GNU Lesser General Public
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
7 License as published by the Free Software Foundation; either
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
8 version 2.1 of the License, or (at your option) any later version.
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
9
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
10 This library is distributed in the hope that it will be useful,
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
13 Lesser General Public License for more details.
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
14
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
15 You should have received a copy of the GNU Lesser General Public
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
16 License along with this library; if not, write to the Free Software
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
18
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
19 Eli Gottlieb
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
20 eligottlieb@gmail.com
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
21 */
4817
c68e7490e4cf Fixed a couple of bugs in the general and X11 shape code, and fixed a bug in testshape that was keeping it from recognizing surfaces without alpha. Thanks to Andreas's bit-bashing tip, X11 shaped windows now work entirely, AFAICT.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4814
diff changeset
22 #include "SDL_config.h"
4814
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
23
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
24 #ifndef _SDL_shape_internals_h
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
25 #define _SDL_shape_internals_h
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
26
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
27 #include "SDL_rect.h"
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
28 #include "SDL_shape.h"
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
29 #include "SDL_surface.h"
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
30
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
31 #include "begin_code.h"
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
32 /* Set up for C function definitions, even when using C++ */
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
33 #ifdef __cplusplus
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
34 /* *INDENT-OFF* */
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
35 extern "C" {
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
36 /* *INDENT-ON* */
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
37 #endif
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
38
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
39 typedef struct {
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
40 struct SDL_ShapeTree *upleft,*upright,*downleft,*downright;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
41 } SDL_QuadTreeChildren;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
42
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
43 typedef union {
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
44 SDL_QuadTreeChildren children;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
45 SDL_Rect shape;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
46 } SDL_ShapeUnion;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
47
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
48 typedef enum { QuadShape,TransparentShape,OpaqueShape } SDL_ShapeKind;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
49
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
50 typedef struct {
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
51 SDL_ShapeKind kind;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
52 SDL_ShapeUnion data;
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
53 } SDL_ShapeTree;
4830
3dfe779900f5 Compiling for cocoa now works. Does it run? We'll see.
egottlieb
parents: 4817
diff changeset
54
3dfe779900f5 Compiling for cocoa now works. Does it run? We'll see.
egottlieb
parents: 4817
diff changeset
55 typedef void(*SDL_TraversalFunction)(SDL_ShapeTree*,void*);
4814
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
56
4817
c68e7490e4cf Fixed a couple of bugs in the general and X11 shape code, and fixed a bug in testshape that was keeping it from recognizing surfaces without alpha. Thanks to Andreas's bit-bashing tip, X11 shaped windows now work entirely, AFAICT.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4814
diff changeset
57 extern void SDL_CalculateShapeBitmap(SDL_WindowShapeMode mode,SDL_Surface *shape,Uint8* bitmap,Uint8 ppb);
4837
2e446923c9fb Fixed lots of little bugs in Win32 shaping and in SDL_CalculateShapeTree(). Still not actually showing anything on Windows, though there's no crashes and everything compiles fine. Bugger.
egottlieb
parents: 4830
diff changeset
58 extern SDL_ShapeTree* SDL_CalculateShapeTree(SDL_WindowShapeMode mode,SDL_Surface* shape);
4830
3dfe779900f5 Compiling for cocoa now works. Does it run? We'll see.
egottlieb
parents: 4817
diff changeset
59 extern void SDL_TraverseShapeTree(SDL_ShapeTree *tree,SDL_TraversalFunction function,void* closure);
4850
14870d46ee2d Mostly seem to have fixed SDL_CalculateShapeTree. Mostly. There still seem to be some rendering artifacts, stepping effects, and such on Windows -- which indicates subtle logic errors in SDL_CalculateShapeTree().
egottlieb
parents: 4837
diff changeset
60 extern void SDL_FreeShapeTree(SDL_ShapeTree** shape_tree);
4814
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
61
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
62 /* Ends C function definitions when using C++ */
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
63 #ifdef __cplusplus
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
64 /* *INDENT-OFF* */
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
65 }
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
66 /* *INDENT-ON* */
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
67 #endif
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
68 #include "close_code.h"
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
69
4f7133445367 Added the header to the repo. Oops.
Eli Gottlieb <eligottlieb@gmail.com>
parents:
diff changeset
70 #endif