src/gallium/auxiliary/draw/draw_pipe_cull.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * \brief  Drawing stage for polygon culling
  30  */
  31
  32 /* Authors:  Keith Whitwell <keith@tungstengraphics.com>
  33  */
  34
  35
  36 #include "util/u_math.h"
  37 #include "util/u_memory.h"
  38 #include "pipe/p_defines.h"
  39 #include "draw_pipe.h"
  40
  41
  42 struct cull_stage {
  43    struct draw_stage stage;
  44    unsigned cull_face;  /**< which face(s) to cull (one of PIPE_FACE_x) */
  45    unsigned front_ccw;
  46 };
  47
  48
  49 static INLINE struct cull_stage *cull_stage( struct draw_stage *stage )
  50 {
  51    return (struct cull_stage *)stage;
  52 }
  53
  54 static INLINE
  55 boolean cull_distance_is_out(float dist)
  56 {
  57    return (dist < 0) || util_is_inf_or_nan(dist);
  58 }
  59
  60 /*
  61  * If the shader writes the culldistance then we can
  62  * perform distance based culling. Distance based
  63  * culling doesn't require a face and can be performed
  64  * on primitives without faces (e.g. points and lines)
  65  */
  66 static void cull_point( struct draw_stage *stage,
  67                         struct prim_header *header )
  68 {
  69    const unsigned num_written_culldistances =
  70       draw_current_shader_num_written_culldistances(stage->draw);
  71
  72    if (num_written_culldistances) {
  73       unsigned i;
  74       boolean culled = FALSE;
  75       for (i = 0; i < num_written_culldistances; ++i) {
  76          unsigned cull_idx = i / 4;
  77          unsigned out_idx =
  78             draw_current_shader_culldistance_output(stage->draw, cull_idx);
  79          unsigned idx = i % 4;
  80          float cull1 = header->v[0]->data[out_idx][idx];
  81          boolean vert1_out = cull_distance_is_out(cull1);
  82          if (vert1_out)
  83             culled = TRUE;
  84       }
  85       if (!culled)
  86          stage->next->point( stage->next, header );
  87    }
  88 }
  89
  90 /*
  91  * If the shader writes the culldistance then we can
  92  * perform distance based culling. Distance based
  93  * culling doesn't require a face and can be performed
  94  * on primitives without faces (e.g. points and lines)
  95  */
  96 static void cull_line( struct draw_stage *stage,
  97                       struct prim_header *header )
  98 {
  99    const unsigned num_written_culldistances =
 100       draw_current_shader_num_written_culldistances(stage->draw);
 101
 102    if (num_written_culldistances) {
 103       unsigned i;
 104       boolean culled = FALSE;
 105       for (i = 0; i < num_written_culldistances; ++i) {
 106          unsigned cull_idx = i / 4;
 107          unsigned out_idx =
 108             draw_current_shader_culldistance_output(stage->draw, cull_idx);
 109          unsigned idx = i % 4;
 110          float cull1 = header->v[0]->data[out_idx][idx];
 111          float cull2 = header->v[1]->data[out_idx][idx];
 112          boolean vert1_out = cull_distance_is_out(cull1);
 113          boolean vert2_out = cull_distance_is_out(cull2);
 114          if (vert1_out && vert2_out)
 115             culled = TRUE;
 116       }
 117       if (!culled)
 118          stage->next->line( stage->next, header );
 119    }
 120 }
 121
 122 /*
 123  * Triangles can be culled either using the cull distance
 124  * shader outputs or the regular face culling. If required
 125  * this function performs both, starting with distance culling.
 126  */
 127 static void cull_tri( struct draw_stage *stage,
 128                       struct prim_header *header )
 129 {
 130    const unsigned num_written_culldistances =
 131       draw_current_shader_num_written_culldistances(stage->draw);
 132
 133    /* Do the distance culling */
 134    if (num_written_culldistances) {
 135       unsigned i;
 136       boolean culled = FALSE;
 137       for (i = 0; i < num_written_culldistances; ++i) {
 138          unsigned cull_idx = i / 4;
 139          unsigned out_idx =
 140             draw_current_shader_culldistance_output(stage->draw, cull_idx);
 141          unsigned idx = i % 4;
 142          float cull1 = header->v[0]->data[out_idx][idx];
 143          float cull2 = header->v[1]->data[out_idx][idx];
 144          float cull3 = header->v[2]->data[out_idx][idx];
 145          boolean vert1_out = cull_distance_is_out(cull1);
 146          boolean vert2_out = cull_distance_is_out(cull2);
 147          boolean vert3_out = cull_distance_is_out(cull3);
 148          if (vert1_out && vert2_out && vert3_out)
 149             culled = TRUE;
 150       }
 151       if (!culled)
 152          stage->next->tri( stage->next, header );
 153    }
 154
 155    /* Do the regular face culling */
 156    {
 157       const unsigned pos = draw_current_shader_position_output(stage->draw);
 158       /* Window coords: */
 159       const float *v0 = header->v[0]->data[pos];
 160       const float *v1 = header->v[1]->data[pos];
 161       const float *v2 = header->v[2]->data[pos];
 162
 163       /* edge vectors: e = v0 - v2, f = v1 - v2 */
 164       const float ex = v0[0] - v2[0];
 165       const float ey = v0[1] - v2[1];
 166       const float fx = v1[0] - v2[0];
 167       const float fy = v1[1] - v2[1];
 168
 169
 170       /* det = cross(e,f).z */
 171       header->det = ex * fy - ey * fx;
 172
 173       if (header->det != 0) {
 174          /* if det < 0 then Z points toward the camera and the triangle is
 175           * counter-clockwise winding.
 176           */
 177          unsigned ccw = (header->det < 0);
 178          unsigned face = ((ccw == cull_stage(stage)->front_ccw) ?
 179                           PIPE_FACE_FRONT :
 180                           PIPE_FACE_BACK);
 181
 182          if ((face & cull_stage(stage)->cull_face) == 0) {
 183             /* triangle is not culled, pass to next stage */
 184             stage->next->tri( stage->next, header );
 185          }
 186       }
 187    }
 188 }
 189
 190 static void cull_first_point( struct draw_stage *stage,
 191                               struct prim_header *header )
 192 {
 193    const unsigned num_written_culldistances =
 194       draw_current_shader_num_written_culldistances(stage->draw);
 195
 196    if (num_written_culldistances) {
 197       stage->point = cull_point;
 198       stage->point( stage, header );
 199    } else {
 200       stage->point = draw_pipe_passthrough_point;
 201       stage->point( stage, header );
 202    }
 203 }
 204
 205 static void cull_first_line( struct draw_stage *stage,
 206                             struct prim_header *header )
 207 {
 208    const unsigned num_written_culldistances =
 209       draw_current_shader_num_written_culldistances(stage->draw);
 210
 211    if (num_written_culldistances) {
 212       stage->line = cull_line;
 213       stage->line( stage, header );
 214    } else {
 215       stage->line = draw_pipe_passthrough_line;
 216       stage->line( stage, header );
 217    }
 218 }
 219
 220 static void cull_first_tri( struct draw_stage *stage,
 221                             struct prim_header *header )
 222 {
 223    struct cull_stage *cull = cull_stage(stage);
 224
 225    cull->cull_face = stage->draw->rasterizer->cull_face;
 226    cull->front_ccw = stage->draw->rasterizer->front_ccw;
 227
 228    stage->tri = cull_tri;
 229    stage->tri( stage, header );
 230 }
 231
 232
 233 static void cull_flush( struct draw_stage *stage, unsigned flags )
 234 {
 235    stage->point = cull_first_point;
 236    stage->line = cull_first_line;
 237    stage->tri = cull_first_tri;
 238    stage->next->flush( stage->next, flags );
 239 }
 240
 241
 242 static void cull_reset_stipple_counter( struct draw_stage *stage )
 243 {
 244    stage->next->reset_stipple_counter( stage->next );
 245 }
 246
 247
 248 static void cull_destroy( struct draw_stage *stage )
 249 {
 250    draw_free_temp_verts( stage );
 251    FREE( stage );
 252 }
 253
 254
 255 /**
 256  * Create a new polygon culling stage.
 257  */
 258 struct draw_stage *draw_cull_stage( struct draw_context *draw )
 259 {
 260    struct cull_stage *cull = CALLOC_STRUCT(cull_stage);
 261    if (cull == NULL)
 262       goto fail;
 263
 264    cull->stage.draw = draw;
 265    cull->stage.name = "cull";
 266    cull->stage.next = NULL;
 267    cull->stage.point = cull_first_point;
 268    cull->stage.line = cull_first_line;
 269    cull->stage.tri = cull_first_tri;
 270    cull->stage.flush = cull_flush;
 271    cull->stage.reset_stipple_counter = cull_reset_stipple_counter;
 272    cull->stage.destroy = cull_destroy;
 273
 274    if (!draw_alloc_temp_verts( &cull->stage, 0 ))
 275       goto fail;
 276
 277    return &cull->stage;
 278
 279 fail:
 280    if (cull)
 281       cull->stage.destroy( &cull->stage );
 282
 283    return NULL;
 284 }