src/gallium/auxiliary/util/u_vbuf.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2011 Marek Olšák <maraeo@gmail.com>
   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 AUTHORS 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 #ifndef U_VBUF_H
  29 #define U_VBUF_H
  30
  31 /* This module takes care of user buffer uploads and vertex format fallbacks.
  32  * It's designed for the drivers which don't want to use the Draw module.
  33  * There is a more detailed description at the beginning of the .c file.
  34  */
  35
  36 #include "pipe/p_context.h"
  37 #include "pipe/p_state.h"
  38 #include "pipe/p_format.h"
  39
  40 struct cso_context;
  41 struct u_vbuf;
  42
  43 /* Hardware vertex fetcher limitations can be described by this structure. */
  44 struct u_vbuf_caps {
  45    enum pipe_format format_translation[PIPE_FORMAT_COUNT];
  46
  47    /* Whether vertex fetches don't have to be 4-byte-aligned. */
  48    /* TRUE if hardware supports it. */
  49    unsigned buffer_offset_unaligned:1;
  50    unsigned buffer_stride_unaligned:1;
  51    unsigned velem_src_offset_unaligned:1;
  52
  53    /* Whether the driver supports user vertex buffers. */
  54    unsigned user_vertex_buffers:1;
  55 };
  56
  57
  58 boolean u_vbuf_get_caps(struct pipe_screen *screen, struct u_vbuf_caps *caps);
  59
  60 struct u_vbuf *
  61 u_vbuf_create(struct pipe_context *pipe,
  62               struct u_vbuf_caps *caps, unsigned aux_vertex_buffer_index);
  63
  64 void u_vbuf_destroy(struct u_vbuf *mgr);
  65
  66 /* State and draw functions. */
  67 void u_vbuf_set_vertex_elements(struct u_vbuf *mgr, unsigned count,
  68                                 const struct pipe_vertex_element *states);
  69 void u_vbuf_set_vertex_buffers(struct u_vbuf *mgr,
  70                                unsigned start_slot, unsigned count,
  71                                const struct pipe_vertex_buffer *bufs);
  72 void u_vbuf_set_index_buffer(struct u_vbuf *mgr,
  73                              const struct pipe_index_buffer *ib);
  74 void u_vbuf_draw_vbo(struct u_vbuf *mgr, const struct pipe_draw_info *info);
  75
  76 /* Save/restore functionality. */
  77 void u_vbuf_save_vertex_elements(struct u_vbuf *mgr);
  78 void u_vbuf_restore_vertex_elements(struct u_vbuf *mgr);
  79 void u_vbuf_save_aux_vertex_buffer_slot(struct u_vbuf *mgr);
  80 void u_vbuf_restore_aux_vertex_buffer_slot(struct u_vbuf *mgr);
  81
  82 #endif