u_vbuf.h revision 7fe3631a7a0ad7602b4e947ac87ef86875c8bb3f 
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_MGR_H
29#define U_VBUF_MGR_H
30
31/* This module builds upon u_upload_mgr and translate_cache and takes care of
32 * user buffer uploads and vertex format fallbacks. It's designed
33 * for the drivers which don't always use the Draw module. (e.g. for HWTCL)
34 */
35
36#include "pipe/p_context.h"
37#include "pipe/p_state.h"
38
39/* Hardware vertex fetcher limitations can be described by this structure. */
40struct u_vbuf_caps {
41   /* Vertex format CAPs. */
42   /* TRUE if hardware supports it. */
43   unsigned format_fixed32:1;    /* PIPE_FORMAT_*32*_FIXED */
44   unsigned format_float16:1;    /* PIPE_FORMAT_*16*_FLOAT */
45   unsigned format_float64:1;    /* PIPE_FORMAT_*64*_FLOAT */
46   unsigned format_norm32:1;     /* PIPE_FORMAT_*32*NORM */
47   unsigned format_scaled32:1;   /* PIPE_FORMAT_*32*SCALED */
48
49   /* Whether vertex fetches don't have to be dword-aligned. */
50   /* TRUE if hardware supports it. */
51   unsigned fetch_dword_unaligned:1;
52
53   /* Whether the driver supports user vertex buffers. */
54   unsigned user_vertex_buffers:1;
55};
56
57/* The manager.
58 * This structure should also be used to access vertex buffers
59 * from a driver. */
60struct u_vbuf {
61   /* This is what was set in set_vertex_buffers.
62    * May contain user buffers. */
63   struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
64   unsigned nr_vertex_buffers;
65
66   /* This uploader can optionally be used by the driver.
67    *
68    * Allowed functions:
69    * - u_upload_alloc
70    * - u_upload_data
71    * - u_upload_buffer
72    * - u_upload_flush */
73   struct u_upload_mgr *uploader;
74
75   /* Vertex elements state as created by u_vbuf.
76    * This is used when saving the state into u_blitter, there's no other
77    * usage. */
78   void *vertex_elements;
79};
80
81
82void u_vbuf_get_caps(struct pipe_screen *screen, struct u_vbuf_caps *caps);
83
84struct u_vbuf *
85u_vbuf_create(struct pipe_context *pipe,
86              struct u_vbuf_caps *caps,
87              unsigned upload_buffer_size,
88              unsigned upload_buffer_alignment,
89              unsigned upload_buffer_bind);
90
91void u_vbuf_destroy(struct u_vbuf *mgr);
92
93unsigned u_vbuf_draw_max_vertex_count(struct u_vbuf *mgr);
94
95#endif
96