swrast: use ASSIGN_4V() macro
[mesa.git] / src / mesa / swrast / swrast.h
index f3820a68b88741dccffdd1685a073cd14d37db18..047f7991e645ce4a96bb60bc314530d33dff279a 100644 (file)
@@ -1,8 +1,8 @@
 /*
  * Mesa 3-D graphics library
- * Version:  3.5
+ * Version:  6.5
  *
- * Copyright (C) 1999  Brian Paul   All Rights Reserved.
+ * Copyright (C) 1999-2006  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"),
  * 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:
- *    Keith Whitwell <keithw@valinux.com>
+ */
+
+/**
+ * \file swrast/swrast.h
+ * \brief Public interface to the software rasterization functions.
+ * \author Keith Whitwell <keith@tungstengraphics.com>
  */
 
 #ifndef SWRAST_H
 #define SWRAST_H
 
-#include "mtypes.h"
-
-
+#include "main/mtypes.h"
 
-/* The software rasterizer now uses this format for vertices.  Thus a
+/**
+ * \struct SWvertex
+ * \brief Data-structure to handle vertices in the software rasterizer.
+ * 
+ * The software rasterizer now uses this format for vertices.  Thus a
  * 'RasterSetup' stage or other translation is required between the
  * tnl module and the swrast rasterization functions.  This serves to
  * isolate the swrast module from the internals of the tnl module, and
  * improve its usefulness as a fallback mechanism for hardware
  * drivers.
  *
+ * wpos = attr[FRAG_ATTRIB_WPOS] and MUST BE THE FIRST values in the
+ * vertex because of the tnl clipping code.
+
+ * wpos[0] and [1] are the screen-coords of SWvertex.
+ * wpos[2] is the z-buffer coord (if 16-bit Z buffer, in range [0,65535]).
+ * wpos[3] is 1/w where w is the clip-space W coord.  This is the value
+ * that clip{XYZ} were multiplied by to get ndc{XYZ}.
+ *
  * Full software drivers:
  *   - Register the rastersetup and triangle functions from
  *     utils/software_helper.
  *     primitives unaccelerated), hook in swrast_setup instead.
  */
 typedef struct {
-   GLfloat win[4];
-   GLfloat texcoord[MAX_TEXTURE_UNITS][4];
-   GLchan color[4];
-   GLchan specular[4];
-   GLfloat fog;
-   GLuint index;
+   GLfloat attrib[FRAG_ATTRIB_MAX][4];
+   GLchan color[4];   /** integer color */
    GLfloat pointSize;
 } SWvertex;
 
 
+#define FRAG_ATTRIB_CI FRAG_ATTRIB_COL0
+
+
+struct swrast_device_driver;
 
 
 /* These are the public-access functions exported from swrast.
  */
-extern void
-_swrast_alloc_buffers( GLcontext *ctx );
 
 extern GLboolean
 _swrast_CreateContext( GLcontext *ctx );
@@ -78,7 +90,10 @@ _swrast_CreateContext( GLcontext *ctx );
 extern void
 _swrast_DestroyContext( GLcontext *ctx );
 
