src/gallium/auxiliary/draw/draw_pt.h

   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   * Authors:
  30   *   Keith Whitwell <keith@tungstengraphics.com>
  31   */
  32
  33 #ifndef DRAW_PT_H
  34 #define DRAW_PT_H
  35
  36 #include "pipe/p_compiler.h"
  37
  38 typedef unsigned (*pt_elt_func)( const void *elts, unsigned idx );
  39
  40 struct draw_pt_middle_end;
  41 struct draw_context;
  42 struct draw_prim_info;
  43 struct draw_vertex_info;
  44
  45
  46 #define PT_SHADE      0x1
  47 #define PT_CLIPTEST   0x2
  48 #define PT_PIPELINE   0x4
  49 #define PT_MAX_MIDDLE 0x8
  50
  51
  52 /* The "front end" - prepare sets of fetch, draw elements for the
  53  * middle end.
  54  *
  55  * Currenly one version of this:
  56  *    - vcache - catchall implementation, decomposes to TRI/LINE/POINT prims
  57  * Later:
  58  *    - varray, varray_split
  59  *    - velement, velement_split
  60  *
  61  * Currenly only using the vcache version.
  62  */
  63 struct draw_pt_front_end {
  64    void (*prepare)( struct draw_pt_front_end *,
  65                     unsigned prim,
  66                     struct draw_pt_middle_end *,
  67                     unsigned opt );
  68
  69    void (*run)( struct draw_pt_front_end *,
  70                 unsigned start,
  71                 unsigned count );
  72
  73    void (*finish)( struct draw_pt_front_end * );
  74    void (*destroy)( struct draw_pt_front_end * );
  75 };
  76
  77
  78 /* The "middle end" - prepares actual hardware vertices for the
  79  * hardware backend.
  80  *
  81  * prim_flags is as defined by pipe_draw_info::flags.
  82  *
  83  * Currently two versions of this:
  84  *     - fetch, vertex shade, cliptest, prim-pipeline
  85  *     - fetch, emit (ie passthrough)
  86  */
  87 struct draw_pt_middle_end {
  88    void (*prepare)( struct draw_pt_middle_end *,
  89                     unsigned prim,
  90                     unsigned opt,
  91                     unsigned *max_vertices );
  92
  93    void (*run)( struct draw_pt_middle_end *,
  94                 const unsigned *fetch_elts,
  95                 unsigned fetch_count,
  96                 const ushort *draw_elts,
  97                 unsigned draw_count,
  98                 unsigned prim_flags );
  99
 100    void (*run_linear)(struct draw_pt_middle_end *,
 101                       unsigned start,
 102                       unsigned count,
 103                       unsigned prim_flags );
 104
 105    /* Transform all vertices in a linear range and then draw them with
 106     * the supplied element list.  May fail and return FALSE.
 107     */
 108    boolean (*run_linear_elts)( struct draw_pt_middle_end *,
 109                             unsigned fetch_start,
 110                             unsigned fetch_count,
 111                             const ushort *draw_elts,
 112                             unsigned draw_count,
 113                             unsigned prim_flags );
 114
 115    int (*get_max_vertex_count)( struct draw_pt_middle_end * );
 116
 117    void (*finish)( struct draw_pt_middle_end * );
 118    void (*destroy)( struct draw_pt_middle_end * );
 119 };
 120
 121
 122 /* The "back end" - supplied by the driver, defined in draw_vbuf.h.
 123  */
 124 struct vbuf_render;
 125 struct vertex_header;
 126
 127
 128 /* Helper functions.
 129  */
 130 pt_elt_func draw_pt_elt_func( struct draw_context *draw );
 131 const void *draw_pt_elt_ptr( struct draw_context *draw,
 132                              unsigned start );
 133
 134 /* Frontends:
 135  *
 136  * Currently only the general-purpose vcache implementation, could add
 137  * a special case for tiny vertex buffers.
 138  */
 139 struct draw_pt_front_end *draw_pt_vcache( struct draw_context *draw );
 140 struct draw_pt_front_end *draw_pt_varray(struct draw_context *draw);
 141
 142
 143 /* Middle-ends:
 144  *
 145  * Currently one general-purpose case which can do all possibilities,
 146  * at the slight expense of creating a vertex_header in some cases
 147  * unecessarily.
 148  *
 149  * The special case fetch_emit code avoids pipeline vertices
 150  * altogether and builds hardware vertices directly from API
 151  * vertex_elements.
 152  */
 153 struct draw_pt_middle_end *draw_pt_fetch_emit( struct draw_context *draw );
 154 struct draw_pt_middle_end *draw_pt_middle_fse( struct draw_context *draw );
 155 struct draw_pt_middle_end *draw_pt_fetch_pipeline_or_emit(struct draw_context *draw);
 156 struct draw_pt_middle_end *draw_pt_fetch_pipeline_or_emit_llvm(struct draw_context *draw);
 157
 158
 159
 160 /*******************************************************************************
 161  * HW vertex emit:
 162  */
 163 struct pt_emit;
 164
 165 void draw_pt_emit_prepare( struct pt_emit *emit,
 166                            unsigned prim,
 167                            unsigned *max_vertices );
 168
 169 void draw_pt_emit( struct pt_emit *emit,
 170                    const struct draw_vertex_info *vert_info,
 171                    const struct draw_prim_info *prim_info);
 172
 173 void draw_pt_emit_linear( struct pt_emit *emit,
 174                           const struct draw_vertex_info *vert_info,
 175                           const struct draw_prim_info *prim_info);
 176
 177 void draw_pt_emit_destroy( struct pt_emit *emit );
 178
 179 struct pt_emit *draw_pt_emit_create( struct draw_context *draw );
 180
 181 /*******************************************************************************
 182  * HW stream output emit:
 183  */
 184 struct pt_so_emit;
 185
 186 void draw_pt_so_emit_prepare( struct pt_so_emit *emit );
 187
 188 void draw_pt_so_emit( struct pt_so_emit *emit,
 189                       const struct draw_vertex_info *vert_info,
 190                       const struct draw_prim_info *prim_info );
 191
 192 void draw_pt_so_emit_destroy( struct pt_so_emit *emit );
 193
 194 struct pt_so_emit *draw_pt_so_emit_create( struct draw_context *draw );
 195
 196 /*******************************************************************************
 197  * API vertex fetch:
 198  */
 199
 200 struct pt_fetch;
 201 void draw_pt_fetch_prepare( struct pt_fetch *fetch,
 202                             unsigned vertex_input_count,
 203                             unsigned vertex_size,
 204                             unsigned instance_id_index );
 205
 206 void draw_pt_fetch_run( struct pt_fetch *fetch,
 207                         const unsigned *elts,
 208                         unsigned count,
 209                         char *verts );
 210
 211 void draw_pt_fetch_run_linear( struct pt_fetch *fetch,
 212                                unsigned start,
 213                                unsigned count,
 214                                char *verts );
 215
 216 void draw_pt_fetch_destroy( struct pt_fetch *fetch );
 217
 218 struct pt_fetch *draw_pt_fetch_create( struct draw_context *draw );
 219
 220 /*******************************************************************************
 221  * Post-VS: cliptest, rhw, viewport
 222  */
 223 struct pt_post_vs;
 224
 225 boolean draw_pt_post_vs_run( struct pt_post_vs *pvs,
 226                              struct draw_vertex_info *info );
 227
 228 void draw_pt_post_vs_prepare( struct pt_post_vs *pvs,
 229                               boolean bypass_clipping,
 230                               boolean bypass_viewport,
 231                               boolean opengl,
 232                               boolean need_edgeflags );
 233
 234 struct pt_post_vs *draw_pt_post_vs_create( struct draw_context *draw );
 235
 236 void draw_pt_post_vs_destroy( struct pt_post_vs *pvs );
 237
 238
 239 /*******************************************************************************
 240  * Utils:
 241  */
 242 void draw_pt_split_prim(unsigned prim, unsigned *first, unsigned *incr);
 243
 244
 245 #endif