1 /**********************************************************
2 * Copyright 2010 VMware, Inc. All rights reserved.
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:
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
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
24 **********************************************************/
30 #include "pipe/p_format.h"
33 * \file API for communication between state trackers and state tracker
36 * While both are state tackers, we use the term state tracker for rendering
37 * APIs such as OpenGL or OpenVG, and state tracker manager for window system
38 * APIs such as EGL or GLX in this file.
40 * This file defines an API to be implemented by both state trackers and state
45 * The supported rendering API of a state tracker.
55 * The profile of a context.
59 ST_PROFILE_DEFAULT
, /**< OpenGL compatibility profile */
60 ST_PROFILE_OPENGL_CORE
, /**< OpenGL 3.2+ core profile */
61 ST_PROFILE_OPENGL_ES1
, /**< OpenGL ES 1.x */
62 ST_PROFILE_OPENGL_ES2
/**< OpenGL ES 2.0 */
65 /* for profile_mask in st_api */
66 #define ST_PROFILE_DEFAULT_MASK (1 << ST_PROFILE_DEFAULT)
67 #define ST_PROFILE_OPENGL_CORE_MASK (1 << ST_PROFILE_OPENGL_CORE)
68 #define ST_PROFILE_OPENGL_ES1_MASK (1 << ST_PROFILE_OPENGL_ES1)
69 #define ST_PROFILE_OPENGL_ES2_MASK (1 << ST_PROFILE_OPENGL_ES2)
72 * Optional API/state tracker features.
76 ST_API_FEATURE_MS_VISUALS
/**< support for multisample visuals */
79 /* for feature_mask in st_api */
80 #define ST_API_FEATURE_MS_VISUALS_MASK (1 << ST_API_FEATURE_MS_VISUALS)
83 * New context flags for GL 3.0 and beyond.
85 * Profile information (core vs. compatibilty for OpenGL 3.2+) is communicated
86 * through the \c st_profile_type, not through flags.
88 #define ST_CONTEXT_FLAG_DEBUG (1 << 0)
89 #define ST_CONTEXT_FLAG_FORWARD_COMPATIBLE (1 << 1)
90 #define ST_CONTEXT_FLAG_ROBUST_ACCESS (1 << 2)
91 #define ST_CONTEXT_FLAG_RESET_NOTIFICATION_ENABLED (1 << 3)
92 #define ST_CONTEXT_FLAG_NO_ERROR (1 << 4)
93 #define ST_CONTEXT_FLAG_RELEASE_NONE (1 << 5)
94 #define ST_CONTEXT_FLAG_HIGH_PRIORITY (1 << 6)
95 #define ST_CONTEXT_FLAG_LOW_PRIORITY (1 << 7)
98 * Reasons that context creation might fail.
100 enum st_context_error
{
101 ST_CONTEXT_SUCCESS
= 0,
102 ST_CONTEXT_ERROR_NO_MEMORY
,
103 ST_CONTEXT_ERROR_BAD_API
,
104 ST_CONTEXT_ERROR_BAD_VERSION
,
105 ST_CONTEXT_ERROR_BAD_FLAG
,
106 ST_CONTEXT_ERROR_UNKNOWN_ATTRIBUTE
,
107 ST_CONTEXT_ERROR_UNKNOWN_FLAG
111 * Used in st_context_iface->teximage.
113 enum st_texture_type
{
121 * Available attachments of framebuffer.
123 enum st_attachment_type
{
124 ST_ATTACHMENT_FRONT_LEFT
,
125 ST_ATTACHMENT_BACK_LEFT
,
126 ST_ATTACHMENT_FRONT_RIGHT
,
127 ST_ATTACHMENT_BACK_RIGHT
,
128 ST_ATTACHMENT_DEPTH_STENCIL
,
130 ST_ATTACHMENT_SAMPLE
,
133 ST_ATTACHMENT_INVALID
= -1
136 /* for buffer_mask in st_visual */
137 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
138 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
139 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
140 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
141 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
142 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
143 #define ST_ATTACHMENT_SAMPLE_MASK (1 << ST_ATTACHMENT_SAMPLE)
148 #define ST_FLUSH_FRONT (1 << 0)
149 #define ST_FLUSH_END_OF_FRAME (1 << 1)
150 #define ST_FLUSH_WAIT (1 << 2)
151 #define ST_FLUSH_FENCE_FD (1 << 3)
154 * Value to st_manager->get_param function.
156 enum st_manager_param
{
158 * The dri state tracker on old libGL's doesn't do the right thing
159 * with regards to invalidating the framebuffers.
161 * For the mesa state tracker that means that it needs to invalidate
162 * the framebuffer in glViewport itself.
164 ST_MANAGER_BROKEN_INVALIDATE
168 struct pipe_resource
;
169 struct pipe_fence_handle
;
170 struct util_queue_monitoring
;
173 * Used in st_manager_iface->get_egl_image.
177 /* this is owned by the caller */
178 struct pipe_resource
*texture
;
180 /* format only differs from texture->format for multi-planar (YUV): */
181 enum pipe_format format
;
185 /* GL internal format. */
186 unsigned internalformat
;
190 * Represent the visual of a framebuffer.
197 * Available buffers. Bitfield of ST_ATTACHMENT_*_MASK bits.
199 unsigned buffer_mask
;
202 * Buffer formats. The formats are always set even when the buffer is
205 enum pipe_format color_format
;
206 enum pipe_format depth_stencil_format
;
207 enum pipe_format accum_format
;
211 * Desired render buffer.
213 enum st_attachment_type render_buffer
;
218 * Configuration options from driconf
220 struct st_config_options
222 bool disable_blend_func_extended
;
223 bool disable_glsl_line_continuations
;
224 bool disable_arb_gpu_shader5
;
225 bool force_glsl_extensions_warn
;
226 unsigned force_glsl_version
;
227 bool allow_glsl_extension_directive_midshader
;
228 bool allow_glsl_builtin_const_expression
;
229 bool allow_glsl_relaxed_es
;
230 bool allow_glsl_builtin_variable_redeclaration
;
231 bool allow_higher_compat_version
;
233 bool vs_position_always_invariant
;
234 bool force_glsl_abs_sqrt
;
235 bool allow_glsl_cross_stage_interpolation_mismatch
;
236 bool allow_glsl_layout_qualifier_on_function_parameters
;
237 bool allow_draw_out_of_order
;
238 char *force_gl_vendor
;
239 unsigned char config_options_sha1
[20];
243 * Represent the attributes of a context.
245 struct st_context_attribs
248 * The profile and minimal version to support.
250 * The valid profiles and versions are rendering API dependent. The latest
251 * version satisfying the request should be returned.
253 enum st_profile_type profile
;
256 /** Mask of ST_CONTEXT_FLAG_x bits */
260 * The visual of the framebuffers the context will be bound to.
262 struct st_visual visual
;
265 * Configuration options.
267 struct st_config_options options
;
270 struct st_context_iface
;
274 * Represent a windowing system drawable.
276 * The framebuffer is implemented by the state tracker manager and
277 * used by the state trackers.
279 * Instead of the winsys poking into the API context to figure
280 * out what buffers that might be needed in the future by the API
281 * context, it calls into the framebuffer to get the textures.
283 * This structure along with the notify_invalid_framebuffer
284 * allows framebuffers to be shared between different threads
285 * but at the same make the API context free from thread
286 * synchronization primitves, with the exception of a small
287 * atomic flag used for notification of framebuffer dirty status.
289 * The thread synchronization is put inside the framebuffer
290 * and only called once the framebuffer has become dirty.
292 struct st_framebuffer_iface
295 * Atomic stamp which changes when framebuffers need to be updated.
300 * Identifier that uniquely identifies the framebuffer interface object.
305 * The state tracker manager that manages this object.
307 struct st_manager
*state_manager
;
310 * Available for the state tracker manager to use.
312 void *st_manager_private
;
315 * The visual of a framebuffer.
317 const struct st_visual
*visual
;
320 * Flush the front buffer.
322 * On some window systems, changes to the front buffers are not immediately
323 * visible. They need to be flushed.
325 * @att is one of the front buffer attachments.
327 bool (*flush_front
)(struct st_context_iface
*stctx
,
328 struct st_framebuffer_iface
*stfbi
,
329 enum st_attachment_type statt
);
332 * The state tracker asks for the textures it needs.
334 * It should try to only ask for attachments that it currently renders
335 * to, thus allowing the winsys to delay the allocation of textures not
336 * needed. For example front buffer attachments are not needed if you
337 * only do back buffer rendering.
339 * The implementor of this function needs to also ensure
340 * thread safty as this call might be done from multiple threads.
342 * The returned textures are owned by the caller. They should be
343 * unreferenced when no longer used. If this function is called multiple
344 * times with different sets of attachments, those buffers not included in
345 * the last call might be destroyed. This behavior might change in the
348 bool (*validate
)(struct st_context_iface
*stctx
,
349 struct st_framebuffer_iface
*stfbi
,
350 const enum st_attachment_type
*statts
,
352 struct pipe_resource
**out
);
353 bool (*flush_swapbuffers
) (struct st_context_iface
*stctx
,
354 struct st_framebuffer_iface
*stfbi
);
358 * Represent a rendering context.
360 * This entity is created from st_api and used by the state tracker manager.
362 struct st_context_iface
365 * Available for the state tracker and the manager to use.
367 void *st_context_private
;
368 void *st_manager_private
;
371 * The state tracker manager that manages this object.
373 struct st_manager
*state_manager
;
376 * The CSO context associated with this context in case we need to draw
377 * something before swap buffers.
379 struct cso_context
*cso_context
;
382 * The gallium context.
384 struct pipe_context
*pipe
;
387 * Destroy the context.
389 void (*destroy
)(struct st_context_iface
*stctxi
);
392 * Flush all drawing from context to the pipe also flushes the pipe.
394 void (*flush
)(struct st_context_iface
*stctxi
, unsigned flags
,
395 struct pipe_fence_handle
**fence
,
396 void (*notify_before_flush_cb
) (void*),
397 void* notify_before_flush_cb_args
);
400 * Replace the texture image of a texture object at the specified level.
402 * This function is optional.
404 bool (*teximage
)(struct st_context_iface
*stctxi
,
405 enum st_texture_type target
,
406 int level
, enum pipe_format internal_format
,
407 struct pipe_resource
*tex
, bool mipmap
);
410 * Used to implement glXCopyContext.
412 void (*copy
)(struct st_context_iface
*stctxi
,
413 struct st_context_iface
*stsrci
, unsigned mask
);
416 * Used to implement wglShareLists.
418 bool (*share
)(struct st_context_iface
*stctxi
,
419 struct st_context_iface
*stsrci
);
422 * Start the thread if the API has a worker thread.
423 * Called after the context has been created and fully initialized on both
424 * sides (e.g. st/mesa and st/dri).
426 void (*start_thread
)(struct st_context_iface
*stctxi
);
429 * If the API is multithreaded, wait for all queued commands to complete.
430 * Called from the main thread.
432 void (*thread_finish
)(struct st_context_iface
*stctxi
);
437 * Represent a state tracker manager.
439 * This interface is implemented by the state tracker manager. It corresponds
440 * to a "display" in the window system.
444 struct pipe_screen
*screen
;
447 * Look up and return the info of an EGLImage.
449 * This is used to implement for example EGLImageTargetTexture2DOES.
450 * The GLeglImageOES agrument of that call is passed directly to this
451 * function call and the information needed to access this is returned
452 * in the given struct out.
454 * @smapi: manager owning the caller context
455 * @stctx: caller context
456 * @egl_image: EGLImage that caller recived
457 * @out: return struct filled out with access information.
459 * This function is optional.
461 bool (*get_egl_image
)(struct st_manager
*smapi
,
463 struct st_egl_image
*out
);
466 * Query an manager param.
468 int (*get_param
)(struct st_manager
*smapi
,
469 enum st_manager_param param
);
472 * Call the loader function setBackgroundContext. Called from the worker
475 void (*set_background_context
)(struct st_context_iface
*stctxi
,
476 struct util_queue_monitoring
*queue_info
);
479 * Destroy any private data used by the state tracker manager.
481 void (*destroy
)(struct st_manager
*smapi
);
484 * Available for the state tracker manager to use.
486 void *st_manager_private
;
490 * Represent a rendering API such as OpenGL or OpenVG.
492 * Implemented by the state tracker and used by the state tracker manager.
497 * The name of the rendering API. This is informative.
502 * The supported rendering API.
504 enum st_api_type api
;
507 * The supported profiles. Tested with ST_PROFILE_*_MASK.
509 unsigned profile_mask
;
512 * The supported optional features. Tested with ST_FEATURE_*_MASK.
514 unsigned feature_mask
;
519 void (*destroy
)(struct st_api
*stapi
);
522 * Query supported OpenGL versions. (if applicable)
523 * The format is (major*10+minor).
525 void (*query_versions
)(struct st_api
*stapi
, struct st_manager
*sm
,
526 struct st_config_options
*options
,
527 int *gl_core_version
,
528 int *gl_compat_version
,
530 int *gl_es2_version
);
533 * Create a rendering context.
535 struct st_context_iface
*(*create_context
)(struct st_api
*stapi
,
536 struct st_manager
*smapi
,
537 const struct st_context_attribs
*attribs
,
538 enum st_context_error
*error
,
539 struct st_context_iface
*stsharei
);
542 * Bind the context to the calling thread with draw and read as drawables.
544 * The framebuffers might be NULL, or might have different visuals than the
547 bool (*make_current
)(struct st_api
*stapi
,
548 struct st_context_iface
*stctxi
,
549 struct st_framebuffer_iface
*stdrawi
,
550 struct st_framebuffer_iface
*streadi
);
553 * Get the currently bound context in the calling thread.
555 struct st_context_iface
*(*get_current
)(struct st_api
*stapi
);
558 * Notify the st manager the framebuffer interface object
559 * is no longer valid.
561 void (*destroy_drawable
)(struct st_api
*stapi
,
562 struct st_framebuffer_iface
*stfbi
);
566 * Return true if the visual has the specified buffers.
569 st_visual_have_buffers(const struct st_visual
*visual
, unsigned mask
)
571 return ((visual
->buffer_mask
& mask
) == mask
);
574 #endif /* _ST_API_H_ */