-
+/* Get a (non-const) reference to the device driver struct for swrast.
+ */
+extern struct swrast_device_driver *
+_swrast_GetDeviceDriverReference( GLcontext *ctx );
 
 extern void
 _swrast_Bitmap( GLcontext *ctx,
@@ -110,23 +125,35 @@ _swrast_ReadPixels( GLcontext *ctx,
                    GLvoid *pixels );
 
 extern void
-_swrast_Clear( GLcontext *ctx, GLbitfield mask, GLboolean all,
-              GLint x, GLint y, GLint width, GLint height );
+_swrast_BlitFramebuffer(GLcontext *ctx,
+                        GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
+                        GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
+                        GLbitfield mask, GLenum filter);
 
 extern void
-_swrast_Accum( GLcontext *ctx, GLenum op,
-              GLfloat value, GLint xpos, GLint ypos,
-              GLint width, GLint height );
+_swrast_Clear(GLcontext *ctx, GLbitfield buffers);
 
+extern void
+_swrast_Accum(GLcontext *ctx, GLenum op, GLfloat value);
 
-/* Get a pointer to the stipple counter.
+
+
+/* Reset the stipple counter
  */
-extern GLuint *
-_swrast_get_stipple_counter_ref( GLcontext *ctx );
+extern void
+_swrast_ResetLineStipple( GLcontext *ctx );
 
+/**
+ * Indicates front/back facing for subsequent points/lines when drawing
+ * unfilled polygons.  Needed for two-side stencil.
+ */
+extern void
+_swrast_SetFacing(GLcontext *ctx, GLuint facing);
 
 /* These will always render the correct point/line/triangle for the
  * current state.
+ *
+ * For flatshaded primitives, the provoking vertex is the final one.
  */
 extern void
 _swrast_Point( GLcontext *ctx, const SWvertex *v );
@@ -146,11 +173,19 @@ _swrast_Quad( GLcontext *ctx,
 extern void
 _swrast_flush( GLcontext *ctx );
 
+extern void
+_swrast_render_primitive( GLcontext *ctx, GLenum mode );
+
+extern void
+_swrast_render_start( GLcontext *ctx );
+
+extern void
+_swrast_render_finish( GLcontext *ctx );
 
 /* Tell the software rasterizer about core state changes.
  */
 extern void
-_swrast_InvalidateState( GLcontext *ctx, GLuint new_state );
+_swrast_InvalidateState( GLcontext *ctx, GLbitfield new_state );
 
 /* Configure software rasterizer to match hardware rasterizer characteristics:
  */
@@ -160,4 +195,98 @@ _swrast_allow_vertex_fog( GLcontext *ctx, GLboolean value );
 extern void
 _swrast_allow_pixel_fog( GLcontext *ctx, GLboolean value );
 
+/* Debug:
+ */
+extern void
+_swrast_print_vertex( GLcontext *ctx, const SWvertex *v );
+
+
+/*
+ * Imaging fallbacks (a better solution should be found, perhaps
+ * moving all the imaging fallback code to a new module) 
+ */
+extern void
+_swrast_CopyConvolutionFilter2D(GLcontext *ctx, GLenum target, 
+                               GLenum internalFormat, 
+                               GLint x, GLint y, GLsizei width, 
+                               GLsizei height);
+extern void
+_swrast_CopyConvolutionFilter1D(GLcontext *ctx, GLenum target, 
+                               GLenum internalFormat, 
+                               GLint x, GLint y, GLsizei width);
+extern void
+_swrast_CopyColorSubTable( GLcontext *ctx,GLenum target, GLsizei start,
+                          GLint x, GLint y, GLsizei width);
+extern void
+_swrast_CopyColorTable( GLcontext *ctx, 
+                       GLenum target, GLenum internalformat,
+                       GLint x, GLint y, GLsizei width);
+
+
+/*
+ * Texture fallbacks.  Could also live in a new module
+ * with the rest of the texture store fallbacks?
+ */
+extern void
+_swrast_copy_teximage1d(GLcontext *ctx, GLenum target, GLint level,
+                        GLenum internalFormat,
+                        GLint x, GLint y, GLsizei width, GLint border);
+
+extern void
+_swrast_copy_teximage2d(GLcontext *ctx, GLenum target, GLint level,
+                        GLenum internalFormat,
+                        GLint x, GLint y, GLsizei width, GLsizei height,
+                        GLint border);
+
+
+extern void
+_swrast_copy_texsubimage1d(GLcontext *ctx, GLenum target, GLint level,
+                           GLint xoffset, GLint x, GLint y, GLsizei width);
+
+extern void
+_swrast_copy_texsubimage2d(GLcontext *ctx,
+                           GLenum target, GLint level,
+                           GLint xoffset, GLint yoffset,
+                           GLint x, GLint y, GLsizei width, GLsizei height);
+
+extern void
+_swrast_copy_texsubimage3d(GLcontext *ctx,
+                           GLenum target, GLint level,
+                           GLint xoffset, GLint yoffset, GLint zoffset,
+                           GLint x, GLint y, GLsizei width, GLsizei height);
+
+
+extern void
+_swrast_eject_texture_images(GLcontext *ctx);
+
+
+#if FEATURE_MESA_program_debug
+extern void
+_swrast_get_program_register(GLcontext *, enum register_file file,
+                             GLuint index, GLfloat val[4]);
+#endif /* FEATURE_MESA_program_debug */
+
+
+/**
+ * The driver interface for the software rasterizer.
+ * XXX this may go away.
+ * We may move these functions to ctx->Driver.RenderStart, RenderEnd.
+ */
+struct swrast_device_driver {
+   /*
+    * These are called before and after accessing renderbuffers during
+    * software rasterization.
+    *
+    * These are a suitable place for grabbing/releasing hardware locks.
+    *
+    * NOTE: The swrast triangle/line/point routines *DO NOT* call
+    * these functions.  Locking in that case must be organized by the
+    * driver by other mechanisms.
+    */
+   void (*SpanRenderStart)(GLcontext *ctx);
+   void (*SpanRenderFinish)(GLcontext *ctx);
+};
+
+
+
 #endif