6b0f14d70ea8307bfbdf67767df62af65c555cde
[mesa.git] / src / mesa / vbo / vbo_context.h
1 /*
2 * mesa 3-D graphics library
3 * Version: 6.5
4 *
5 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25 /**
26 * \file vbo_context.h
27 * \brief VBO builder module datatypes and definitions.
28 * \author Keith Whitwell
29 */
30
31
32 /**
33 * \mainpage The VBO builder module
34 *
35 * This module hooks into the GL dispatch table and catches all vertex
36 * building and drawing commands, such as glVertex3f, glBegin and
37 * glDrawArrays. The module stores all incoming vertex data as arrays
38 * in GL vertex buffer objects (VBOs), and translates all drawing
39 * commands into calls to a driver supplied DrawPrimitives() callback.
40 *
41 * The module captures both immediate mode and display list drawing,
42 * and manages the allocation, reference counting and deallocation of
43 * vertex buffer objects itself.
44 *
45 * The DrawPrimitives() callback can be either implemented by the
46 * driver itself or hooked to the tnl module's _tnl_draw_primitives()
47 * function for hardware without tnl capablilties or during fallbacks.
48 */
49
50
51 #ifndef _VBO_CONTEXT_H
52 #define _VBO_CONTEXT_H
53
54 #include "vbo_attrib.h"
55 #include "vbo_save.h"
56 #include "vbo_exec.h"
57
58 GLboolean _vbo_CreateContext( GLcontext *ctx );
59 void _vbo_DestroyContext( GLcontext *ctx );
60
61
62 struct vbo_context {
63 struct vbo_exec_context exec;
64 struct vbo_save_context save;
65
66 /* Callback into the driver. This must always succeed, the driver
67 * is responsible for initiating any fallback actions required:
68 */
69 void (*draw_prims)( GLcontext *ctx,
70 const struct gl_client_array *arrays[],
71 const struct _mesa_prim *prims,
72 GLuint nr_prims,
73 const struct _mesa_index_buffer *ib,
74 GLuint min_index,
75 GLuint max_index );
76 };
77
78
79 static INLINE struct vbo_context *vbo_context(GLcontext *ctx)
80 {
81 return (struct vbo_context *)(ctx->swtnl_im);
82 }
83
84 enum {
85 VP_NONE = 1,
86 VP_NV,
87 VP_ARB
88 };
89
90 static INLINE GLuint get_program_mode( GLcontext *ctx )
91 {
92 if (!ctx->VertexProgram._Enabled)
93 return VP_NONE;
94 else if (ctx->VertexProgram.Current->IsNVProgram)
95 return VP_NV;
96 else
97 return VP_ARB;
98 }
99
100
101 #endif