swrast: use ASSIGN_4V() macro
[mesa.git] / src / mesa / swrast / swrast.h
index 4e8627e695595b2e611bcd77076863742f8fe859..047f7991e645ce4a96bb60bc314530d33dff279a 100644 (file)
+/*
+ * Mesa 3-D graphics library
+ * Version:  6.5
+ *
+ * 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"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR 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.
+ *
+ */
+
+/**
+ * \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 "types.h"
+#include "main/mtypes.h"
+
+/**
+ * \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.
+ *   - On statechange, update the rasterization pointers in that module.
+ *
+ * Rasterization hardware drivers:
+ *   - Keep native rastersetup.
+ *   - Implement native twoside,offset and unfilled triangle setup.
+ *   - Implement a translator from native vertices to swrast vertices.
+ *   - On partial fallback (mix of accelerated and unaccelerated
+ *   prims), call a pass-through function which translates native
+ *   vertices to SWvertices and calls the appropriate swrast function.
+ *   - On total fallback (vertex format insufficient for state or all
+ *     primitives unaccelerated), hook in swrast_setup instead.
+ */
+typedef struct {
+   GLfloat attrib[FRAG_ATTRIB_MAX][4];
+   GLchan color[4];   /** integer color */
+   GLfloat pointSize;
+} SWvertex;
+
+
+#define FRAG_ATTRIB_CI FRAG_ATTRIB_COL0
+
 
-/* These are the functions exported from swrast.  (more to come)
+struct swrast_device_driver;
+
+
+/* These are the public-access functions exported from swrast.
  */
-void
-_swrast_alloc_buffers( GLcontext *ctx );
 
+extern GLboolean
+_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 );
 
-void 
-_swrast_Bitmap( GLcontext *ctx, 
+extern void
+_swrast_Bitmap( GLcontext *ctx,
                GLint px, GLint py,
                GLsizei width, GLsizei height,
                const struct gl_pixelstore_attrib *unpack,
                const GLubyte *bitmap );
 
-void
-_swrast_CopyPixels( GLcontext *ctx, 
-                   GLint srcx, GLint srcy, 
-                   GLint destx, GLint desty, 
+extern void
+_swrast_CopyPixels( GLcontext *ctx,
+                   GLint srcx, GLint srcy,
+                   GLint destx, GLint desty,
                    GLsizei width, GLsizei height,
                    GLenum type );
 
-void
-_swrast_DrawPixels( GLcontext *ctx, 
+extern void
+_swrast_DrawPixels( GLcontext *ctx,
                    GLint x, GLint y,
                    GLsizei width, GLsizei height,
-                   GLenum format, GLenum type, 
+                   GLenum format, GLenum type,
                    const struct gl_pixelstore_attrib *unpack,
                    const GLvoid *pixels );
 
-void
+extern void
 _swrast_ReadPixels( GLcontext *ctx,
                    GLint x, GLint y, GLsizei width, GLsizei height,
                    GLenum format, GLenum type,
                    const struct gl_pixelstore_attrib *unpack,
                    GLvoid *pixels );
 
-void 
-_swrast_Clear( GLcontext *ctx, GLbitfield mask, GLboolean all,
-              GLint x, GLint y, GLint width, GLint height );
+extern void
+_swrast_BlitFramebuffer(GLcontext *ctx,
+                        GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
+                        GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
+                        GLbitfield mask, GLenum filter);
 
-void
-_swrast_Accum( GLcontext *ctx, GLenum op, 
-              GLfloat value, GLint xpos, GLint ypos, 
-              GLint width, GLint height );
+extern void
+_swrast_Clear(GLcontext *ctx, GLbitfield buffers);
 
-void 
-_swrast_set_line_function( GLcontext *ctx );
+extern void
+_swrast_Accum(GLcontext *ctx, GLenum op, GLfloat value);
 
-void 
-_swrast_set_point_function( GLcontext *ctx );
 
-void 
-_swrast_set_triangle_function( GLcontext *ctx );
 
-void 
-_swrast_set_quad_function( GLcontext *ctx );
+/* Reset the stipple counter
+ */
+extern void
+_swrast_ResetLineStipple( GLcontext *ctx );
 
-void 
+/**
+ * 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 );
+
+extern void
+_swrast_Line( GLcontext *ctx, const SWvertex *v0, const SWvertex *v1 );
+
+extern void
+_swrast_Triangle( GLcontext *ctx, const SWvertex *v0,
+                  const SWvertex *v1, const SWvertex *v2 );
+
+extern void
+_swrast_Quad( GLcontext *ctx,
+              const SWvertex *v0, const SWvertex *v1,
+             const SWvertex *v2,  const SWvertex *v3);
+
+extern void
 _swrast_flush( GLcontext *ctx );
 
-GLboolean
-_swrast_create_context( GLcontext *ctx );
+extern void
+_swrast_render_primitive( GLcontext *ctx, GLenum mode );
+
+extern void
+_swrast_render_start( GLcontext *ctx );
 
-void
-_swrast_destroy_context( GLcontext *ctx );
+extern void
+_swrast_render_finish( GLcontext *ctx );
 
+/* Tell the software rasterizer about core state changes.
+ */
+extern void
+_swrast_InvalidateState( GLcontext *ctx, GLbitfield new_state );
 
-/* Replace:
+/* Configure software rasterizer to match hardware rasterizer characteristics:
  */
-void
-_swrast_set_texture_sampler( struct gl_texture_object *t );
+extern void
+_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 );
 
-#define _SWRAST_NEW_TRIANGLE (_NEW_RENDERMODE|         \
-                              _NEW_POLYGON|            \
-                              _NEW_DEPTH|              \
-                              _NEW_STENCIL|            \
-                              _NEW_COLOR|              \
-                              _NEW_TEXTURE|            \
-                              _NEW_HINT|               \
-                              _SWRAST_NEW_RASTERMASK|  \
-                              _NEW_LIGHT|              \
-                              _NEW_FOG)
 
-#define _SWRAST_NEW_LINE (_NEW_RENDERMODE|     \
-                          _NEW_LINE|           \
-                          _NEW_TEXTURE|                \
-                          _NEW_LIGHT|          \
-                          _NEW_FOG|            \
-                          _NEW_DEPTH)
+/*
+ * 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);
 
-#define _SWRAST_NEW_POINT (_NEW_RENDERMODE |   \
-                          _NEW_POINT |         \
-                          _NEW_TEXTURE |       \
-                          _NEW_LIGHT |         \
-                          _NEW_FOG)
 
+/*
+ * 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);
+};