diff options
author | Brian Paul <brian.paul@tungstengraphics.com> | 2004-09-10 00:45:12 +0000 |
---|---|---|
committer | Brian Paul <brian.paul@tungstengraphics.com> | 2004-09-10 00:45:12 +0000 |
commit | 253204f9f0a1942a65e45d876f8d5f16d1a196a1 (patch) | |
tree | 0df0d502ad53bae86b479dbedd2b5bf9789d6878 /src | |
parent | 7e5c452efbee3f4df406d3c702e25c1d02285971 (diff) |
More updates for Doxygen.
Diffstat (limited to 'src')
-rw-r--r-- | src/mesa/glapi/glapi.h | 23 | ||||
-rw-r--r-- | src/mesa/main/context.c | 29 | ||||
-rw-r--r-- | src/mesa/shader/program.h | 12 | ||||
-rw-r--r-- | src/mesa/swrast/s_context.h | 11 |
4 files changed, 58 insertions, 17 deletions
diff --git a/src/mesa/glapi/glapi.h b/src/mesa/glapi/glapi.h index 41d7aaf0287..32cd2c812ad 100644 --- a/src/mesa/glapi/glapi.h +++ b/src/mesa/glapi/glapi.h @@ -1,9 +1,8 @@ - /* * Mesa 3-D graphics library - * Version: 3.5 + * Version: 6.2 * - * Copyright (C) 1999-2001 Brian Paul All Rights Reserved. + * Copyright (C) 1999-2004 Brian Paul All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), @@ -24,6 +23,24 @@ */ +/** + * \mainpage Mesa GL API Module + * + * \section GLAPIIntroduction Introduction + * + * The Mesa GL API module is responsible for dispatching all the + * gl*() functions. All GL functions are dispatched by jumping through + * the current dispatch table (basically a struct full of function + * pointers.) + * + * A per-thread current dispatch table and per-thread current context + * pointer are managed by this module too. + * + * This module is intended to be non-Mesa-specific so it can be used + * with the X/DRI libGL also. + */ + + #ifndef _GLAPI_H #define _GLAPI_H diff --git a/src/mesa/main/context.c b/src/mesa/main/context.c index 9cb54e41aa0..96c436971b1 100644 --- a/src/mesa/main/context.c +++ b/src/mesa/main/context.c @@ -30,18 +30,23 @@ /** - * \mainpage Mesa Core Module - * - * \section CoreIntroduction Introduction - * - * The Mesa core module consists of all the top-level files in the src - * directory. The core module basically takes care of API dispatch, - * and OpenGL state management. - * - * For example, calls to glPolygonMode() are routed to _mesa_PolygonMode() - * which updates the state related to polygonmode. Furthermore, dirty - * state flags related to polygon mode are set and if the device driver - * implements a special routine for PolygonMode, it will be called. + * \mainpage Mesa Main Module + * + * \section MainIntroduction Introduction + * + * The Mesa Main module consists of all the files in the main/ directory. + * Among the features of this module are: + * <UL> + * <LI> Structures to represent most GL state </LI> + * <LI> State set/get functions </LI> + * <LI> Display lists </LI> + * <LI> Texture unit, object and image handling </LI> + * <LI> Matrix and attribute stacks </LI> + * </UL> + * + * Other modules are responsible for API dispatch, vertex transformation, + * point/line/triangle setup, rasterization, vertex array caching, + * vertex/fragment programs/shaders, etc. * * * \section AboutDoxygen About Doxygen diff --git a/src/mesa/shader/program.h b/src/mesa/shader/program.h index 48e09015010..fb99a79cf6b 100644 --- a/src/mesa/shader/program.h +++ b/src/mesa/shader/program.h @@ -1,8 +1,8 @@ /* * Mesa 3-D graphics library - * Version: 5.1 + * Version: 6.2 * - * Copyright (C) 1999-2003 Brian Paul All Rights Reserved. + * Copyright (C) 1999-2004 Brian Paul All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), @@ -29,6 +29,14 @@ */ +/** + * \mainpage Mesa vertex and fragment program module + * + * This module or directory contains most of the code for vertex and + * fragment programs and shaders, including state management, parsers, + * and (some) software routines for executing programs + */ + #ifndef PROGRAM_H #define PROGRAM_H diff --git a/src/mesa/swrast/s_context.h b/src/mesa/swrast/s_context.h index 9d14c89bd60..ea877a4bd25 100644 --- a/src/mesa/swrast/s_context.h +++ b/src/mesa/swrast/s_context.h @@ -29,6 +29,17 @@ * \author Keith Whitwell <keith@tungstengraphics.com> */ +/** + * \mainpage swrast module + * + * This module, software rasterization, contains the software fallback + * routines for drawing points, lines, triangles, bitmaps and images. + * All rendering boils down to writing spans (arrays) of pixels with + * particular colors. The span-writing routines must be implemented + * by the device driver. + */ + + #ifndef S_CONTEXT_H #define S_CONTEXT_H |