docs: update rasterizer for ccw changes
authorKeith Whitwell <keithw@vmware.com>
Fri, 21 May 2010 14:38:48 +0000 (15:38 +0100)
committerKeith Whitwell <keithw@vmware.com>
Fri, 21 May 2010 14:40:36 +0000 (15:40 +0100)
Also rearrange some of the fields into point/line/polygon categories.

src/gallium/docs/source/cso/rasterizer.rst

index 56a601a8d06470a6f6f7e0b5075849566c0a9c8f..ad1612f93e31e104826a8c5ed8b0cae8418e7d20 100644 (file)
@@ -46,6 +46,78 @@ There are several important exceptions to the specification of this rule.
   second vertex, not the first. This permits each segment of the fan to have
   a different color.
 
+Polygons
+--------
+
+light_twoside
+^^^^^^^^^^^^^
+
+If set, there are per-vertex back-facing colors.  The hardware
+(perhaps assisted by :ref:`Draw`) should be set up to use this state
+along with the front/back information to set the final vertex colors
+prior to rasterization.
+
+The frontface vertex shader color output is marked with TGSI semantic
+COLOR[0], and backface COLOR[1].
+
+front_ccw
+    Indicates whether the window order of front-facing polygons is
+    counter-clockwise (TRUE) or clockwise (FALSE).
+
+cull_mode
+    Indicates which faces of polygons to cull, either PIPE_FACE_NONE
+    (cull no polygons), PIPE_FACE_FRONT (cull front-facing polygons),
+    PIPE_FACE_BACK (cull back-facing polygons), or
+    PIPE_FACE_FRONT_AND_BACK (cull all polygons).
+
+fill_front
+    Indicates how to fill front-facing polygons, either
+    PIPE_POLYGON_MODE_FILL, PIPE_POLYGON_MODE_LINE or
+    PIPE_POLYGON_MODE_POINT.
+fill_back
+    Indicates how to fill back-facing polygons, either
+    PIPE_POLYGON_MODE_FILL, PIPE_POLYGON_MODE_LINE or
+    PIPE_POLYGON_MODE_POINT.
+
+poly_stipple_enable
+    Whether polygon stippling is enabled.
+poly_smooth
+    Controls OpenGL-style polygon smoothing/antialiasing
+
+offset_point
+    If set, point-filled polygons will have polygon offset factors applied
+offset_line
+    If set, line-filled polygons will have polygon offset factors applied
+offset_tri
+    If set, filled polygons will have polygon offset factors applied
+
+offset_units
+    Specifies the polygon offset bias
+offset_scale
+    Specifies the polygon offset scale
+
+
+
+Lines
+-----
+
+line_width
+    The width of lines.
+line_smooth
+    Whether lines should be smoothed. Line smoothing is simply anti-aliasing.
+line_stipple_enable
+    Whether line stippling is enabled.
+line_stipple_pattern
+    16-bit bitfield of on/off flags, used to pattern the line stipple.
+line_stipple_factor
+    When drawing a stippled line, each bit in the stipple pattern is
+    repeated N times, where N = line_stipple_factor + 1.
+line_last_pixel
+    Controls whether the last pixel in a line is drawn or not.  OpenGL
+    omits the last pixel to avoid double-drawing pixels at the ends of lines
+    when drawing connected lines.
+
+
 Points
 ------
 
@@ -89,68 +161,21 @@ coordinates are not generated.
    Some renderers always internally translate points into quads; this state
    still affects those renderers by overriding other rasterization state.
 
-Other Members
-^^^^^^^^^^^^^
-
-light_twoside
-    If set, there are per-vertex back-facing colors. :ref:`Draw`
-    uses this state along with the front/back information to set the
-    final vertex colors prior to rasterization.
-
-front_winding
-    Indicates the window order of front-facing polygons, either
-    PIPE_WINDING_CW or PIPE_WINDING_CCW
-
-cull_mode
-    Indicates which polygons to cull, either PIPE_WINDING_NONE (cull no
-    polygons), PIPE_WINDING_CW (cull clockwise-winding polygons),
-    PIPE_WINDING_CCW (cull counter clockwise-winding polygons), or
-    PIPE_WINDING_BOTH (cull all polygons).
-
-fill_cw
-    Indicates how to fill clockwise polygons, either PIPE_POLYGON_MODE_FILL,
-    PIPE_POLYGON_MODE_LINE or PIPE_POLYGON_MODE_POINT.
-fill_ccw
-    Indicates how to fill counter clockwise polygons, either
-    PIPE_POLYGON_MODE_FILL, PIPE_POLYGON_MODE_LINE or PIPE_POLYGON_MODE_POINT.
-
-poly_stipple_enable
-    Whether polygon stippling is enabled.
-poly_smooth
-    Controls OpenGL-style polygon smoothing/antialiasing
-offset_cw
-    If set, clockwise polygons will have polygon offset factors applied
-offset_ccw
-    If set, counter clockwise polygons will have polygon offset factors applied
-offset_units
-    Specifies the polygon offset bias
-offset_scale
-    Specifies the polygon offset scale
-
-line_width
-    The width of lines.
-line_smooth
-    Whether lines should be smoothed. Line smoothing is simply anti-aliasing.
-line_stipple_enable
-    Whether line stippling is enabled.
-line_stipple_pattern
-    16-bit bitfield of on/off flags, used to pattern the line stipple.
-line_stipple_factor
-    When drawing a stippled line, each bit in the stipple pattern is
-    repeated N times, where N = line_stipple_factor + 1.
-line_last_pixel
-    Controls whether the last pixel in a line is drawn or not.  OpenGL
-    omits the last pixel to avoid double-drawing pixels at the ends of lines
-    when drawing connected lines.
-
 point_smooth
     Whether points should be smoothed. Point smoothing turns rectangular
     points into circles or ovals.
 point_size_per_vertex
-    Whether vertices have a point size element.
+    Whether the vertex shader is expected to have a point size output.
+    Undefined behaviour is permitted if there is disagreement between
+    this flag and the actual bound shader.
 point_size
     The size of points, if not specified per-vertex.
 
+
+
+Other Members
+-------------
+
 scissor
     Whether the scissor test is enabled.