src/gallium/auxiliary/draw/draw_vbuf.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  * \file
  30  * Vertex buffer drawing stage.
  31  *
  32  * \author Keith Whitwell <keith@tungstengraphics.com>
  33  * \author Jose Fonseca <jrfonsec@tungstengraphics.com>
  34  */
  35
  36 #ifndef DRAW_VBUF_H_
  37 #define DRAW_VBUF_H_
  38
  39
  40 #include "pipe/p_compiler.h"
  41
  42
  43 struct pipe_rasterizer_state;
  44 struct draw_context;
  45 struct vertex_info;
  46
  47
  48 /**
  49  * Interface for hardware vertex buffer rendering.
  50  */
  51 struct vbuf_render {
  52
  53    /**
  54     * Driver limits.  May be tuned lower to improve cache hits on
  55     * index list.
  56     */
  57    unsigned max_indices;
  58    unsigned max_vertex_buffer_bytes;
  59
  60    /**
  61     * Query if the hardware driver needs assistance for a particular
  62     * combination of rasterizer state and primitive.
  63     *
  64     * Currently optional.
  65     */
  66    boolean (*need_pipeline)(const struct vbuf_render *render,
  67                             const struct pipe_rasterizer_state *rasterizer,
  68                             unsigned int prim );
  69
  70
  71    /**
  72     * Get the hardware vertex format.
  73     *
  74     * XXX: have this in draw_context instead?
  75     */
  76    const struct vertex_info *(*get_vertex_info)( struct vbuf_render * );
  77
  78    /**
  79     * Request a destination for vertices.
  80     * Hardware renderers will use ttm memory, others will just malloc
  81     * something.
  82     */
  83    void *(*allocate_vertices)( struct vbuf_render *,
  84                                ushort vertex_size,
  85                                ushort nr_vertices );
  86
  87    /**
  88     * Notify the renderer of the current primitive when it changes.
  89     * Must succeed for TRIANGLES, LINES and POINTS.  Other prims at
  90     * the discretion of the driver, for the benefit of the passthrough
  91     * path.
  92     */
  93    boolean (*set_primitive)( struct vbuf_render *, unsigned prim );
  94
  95    /**
  96     * DrawElements, note indices are ushort.  The driver must complete
  97     * this call, if necessary splitting the index list itself.
  98     */
  99    void (*draw)( struct vbuf_render *,
 100                  const ushort *indices,
 101                  uint nr_indices );
 102
 103    /* Draw Arrays path too.
 104     */
 105    void (*draw_arrays)( struct vbuf_render *,
 106                         unsigned start,
 107                         uint nr );
 108
 109    /**
 110     * Called when vbuf is done with this set of vertices:
 111     */
 112    void (*release_vertices)( struct vbuf_render *,
 113                              void *vertices,
 114                              unsigned vertex_size,
 115                              unsigned vertices_used );
 116
 117    void (*destroy)( struct vbuf_render * );
 118 };
 119
 120
 121
 122 struct draw_stage *
 123 draw_vbuf_stage( struct draw_context *draw,
 124                  struct vbuf_render *render );
 125
 126
 127 #endif /*DRAW_VBUF_H_*/