Fix typo
[mesa.git] / src / mesa / swrast / swrast.h
index 4e8627e695595b2e611bcd77076863742f8fe859..94b564d78e8b33a4ccd35c5c6f418b463b01d890 100644 (file)
+/*
+ * Mesa 3-D graphics library
+ * Version:  3.5
+ *
+ * Copyright (C) 1999  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.
+ *
+ * Authors:
+ *    Keith Whitwell <keithw@valinux.com>
+ */
+
 #ifndef SWRAST_H
 #define SWRAST_H
 
-#include "types.h"
+#include "mtypes.h"
+
+
+
+/* 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.
+ *
+ * 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 win[4];
+   GLfloat texcoord[MAX_TEXTURE_UNITS][4];
+   GLchan color[4];
+   GLchan specular[4];
+   GLfloat fog;
+   GLuint index;
+   GLfloat pointSize;
+} SWvertex;
+
+
+
 
-/* These are the functions exported from swrast.  (more to come)
+/* These are the public-access functions exported from swrast.
  */
-void
+extern void
 _swrast_alloc_buffers( GLcontext *ctx );
 
+extern GLboolean
+_swrast_CreateContext( GLcontext *ctx );
 
-void 
-_swrast_Bitmap( GLcontext *ctx, 
+extern void
+_swrast_DestroyContext( 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 
+extern void
 _swrast_Clear( GLcontext *ctx, GLbitfield mask, GLboolean all,
               GLint x, GLint y, GLint width, GLint height );
 
-void
-_swrast_Accum( GLcontext *ctx, GLenum op, 
-              GLfloat value, GLint xpos, GLint ypos, 
+extern void
+_swrast_Accum( GLcontext *ctx, GLenum op,
+              GLfloat value, GLint xpos, GLint ypos,
               GLint width, GLint height );
 
-void 
-_swrast_set_line_function( GLcontext *ctx );
-
-void 
-_swrast_set_point_function( GLcontext *ctx );
-
-void 
-_swrast_set_triangle_function( GLcontext *ctx );
 
-void 
-_swrast_set_quad_function( GLcontext *ctx );
-
-void 
-_swrast_flush( GLcontext *ctx );
-
-GLboolean
-_swrast_create_context( GLcontext *ctx );
-
-void
-_swrast_destroy_context( GLcontext *ctx );
-
-
-/* Replace:
+/* Reset the stipple counter
  */
-void
-_swrast_set_texture_sampler( struct gl_texture_object *t );
+extern void
+_swrast_ResetLineStipple( GLcontext *ctx );
 
+/* 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 );
 
-#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)
+extern void
+_swrast_Triangle( GLcontext *ctx, const SWvertex *v0,
+                  const SWvertex *v1, const SWvertex *v2 );
 
-#define _SWRAST_NEW_LINE (_NEW_RENDERMODE|     \
-                          _NEW_LINE|           \
-                          _NEW_TEXTURE|                \
-                          _NEW_LIGHT|          \
-                          _NEW_FOG|            \
-                          _NEW_DEPTH)
+extern void
+_swrast_Quad( GLcontext *ctx,
+              const SWvertex *v0, const SWvertex *v1,
+             const SWvertex *v2,  const SWvertex *v3);
 
-#define _SWRAST_NEW_POINT (_NEW_RENDERMODE |   \
-                          _NEW_POINT |         \
-                          _NEW_TEXTURE |       \
-                          _NEW_LIGHT |         \
-                          _NEW_FOG)
+extern void
+_swrast_flush( GLcontext *ctx );
 
 
+/* Tell the software rasterizer about core state changes.
+ */
+extern void
+_swrast_InvalidateState( GLcontext *ctx, GLuint new_state );
 
+/* Configure software rasterizer to match hardware rasterizer characteristics:
+ */
+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 );
 
 #endif