/**************************************************************************
 *
 * Copyright 2007 VMware, Inc.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/

/**
 * \file
 * Vertex buffer drawing stage.
 *
 * \author Keith Whitwell <keithw@vmware.com>
 * \author Jose Fonseca <jfonseca@vmware.com>
 */

#ifndef DRAW_VBUF_H_
#define DRAW_VBUF_H_


#include "pipe/p_compiler.h"
#include "pipe/p_defines.h"


struct pipe_rasterizer_state;
struct draw_context;
struct vertex_info;
struct pipe_query_data_pipeline_statistics;


/**
 * Interface for hardware vertex buffer rendering.
 */
struct vbuf_render {

   /**
    * Driver limits.  May be tuned lower to improve cache hits on
    * index list.
    */
   unsigned max_indices;
   unsigned max_vertex_buffer_bytes;

   /**
    * Query if the hardware driver needs assistance for a particular
    * combination of rasterizer state and primitive.
    *
    * Currently optional.
    */
   boolean (*need_pipeline)(const struct vbuf_render *render,
                            const struct pipe_rasterizer_state *rasterizer,
                            unsigned int prim);


   /**
    * Get the hardware vertex format.
    *
    * XXX: have this in draw_context instead?
    */
   const struct vertex_info *(*get_vertex_info)(struct vbuf_render *);

   /**
    * Request a destination for vertices.
    * Hardware renderers will use ttm memory, others will just malloc
    * something.
    */
   boolean (*allocate_vertices)(struct vbuf_render *,
                                ushort vertex_size,
                                ushort nr_vertices);

   void *(*map_vertices)(struct vbuf_render *);
   void (*unmap_vertices)(struct vbuf_render *,
                          ushort min_index,
                          ushort max_index);

   /**
    * Notify the renderer of the current primitive when it changes.
    * Must succeed for TRIANGLES, LINES and POINTS.  Other prims at
    * the discretion of the driver, for the benefit of the passthrough
    * path.
    */
   void (*set_primitive)(struct vbuf_render *, enum pipe_prim_type prim);

   /**
    * Notify the renderer of the current view index.
    */
   void (*set_view_index)(struct vbuf_render *, unsigned view_index);

   /**
    * Draw indexed primitives.  Note that indices are ushort.  The driver
    * must complete this call, if necessary splitting the index list itself.
    */
   void (*draw_elements)(struct vbuf_render *,
                         const ushort *indices,
                         uint nr_indices);

   /* Draw non-indexed primitives.
    */
   void (*draw_arrays)(struct vbuf_render *,
                       unsigned start,
                       uint nr);

   /**
    * Called when vbuf is done with this set of vertices:
    */
   void (*release_vertices)(struct vbuf_render *);

   void (*destroy)(struct vbuf_render *);


   /**
    * Called after writing data to the stream out buffers
    */
   void (*set_stream_output_info)(struct vbuf_render *vbufr,
                                  unsigned stream,
                                  unsigned primitive_count,
                                  unsigned primitive_generated);

   /**
    * Called after all relevant statistics have been accumulated.
    */
   void (*pipeline_statistics)(
      struct vbuf_render *vbufr,
      const struct pipe_query_data_pipeline_statistics *stats);
};


struct draw_stage *
draw_vbuf_stage(struct draw_context *draw,
                 struct vbuf_render *render);


#endif /*DRAW_VBUF_H_*/