p_context.h revision d5640a2dbdc4454d0405f2cd5b18fc49b1ca7694 
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#ifndef PIPE_CONTEXT_H
29#define PIPE_CONTEXT_H
30
31#include "p_state.h"
32
33
34struct pipe_state_cache;
35
36/* Opaque driver handles:
37 */
38struct pipe_query;
39
40/**
41 * Gallium rendering context.  Basically:
42 *  - state setting functions
43 *  - VBO drawing functions
44 *  - surface functions
45 *  - device queries
46 */
47struct pipe_context {
48   struct pipe_winsys *winsys;
49
50   void *priv;  /** context private data (for DRI for example) */
51
52   void (*destroy)( struct pipe_context * );
53
54   /*
55    * Queries
56    */
57   /** type is one of PIPE_SURFACE, PIPE_TEXTURE, etc. */
58   boolean (*is_format_supported)( struct pipe_context *pipe,
59                                   enum pipe_format format, uint type );
60
61   const char *(*get_name)( struct pipe_context *pipe );
62
63   const char *(*get_vendor)( struct pipe_context *pipe );
64
65   int (*get_param)( struct pipe_context *pipe, int param );
66   float (*get_paramf)( struct pipe_context *pipe, int param );
67
68
69   /*
70    * Drawing.
71    * Return false on fallbacks (temporary??)
72    */
73   boolean (*draw_arrays)( struct pipe_context *pipe,
74			   unsigned mode, unsigned start, unsigned count);
75
76   boolean (*draw_elements)( struct pipe_context *pipe,
77			     struct pipe_buffer *indexBuffer,
78			     unsigned indexSize,
79			     unsigned mode, unsigned start, unsigned count);
80
81
82   /**
83    * Query objects
84    */
85   struct pipe_query *(*create_query)( struct pipe_context *pipe,
86                                              unsigned query_type );
87
88   void (*destroy_query)(struct pipe_context *pipe,
89                         struct pipe_query *q);
90
91   void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
92   void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
93
94   boolean (*get_query_result)(struct pipe_context *pipe,
95                               struct pipe_query *q,
96                               boolean wait,
97                               uint64 *result);
98
99   /*
100    * State functions
101    */
102   void * (*create_blend_state)(struct pipe_context *,
103                                const struct pipe_blend_state *);
104   void   (*bind_blend_state)(struct pipe_context *, void *);
105   void   (*delete_blend_state)(struct pipe_context *, void  *);
106
107   void * (*create_sampler_state)(struct pipe_context *,
108                                  const struct pipe_sampler_state *);
109   void   (*bind_sampler_state)(struct pipe_context *, unsigned unit, void *);
110   void   (*delete_sampler_state)(struct pipe_context *, void *);
111
112   void * (*create_rasterizer_state)(struct pipe_context *,
113                                     const struct pipe_rasterizer_state *);
114   void   (*bind_rasterizer_state)(struct pipe_context *, void *);
115   void   (*delete_rasterizer_state)(struct pipe_context *, void *);
116
117   void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
118                                        const struct pipe_depth_stencil_alpha_state *);
119   void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
120   void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
121
122   void * (*create_fs_state)(struct pipe_context *,
123                             const struct pipe_shader_state *);
124   void   (*bind_fs_state)(struct pipe_context *, void *);
125   void   (*delete_fs_state)(struct pipe_context *, void *);
126
127   void * (*create_vs_state)(struct pipe_context *,
128                             const struct pipe_shader_state *);
129   void   (*bind_vs_state)(struct pipe_context *, void *);
130   void   (*delete_vs_state)(struct pipe_context *, void *);
131
132   /* The following look more properties than states.
133    * maybe combine a few of them into states or pass them
134    * in the bind calls to the state */
135   void (*set_blend_color)( struct pipe_context *,
136                            const struct pipe_blend_color * );
137
138   void (*set_clip_state)( struct pipe_context *,
139			   const struct pipe_clip_state * );
140
141   void (*set_constant_buffer)( struct pipe_context *,
142                                uint shader, uint index,
143                                const struct pipe_constant_buffer *buf );
144
145   void (*set_framebuffer_state)( struct pipe_context *,
146                                  const struct pipe_framebuffer_state * );
147
148   void (*set_polygon_stipple)( struct pipe_context *,
149				const struct pipe_poly_stipple * );
150
151   void (*set_scissor_state)( struct pipe_context *,
152                              const struct pipe_scissor_state * );
153
154
155   /* Currently a sampler is constrained to sample from a single texture:
156    */
157   void (*set_sampler_texture)( struct pipe_context *,
158				unsigned sampler,
159				struct pipe_texture * );
160
161   void (*set_viewport_state)( struct pipe_context *,
162                               const struct pipe_viewport_state * );
163
164   /*
165    * Vertex arrays
166    */
167   void (*set_vertex_buffer)( struct pipe_context *,
168                              unsigned index,
169                              const struct pipe_vertex_buffer * );
170
171   void (*set_vertex_element)( struct pipe_context *,
172			       unsigned index,
173			       const struct pipe_vertex_element * );
174
175
176   /*
177    * Surface functions
178    */
179
180   void (*surface_copy)(struct pipe_context *pipe,
181                        unsigned do_flip,	/*<< flip surface contents vertically */
182			struct pipe_surface *dest,
183			unsigned destx, unsigned desty,
184			struct pipe_surface *src, /* don't make this const -
185						     need to map/unmap */
186			unsigned srcx, unsigned srcy,
187			unsigned width, unsigned height);
188
189   void (*surface_fill)(struct pipe_context *pipe,
190			struct pipe_surface *dst,
191			unsigned dstx, unsigned dsty,
192			unsigned width, unsigned height,
193			unsigned value);
194
195   void (*clear)(struct pipe_context *pipe,
196		 struct pipe_surface *ps,
197		 unsigned clearValue);
198
199
200   /*
201    * Texture functions
202    */
203   struct pipe_texture * (*texture_create)(struct pipe_context *pipe,
204                                           const struct pipe_texture *templat);
205
206   void (*texture_release)(struct pipe_context *pipe,
207			   struct pipe_texture **pt);
208
209   /**
210    * Called when texture data is changed.
211    * Note: we could pass some hints about which mip levels or cube faces
212    * have changed...
213    */
214   void (*texture_update)(struct pipe_context *pipe,
215                          struct pipe_texture *texture);
216
217   /** Get a surface which is a "view" into a texture */
218   struct pipe_surface *(*get_tex_surface)(struct pipe_context *pipe,
219                                           struct pipe_texture *texture,
220                                           unsigned face, unsigned level,
221                                           unsigned zslice);
222
223   /* Flush rendering:
224    */
225   void (*flush)( struct pipe_context *pipe,
226		  unsigned flags );
227};
228
229#endif /* PIPE_CONTEXT_H */
230