diff options
| author | Jose Fonseca <jrfonseca@users.sourceforge.net> | 2003-05-27 00:37:33 +0000 |
|---|---|---|
| committer | Jose Fonseca <jrfonseca@users.sourceforge.net> | 2003-05-27 00:37:33 +0000 |
| commit | d2443b2186712dd7c977b47e06444396e1e493ff (patch) | |
| tree | f007726cb80c70438834cb286e51b822ec70a76b /shared/drm_sarea.h | |
| parent | aeb4bc3f5b991d7970dca9417e04df06c0bf008a (diff) | |
Merged DRM documentation.
Diffstat (limited to 'shared/drm_sarea.h')
| -rw-r--r-- | shared/drm_sarea.h | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/shared/drm_sarea.h b/shared/drm_sarea.h index cee48eee..dd3f617a 100644 --- a/shared/drm_sarea.h +++ b/shared/drm_sarea.h @@ -1,5 +1,11 @@ -/* sarea.h -- SAREA definitions -*- linux-c -*- +/** + * \file drm_sarea.h + * \brief SAREA definitions * + * \author Michel Dänzer <michel@daenzer.net> + */ + +/* * Copyright 2002 Tungsten Graphics, Inc., Cedar Park, Texas. * All Rights Reserved. * @@ -21,22 +27,22 @@ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. - * - * Authors: - * Michel Dänzer <michel@daenzer.net> */ #ifndef _DRM_SAREA_H_ #define _DRM_SAREA_H_ +/** Maximum number of drawables in the SAREA */ #define SAREA_MAX_DRAWABLES 256 -typedef struct _drm_sarea_drawable_t { +/** SAREA drawable */ +typedef struct drm_sarea_drawable { unsigned int stamp; unsigned int flags; } drm_sarea_drawable_t; -typedef struct _dri_sarea_frame_t { +/** SAREA frame */ +typedef struct drm_sarea_frame { unsigned int x; unsigned int y; unsigned int width; @@ -44,13 +50,14 @@ typedef struct _dri_sarea_frame_t { unsigned int fullscreen; } drm_sarea_frame_t; -typedef struct _drm_sarea_t { - /* first thing is always the drm locking structure */ +/** SAREA */ +typedef struct drm_sarea { + /** first thing is always the DRM locking structure */ drm_hw_lock_t lock; - /* NOT_DONE: Use readers/writer lock for drawable_lock */ + /** \todo Use readers/writer lock for drm_sarea::drawable_lock */ drm_hw_lock_t drawable_lock; - drm_sarea_drawable_t drawableTable[SAREA_MAX_DRAWABLES]; - drm_sarea_frame_t frame; + drm_sarea_drawable_t drawableTable[SAREA_MAX_DRAWABLES]; /**< drawables */ + drm_sarea_frame_t frame; /**< frame */ drm_context_t dummy_context; } drm_sarea_t; |