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