driconf: Add allow_glsl_builtin_variable_redeclaration option
[mesa.git] / src / gallium / include / state_tracker / st_api.h
1 /**********************************************************
2 * Copyright 2010 VMware, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 *
24 **********************************************************/
25
26
27 #ifndef _ST_API_H_
28 #define _ST_API_H_
29
30 #include "pipe/p_compiler.h"
31 #include "pipe/p_format.h"
32
33 /**
34 * \file API for communication between state trackers and state tracker
35 * managers.
36 *
37 * While both are state tackers, we use the term state tracker for rendering
38 * APIs such as OpenGL or OpenVG, and state tracker manager for window system
39 * APIs such as EGL or GLX in this file.
40 *
41 * This file defines an API to be implemented by both state trackers and state
42 * tracker managers.
43 */
44
45 /**
46 * The supported rendering API of a state tracker.
47 */
48 enum st_api_type {
49 ST_API_OPENGL,
50 ST_API_OPENVG,
51
52 ST_API_COUNT
53 };
54
55 /**
56 * The profile of a context.
57 */
58 enum st_profile_type
59 {
60 ST_PROFILE_DEFAULT, /**< OpenGL compatibility profile */
61 ST_PROFILE_OPENGL_CORE, /**< OpenGL 3.2+ core profile */
62 ST_PROFILE_OPENGL_ES1, /**< OpenGL ES 1.x */
63 ST_PROFILE_OPENGL_ES2 /**< OpenGL ES 2.0 */
64 };
65
66 /* for profile_mask in st_api */
67 #define ST_PROFILE_DEFAULT_MASK (1 << ST_PROFILE_DEFAULT)
68 #define ST_PROFILE_OPENGL_CORE_MASK (1 << ST_PROFILE_OPENGL_CORE)
69 #define ST_PROFILE_OPENGL_ES1_MASK (1 << ST_PROFILE_OPENGL_ES1)
70 #define ST_PROFILE_OPENGL_ES2_MASK (1 << ST_PROFILE_OPENGL_ES2)
71
72 /**
73 * Optional API/state tracker features.
74 */
75 enum st_api_feature
76 {
77 ST_API_FEATURE_MS_VISUALS /**< support for multisample visuals */
78 };
79
80 /* for feature_mask in st_api */
81 #define ST_API_FEATURE_MS_VISUALS_MASK (1 << ST_API_FEATURE_MS_VISUALS)
82
83 /**
84 * New context flags for GL 3.0 and beyond.
85 *
86 * Profile information (core vs. compatibilty for OpenGL 3.2+) is communicated
87 * through the \c st_profile_type, not through flags.
88 */
89 #define ST_CONTEXT_FLAG_DEBUG (1 << 0)
90 #define ST_CONTEXT_FLAG_FORWARD_COMPATIBLE (1 << 1)
91 #define ST_CONTEXT_FLAG_ROBUST_ACCESS (1 << 2)
92 #define ST_CONTEXT_FLAG_RESET_NOTIFICATION_ENABLED (1 << 3)
93
94 /**
95 * Reasons that context creation might fail.
96 */
97 enum st_context_error {
98 ST_CONTEXT_SUCCESS = 0,
99 ST_CONTEXT_ERROR_NO_MEMORY,
100 ST_CONTEXT_ERROR_BAD_API,
101 ST_CONTEXT_ERROR_BAD_VERSION,
102 ST_CONTEXT_ERROR_BAD_FLAG,
103 ST_CONTEXT_ERROR_UNKNOWN_ATTRIBUTE,
104 ST_CONTEXT_ERROR_UNKNOWN_FLAG
105 };
106
107 /**
108 * Used in st_context_iface->teximage.
109 */
110 enum st_texture_type {
111 ST_TEXTURE_1D,
112 ST_TEXTURE_2D,
113 ST_TEXTURE_3D,
114 ST_TEXTURE_RECT
115 };
116
117 /**
118 * Available attachments of framebuffer.
119 */
120 enum st_attachment_type {
121 ST_ATTACHMENT_FRONT_LEFT,
122 ST_ATTACHMENT_BACK_LEFT,
123 ST_ATTACHMENT_FRONT_RIGHT,
124 ST_ATTACHMENT_BACK_RIGHT,
125 ST_ATTACHMENT_DEPTH_STENCIL,
126 ST_ATTACHMENT_ACCUM,
127 ST_ATTACHMENT_SAMPLE,
128
129 ST_ATTACHMENT_COUNT,
130 ST_ATTACHMENT_INVALID = -1
131 };
132
133 /* for buffer_mask in st_visual */
134 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
135 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
136 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
137 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
138 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
139 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
140 #define ST_ATTACHMENT_SAMPLE_MASK (1 << ST_ATTACHMENT_SAMPLE)
141
142 /**
143 * Enumerations of state tracker context resources.
144 */
145 enum st_context_resource_type {
146 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D,
147 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D,
148 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X,
149 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X,
150 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y,
151 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y,
152 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z,
153 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
154 ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER,
155 ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
156 };
157
158 /**
159 * Flush flags.
160 */
161 #define ST_FLUSH_FRONT (1 << 0)
162 #define ST_FLUSH_END_OF_FRAME (1 << 1)
163 #define ST_FLUSH_WAIT (1 << 2)
164
165 /**
166 * Value to st_manager->get_param function.
167 */
168 enum st_manager_param {
169 /**
170 * The dri state tracker on old libGL's doesn't do the right thing
171 * with regards to invalidating the framebuffers.
172 *
173 * For the mesa state tracker that means that it needs to invalidate
174 * the framebuffer in glViewport itself.
175 */
176 ST_MANAGER_BROKEN_INVALIDATE
177 };
178
179 struct pipe_context;
180 struct pipe_resource;
181 struct pipe_fence_handle;
182
183 /**
184 * Used in st_context_iface->get_resource_for_egl_image.
185 */
186 struct st_context_resource
187 {
188 /* these fields are filled in by the caller */
189 enum st_context_resource_type type;
190 void *resource;
191
192 /* this is owned by the caller */
193 struct pipe_resource *texture;
194 };
195
196 /**
197 * Used in st_manager_iface->get_egl_image.
198 */
199 struct st_egl_image
200 {
201 /* this is owned by the caller */
202 struct pipe_resource *texture;
203
204 /* format only differs from texture->format for multi-planar (YUV): */
205 enum pipe_format format;
206
207 unsigned level;
208 unsigned layer;
209 };
210
211 /**
212 * Represent the visual of a framebuffer.
213 */
214 struct st_visual
215 {
216 /**
217 * Available buffers. Bitfield of ST_ATTACHMENT_*_MASK bits.
218 */
219 unsigned buffer_mask;
220
221 /**
222 * Buffer formats. The formats are always set even when the buffer is
223 * not available.
224 */
225 enum pipe_format color_format;
226 enum pipe_format depth_stencil_format;
227 enum pipe_format accum_format;
228 int samples;
229
230 /**
231 * Desired render buffer.
232 */
233 enum st_attachment_type render_buffer;
234 };
235
236
237 /**
238 * Configuration options from driconf
239 */
240 struct st_config_options
241 {
242 boolean disable_blend_func_extended;
243 boolean disable_glsl_line_continuations;
244 boolean disable_shader_bit_encoding;
245 boolean force_glsl_extensions_warn;
246 unsigned force_glsl_version;
247 boolean force_s3tc_enable;
248 boolean allow_glsl_extension_directive_midshader;
249 boolean allow_glsl_builtin_variable_redeclaration;
250 boolean allow_higher_compat_version;
251 boolean glsl_zero_init;
252 boolean force_glsl_abs_sqrt;
253 unsigned char config_options_sha1[20];
254 };
255
256 /**
257 * Represent the attributes of a context.
258 */
259 struct st_context_attribs
260 {
261 /**
262 * The profile and minimal version to support.
263 *
264 * The valid profiles and versions are rendering API dependent. The latest
265 * version satisfying the request should be returned.
266 */
267 enum st_profile_type profile;
268 int major, minor;
269
270 /** Mask of ST_CONTEXT_FLAG_x bits */
271 unsigned flags;
272
273 /**
274 * The visual of the framebuffers the context will be bound to.
275 */
276 struct st_visual visual;
277
278 /**
279 * Configuration options.
280 */
281 struct st_config_options options;
282 };
283
284 struct st_context_iface;
285
286 /**
287 * Represent a windowing system drawable.
288 *
289 * The framebuffer is implemented by the state tracker manager and
290 * used by the state trackers.
291 *
292 * Instead of the winsys poking into the API context to figure
293 * out what buffers that might be needed in the future by the API
294 * context, it calls into the framebuffer to get the textures.
295 *
296 * This structure along with the notify_invalid_framebuffer
297 * allows framebuffers to be shared between different threads
298 * but at the same make the API context free from thread
299 * synchronization primitves, with the exception of a small
300 * atomic flag used for notification of framebuffer dirty status.
301 *
302 * The thread synchronization is put inside the framebuffer
303 * and only called once the framebuffer has become dirty.
304 */
305 struct st_framebuffer_iface
306 {
307 /**
308 * Atomic stamp which changes when framebuffers need to be updated.
309 */
310 int32_t stamp;
311
312 /**
313 * Available for the state tracker manager to use.
314 */
315 void *st_manager_private;
316
317 /**
318 * The visual of a framebuffer.
319 */
320 const struct st_visual *visual;
321
322 /**
323 * Flush the front buffer.
324 *
325 * On some window systems, changes to the front buffers are not immediately
326 * visible. They need to be flushed.
327 *
328 * @att is one of the front buffer attachments.
329 */
330 boolean (*flush_front)(struct st_context_iface *stctx,
331 struct st_framebuffer_iface *stfbi,
332 enum st_attachment_type statt);
333
334 /**
335 * The state tracker asks for the textures it needs.
336 *
337 * It should try to only ask for attachments that it currently renders
338 * to, thus allowing the winsys to delay the allocation of textures not
339 * needed. For example front buffer attachments are not needed if you
340 * only do back buffer rendering.
341 *
342 * The implementor of this function needs to also ensure
343 * thread safty as this call might be done from multiple threads.
344 *
345 * The returned textures are owned by the caller. They should be
346 * unreferenced when no longer used. If this function is called multiple
347 * times with different sets of attachments, those buffers not included in
348 * the last call might be destroyed. This behavior might change in the
349 * future.
350 */
351 boolean (*validate)(struct st_context_iface *stctx,
352 struct st_framebuffer_iface *stfbi,
353 const enum st_attachment_type *statts,
354 unsigned count,
355 struct pipe_resource **out);
356 };
357
358 /**
359 * Represent a rendering context.
360 *
361 * This entity is created from st_api and used by the state tracker manager.
362 */
363 struct st_context_iface
364 {
365 /**
366 * Available for the state tracker and the manager to use.
367 */
368 void *st_context_private;
369 void *st_manager_private;
370
371 /**
372 * The CSO context associated with this context in case we need to draw
373 * something before swap buffers.
374 */
375 struct cso_context *cso_context;
376
377 /**
378 * The gallium context.
379 */
380 struct pipe_context *pipe;
381
382 /**
383 * Destroy the context.
384 */
385 void (*destroy)(struct st_context_iface *stctxi);
386
387 /**
388 * Flush all drawing from context to the pipe also flushes the pipe.
389 */
390 void (*flush)(struct st_context_iface *stctxi, unsigned flags,
391 struct pipe_fence_handle **fence);
392
393 /**
394 * Replace the texture image of a texture object at the specified level.
395 *
396 * This function is optional.
397 */
398 boolean (*teximage)(struct st_context_iface *stctxi,
399 enum st_texture_type target,
400 int level, enum pipe_format internal_format,
401 struct pipe_resource *tex, boolean mipmap);
402
403 /**
404 * Used to implement glXCopyContext.
405 */
406 void (*copy)(struct st_context_iface *stctxi,
407 struct st_context_iface *stsrci, unsigned mask);
408
409 /**
410 * Used to implement wglShareLists.
411 */
412 boolean (*share)(struct st_context_iface *stctxi,
413 struct st_context_iface *stsrci);
414
415 /**
416 * Look up and return the info of a resource for EGLImage.
417 *
418 * This function is optional.
419 */
420 boolean (*get_resource_for_egl_image)(struct st_context_iface *stctxi,
421 struct st_context_resource *stres);
422
423 /**
424 * Start the thread if the API has a worker thread.
425 * Called after the context has been created and fully initialized on both
426 * sides (e.g. st/mesa and st/dri).
427 */
428 void (*start_thread)(struct st_context_iface *stctxi);
429
430 /**
431 * If the API is multithreaded, wait for all queued commands to complete.
432 * Called from the main thread.
433 */
434 void (*thread_finish)(struct st_context_iface *stctxi);
435 };
436
437
438 /**
439 * Represent a state tracker manager.
440 *
441 * This interface is implemented by the state tracker manager. It corresponds
442 * to a "display" in the window system.
443 */
444 struct st_manager
445 {
446 struct pipe_screen *screen;
447
448 /**
449 * Look up and return the info of an EGLImage.
450 *
451 * This is used to implement for example EGLImageTargetTexture2DOES.
452 * The GLeglImageOES agrument of that call is passed directly to this
453 * function call and the information needed to access this is returned
454 * in the given struct out.
455 *
456 * @smapi: manager owning the caller context
457 * @stctx: caller context
458 * @egl_image: EGLImage that caller recived
459 * @out: return struct filled out with access information.
460 *
461 * This function is optional.
462 */
463 boolean (*get_egl_image)(struct st_manager *smapi,
464 void *egl_image,
465 struct st_egl_image *out);
466
467 /**
468 * Query an manager param.
469 */
470 int (*get_param)(struct st_manager *smapi,
471 enum st_manager_param param);
472
473 /**
474 * Call the loader function setBackgroundContext. Called from the worker
475 * thread.
476 */
477 void (*set_background_context)(struct st_context_iface *stctxi);
478 };
479
480 /**
481 * Represent a rendering API such as OpenGL or OpenVG.
482 *
483 * Implemented by the state tracker and used by the state tracker manager.
484 */
485 struct st_api
486 {
487 /**
488 * The name of the rendering API. This is informative.
489 */
490 const char *name;
491
492 /**
493 * The supported rendering API.
494 */
495 enum st_api_type api;
496
497 /**
498 * The supported profiles. Tested with ST_PROFILE_*_MASK.
499 */
500 unsigned profile_mask;
501
502 /**
503 * The supported optional features. Tested with ST_FEATURE_*_MASK.
504 */
505 unsigned feature_mask;
506
507 /**
508 * Destroy the API.
509 */
510 void (*destroy)(struct st_api *stapi);
511
512 /**
513 * Query supported OpenGL versions. (if applicable)
514 * The format is (major*10+minor).
515 */
516 void (*query_versions)(struct st_api *stapi, struct st_manager *sm,
517 struct st_config_options *options,
518 int *gl_core_version,
519 int *gl_compat_version,
520 int *gl_es1_version,
521 int *gl_es2_version);
522
523 /**
524 * Create a rendering context.
525 */
526 struct st_context_iface *(*create_context)(struct st_api *stapi,
527 struct st_manager *smapi,
528 const struct st_context_attribs *attribs,
529 enum st_context_error *error,
530 struct st_context_iface *stsharei);
531
532 /**
533 * Bind the context to the calling thread with draw and read as drawables.
534 *
535 * The framebuffers might be NULL, or might have different visuals than the
536 * context does.
537 */
538 boolean (*make_current)(struct st_api *stapi,
539 struct st_context_iface *stctxi,
540 struct st_framebuffer_iface *stdrawi,
541 struct st_framebuffer_iface *streadi);
542
543 /**
544 * Get the currently bound context in the calling thread.
545 */
546 struct st_context_iface *(*get_current)(struct st_api *stapi);
547 };
548
549 /**
550 * Return true if the visual has the specified buffers.
551 */
552 static inline boolean
553 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
554 {
555 return ((visual->buffer_mask & mask) == mask);
556 }
557
558 #endif /* _ST_API_H_ */