summaryrefslogtreecommitdiff
path: root/src/mesa/tnl
diff options
context:
space:
mode:
authorBrian Paul <brian.paul@tungstengraphics.com>2003-04-28 14:56:24 +0000
committerBrian Paul <brian.paul@tungstengraphics.com>2003-04-28 14:56:24 +0000
commitc8f2f456f94232671511745e1b236339af6b44ce (patch)
tree3e91921f081296caaf98f248386e2676c8b31d00 /src/mesa/tnl
parentc6506004d4924740b3b6265a688a9c103106af94 (diff)
new comments (Klaus Niederkruger)
Diffstat (limited to 'src/mesa/tnl')
-rw-r--r--src/mesa/tnl/t_context.h47
1 files changed, 37 insertions, 10 deletions
diff --git a/src/mesa/tnl/t_context.h b/src/mesa/tnl/t_context.h
index b7153c545f..5247682e69 100644
--- a/src/mesa/tnl/t_context.h
+++ b/src/mesa/tnl/t_context.h
@@ -1,10 +1,8 @@
-/* $Id: t_context.h,v 1.46 2003/03/31 18:19:56 brianp Exp $ */
-
/*
* Mesa 3-D graphics library
* Version: 5.1
*
- * Copyright (C) 1999-2002 Brian Paul All Rights Reserved.
+ * Copyright (C) 1999-2003 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"),
@@ -30,6 +28,33 @@
* \author Keith Whitwell
*/
+
+/**
+ * \mainpage The TNL-module
+ *
+ * TNL stands for "transform and lighting", i.e. this module implements
+ * a pipeline that receives as input a buffer of vertices and does all
+ * necessary transformations (rotations, clipping, vertex shader etc.)
+ * and passes then the output to the rasterizer.
+ *
+ * The gl_pipeline contains an array of stages. The stages are
+ * black-boxes, which are described by gl_pipeline_stage.
+ * The function _tnl_run_pipeline (in file t_pipeline.c) applies all
+ * the stages to the vertex buffer.
+ * Note that the last stage in the pipeline is the rasterizer.
+ *
+ * _tnl_run_pipeline is called either, when the vertex buffer is full or
+ * when a state change flushes the pipeline.
+ * Note that _tnl_run_pipeline is not called directly but via
+ * tnl_device_driver::RunPipeline, which is stored in TNLcontext::Driver.
+ *
+ * The 'immediate' structure records all the GL commands issued between
+ * glBegin and glEnd. The 'vertex_buffer' structure stores the vertex
+ * data as its passed through the pipeline stages. The initial vertex_buffer
+ * data may either come from the 'immediate' structure or client vertex
+ * arrays or display lists.
+ */
+
#ifndef _T_CONTEXT_H
#define _T_CONTEXT_H
@@ -290,7 +315,7 @@ typedef struct vertex_buffer
-/* Describes an individual operation on the pipeline.
+/** Describes an individual operation on the pipeline.
*/
struct gl_pipeline_stage {
const char *name;
@@ -342,13 +367,15 @@ struct gl_pipeline_stage {
GLboolean (*run)( GLcontext *ctx, struct gl_pipeline_stage * );
};
-
+/** Contains the array of all pipeline stages.
+ * The default values are defined at the end of t_pipeline.c */
struct gl_pipeline {
- GLuint build_state_trigger; /* state changes which require build */
- GLuint build_state_changes; /* state changes since last build */
- GLuint run_state_changes; /* state changes since last run */
- GLuint run_input_changes; /* VERT_* changes since last run */
- GLuint inputs; /* VERT_* inputs to pipeline */
+ GLuint build_state_trigger; /**< state changes which require build */
+ GLuint build_state_changes; /**< state changes since last build */
+ GLuint run_state_changes; /**< state changes since last run */
+ GLuint run_input_changes; /**< VERT_* changes since last run */
+ GLuint inputs; /**< VERT_* inputs to pipeline */
+ /** This array has to end with a NULL-pointer. */
struct gl_pipeline_stage stages[MAX_PIPELINE_STAGES+1];
GLuint nr_stages;
};