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_compiler.h"
31 #include "pipe/p_format.h"
34 * \file API for communication between state trackers and state tracker
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.
41 * This file defines an API to be implemented by both state trackers and state
46 * The supported rendering API of a state tracker.
56 * The profile of a context.
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 */
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)
73 * Optional API/state tracker features.
77 ST_API_FEATURE_MS_VISUALS
/**< support for multisample visuals */
80 /* for feature_mask in st_api */
81 #define ST_API_FEATURE_MS_VISUALS_MASK (1 << ST_API_FEATURE_MS_VISUALS)
84 * New context flags for GL 3.0 and beyond.
86 * Profile information (core vs. compatibilty for OpenGL 3.2+) is communicated
87 * through the \c st_profile_type, not through flags.
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 #define ST_CONTEXT_FLAG_NO_ERROR (1 << 4)
96 * Reasons that context creation might fail.
98 enum st_context_error
{
99 ST_CONTEXT_SUCCESS
= 0,
100 ST_CONTEXT_ERROR_NO_MEMORY
,
101 ST_CONTEXT_ERROR_BAD_API
,
102 ST_CONTEXT_ERROR_BAD_VERSION
,
103 ST_CONTEXT_ERROR_BAD_FLAG
,
104 ST_CONTEXT_ERROR_UNKNOWN_ATTRIBUTE
,
105 ST_CONTEXT_ERROR_UNKNOWN_FLAG
109 * Used in st_context_iface->teximage.
111 enum st_texture_type
{
119 * Available attachments of framebuffer.
121 enum st_attachment_type
{
122 ST_ATTACHMENT_FRONT_LEFT
,
123 ST_ATTACHMENT_BACK_LEFT
,
124 ST_ATTACHMENT_FRONT_RIGHT
,
125 ST_ATTACHMENT_BACK_RIGHT
,
126 ST_ATTACHMENT_DEPTH_STENCIL
,
128 ST_ATTACHMENT_SAMPLE
,
131 ST_ATTACHMENT_INVALID
= -1
134 /* for buffer_mask in st_visual */
135 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
136 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
137 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
138 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
139 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
140 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
141 #define ST_ATTACHMENT_SAMPLE_MASK (1 << ST_ATTACHMENT_SAMPLE)
144 * Enumerations of state tracker context resources.
146 enum st_context_resource_type
{
147 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D
,
148 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D
,
149 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X
,
150 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X
,
151 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y
,
152 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y
,
153 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z
,
154 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z
,
155 ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER
,
156 ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
162 #define ST_FLUSH_FRONT (1 << 0)
163 #define ST_FLUSH_END_OF_FRAME (1 << 1)
164 #define ST_FLUSH_WAIT (1 << 2)
167 * Value to st_manager->get_param function.
169 enum st_manager_param
{
171 * The dri state tracker on old libGL's doesn't do the right thing
172 * with regards to invalidating the framebuffers.
174 * For the mesa state tracker that means that it needs to invalidate
175 * the framebuffer in glViewport itself.
177 ST_MANAGER_BROKEN_INVALIDATE
181 struct pipe_resource
;
182 struct pipe_fence_handle
;
183 struct util_queue_monitoring
;
186 * Used in st_context_iface->get_resource_for_egl_image.
188 struct st_context_resource
190 /* these fields are filled in by the caller */
191 enum st_context_resource_type type
;
194 /* this is owned by the caller */
195 struct pipe_resource
*texture
;
199 * Used in st_manager_iface->get_egl_image.
203 /* this is owned by the caller */
204 struct pipe_resource
*texture
;
206 /* format only differs from texture->format for multi-planar (YUV): */
207 enum pipe_format format
;
214 * Represent the visual of a framebuffer.
219 * Available buffers. Bitfield of ST_ATTACHMENT_*_MASK bits.
221 unsigned buffer_mask
;
224 * Buffer formats. The formats are always set even when the buffer is
227 enum pipe_format color_format
;
228 enum pipe_format depth_stencil_format
;
229 enum pipe_format accum_format
;
233 * Desired render buffer.
235 enum st_attachment_type render_buffer
;
240 * Configuration options from driconf
242 struct st_config_options
244 boolean disable_blend_func_extended
;
245 boolean disable_glsl_line_continuations
;
246 boolean disable_shader_bit_encoding
;
247 boolean force_glsl_extensions_warn
;
248 unsigned force_glsl_version
;
249 boolean force_s3tc_enable
;
250 boolean allow_glsl_extension_directive_midshader
;
251 boolean allow_glsl_builtin_variable_redeclaration
;
252 boolean allow_higher_compat_version
;
253 boolean glsl_zero_init
;
254 boolean force_glsl_abs_sqrt
;
255 unsigned char config_options_sha1
[20];
259 * Represent the attributes of a context.
261 struct st_context_attribs
264 * The profile and minimal version to support.
266 * The valid profiles and versions are rendering API dependent. The latest
267 * version satisfying the request should be returned.
269 enum st_profile_type profile
;
272 /** Mask of ST_CONTEXT_FLAG_x bits */
276 * The visual of the framebuffers the context will be bound to.
278 struct st_visual visual
;
281 * Configuration options.
283 struct st_config_options options
;
286 struct st_context_iface
;
289 * Represent a windowing system drawable.
291 * The framebuffer is implemented by the state tracker manager and
292 * used by the state trackers.
294 * Instead of the winsys poking into the API context to figure
295 * out what buffers that might be needed in the future by the API
296 * context, it calls into the framebuffer to get the textures.
298 * This structure along with the notify_invalid_framebuffer
299 * allows framebuffers to be shared between different threads
300 * but at the same make the API context free from thread
301 * synchronization primitves, with the exception of a small
302 * atomic flag used for notification of framebuffer dirty status.
304 * The thread synchronization is put inside the framebuffer
305 * and only called once the framebuffer has become dirty.
307 struct st_framebuffer_iface
310 * Atomic stamp which changes when framebuffers need to be updated.
315 * Identifier that uniquely identifies the framebuffer interface object.
320 * Available for the state tracker manager to use.
322 void *st_manager_private
;
325 * The visual of a framebuffer.
327 const struct st_visual
*visual
;
330 * Flush the front buffer.
332 * On some window systems, changes to the front buffers are not immediately
333 * visible. They need to be flushed.
335 * @att is one of the front buffer attachments.
337 boolean (*flush_front
)(struct st_context_iface
*stctx
,
338 struct st_framebuffer_iface
*stfbi
,
339 enum st_attachment_type statt
);
342 * The state tracker asks for the textures it needs.
344 * It should try to only ask for attachments that it currently renders
345 * to, thus allowing the winsys to delay the allocation of textures not
346 * needed. For example front buffer attachments are not needed if you
347 * only do back buffer rendering.
349 * The implementor of this function needs to also ensure
350 * thread safty as this call might be done from multiple threads.
352 * The returned textures are owned by the caller. They should be
353 * unreferenced when no longer used. If this function is called multiple
354 * times with different sets of attachments, those buffers not included in
355 * the last call might be destroyed. This behavior might change in the
358 boolean (*validate
)(struct st_context_iface
*stctx
,
359 struct st_framebuffer_iface
*stfbi
,
360 const enum st_attachment_type
*statts
,
362 struct pipe_resource
**out
);
366 * Represent a rendering context.
368 * This entity is created from st_api and used by the state tracker manager.
370 struct st_context_iface
373 * Available for the state tracker and the manager to use.
375 void *st_context_private
;
376 void *st_manager_private
;
379 * The CSO context associated with this context in case we need to draw
380 * something before swap buffers.
382 struct cso_context
*cso_context
;
385 * The gallium context.
387 struct pipe_context
*pipe
;
390 * Destroy the context.
392 void (*destroy
)(struct st_context_iface
*stctxi
);
395 * Flush all drawing from context to the pipe also flushes the pipe.
397 void (*flush
)(struct st_context_iface
*stctxi
, unsigned flags
,
398 struct pipe_fence_handle
**fence
);
401 * Replace the texture image of a texture object at the specified level.
403 * This function is optional.
405 boolean (*teximage
)(struct st_context_iface
*stctxi
,
406 enum st_texture_type target
,
407 int level
, enum pipe_format internal_format
,
408 struct pipe_resource
*tex
, boolean mipmap
);
411 * Used to implement glXCopyContext.
413 void (*copy
)(struct st_context_iface
*stctxi
,
414 struct st_context_iface
*stsrci
, unsigned mask
);
417 * Used to implement wglShareLists.
419 boolean (*share
)(struct st_context_iface
*stctxi
,
420 struct st_context_iface
*stsrci
);
423 * Look up and return the info of a resource for EGLImage.
425 * This function is optional.
427 boolean (*get_resource_for_egl_image
)(struct st_context_iface
*stctxi
,
428 struct st_context_resource
*stres
);
431 * Start the thread if the API has a worker thread.
432 * Called after the context has been created and fully initialized on both
433 * sides (e.g. st/mesa and st/dri).
435 void (*start_thread
)(struct st_context_iface
*stctxi
);
438 * If the API is multithreaded, wait for all queued commands to complete.
439 * Called from the main thread.
441 void (*thread_finish
)(struct st_context_iface
*stctxi
);
446 * Represent a state tracker manager.
448 * This interface is implemented by the state tracker manager. It corresponds
449 * to a "display" in the window system.
453 struct pipe_screen
*screen
;
456 * Look up and return the info of an EGLImage.
458 * This is used to implement for example EGLImageTargetTexture2DOES.
459 * The GLeglImageOES agrument of that call is passed directly to this
460 * function call and the information needed to access this is returned
461 * in the given struct out.
463 * @smapi: manager owning the caller context
464 * @stctx: caller context
465 * @egl_image: EGLImage that caller recived
466 * @out: return struct filled out with access information.
468 * This function is optional.
470 boolean (*get_egl_image
)(struct st_manager
*smapi
,
472 struct st_egl_image
*out
);
475 * Query an manager param.
477 int (*get_param
)(struct st_manager
*smapi
,
478 enum st_manager_param param
);
481 * Call the loader function setBackgroundContext. Called from the worker
484 void (*set_background_context
)(struct st_context_iface
*stctxi
,
485 struct util_queue_monitoring
*queue_info
);
489 * Represent a rendering API such as OpenGL or OpenVG.
491 * Implemented by the state tracker and used by the state tracker manager.
496 * The name of the rendering API. This is informative.
501 * The supported rendering API.
503 enum st_api_type api
;
506 * The supported profiles. Tested with ST_PROFILE_*_MASK.
508 unsigned profile_mask
;
511 * The supported optional features. Tested with ST_FEATURE_*_MASK.
513 unsigned feature_mask
;
518 void (*destroy
)(struct st_api
*stapi
);
521 * Query supported OpenGL versions. (if applicable)
522 * The format is (major*10+minor).
524 void (*query_versions
)(struct st_api
*stapi
, struct st_manager
*sm
,
525 struct st_config_options
*options
,
526 int *gl_core_version
,
527 int *gl_compat_version
,
529 int *gl_es2_version
);
532 * Create a rendering context.
534 struct st_context_iface
*(*create_context
)(struct st_api
*stapi
,
535 struct st_manager
*smapi
,
536 const struct st_context_attribs
*attribs
,
537 enum st_context_error
*error
,
538 struct st_context_iface
*stsharei
);
541 * Bind the context to the calling thread with draw and read as drawables.
543 * The framebuffers might be NULL, or might have different visuals than the
546 boolean (*make_current
)(struct st_api
*stapi
,
547 struct st_context_iface
*stctxi
,
548 struct st_framebuffer_iface
*stdrawi
,
549 struct st_framebuffer_iface
*streadi
);
552 * Get the currently bound context in the calling thread.
554 struct st_context_iface
*(*get_current
)(struct st_api
*stapi
);
558 * Return true if the visual has the specified buffers.
560 static inline boolean
561 st_visual_have_buffers(const struct st_visual
*visual
, unsigned mask
)
563 return ((visual
->buffer_mask
& mask
) == mask
);
566 #endif /* _ST_API_H_ */