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)
95 * Reasons that context creation might fail.
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
108 * Used in st_context_iface->teximage.
110 enum st_texture_type
{
118 * Available attachments of framebuffer.
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
,
127 ST_ATTACHMENT_SAMPLE
,
130 ST_ATTACHMENT_INVALID
= -1
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)
143 * Enumerations of state tracker context resources.
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
161 #define ST_FLUSH_FRONT (1 << 0)
162 #define ST_FLUSH_END_OF_FRAME (1 << 1)
165 * Value to st_manager->get_param function.
167 enum st_manager_param
{
169 * The dri state tracker on old libGL's doesn't do the right thing
170 * with regards to invalidating the framebuffers.
172 * For the mesa state tracker that means that it needs to invalidate
173 * the framebuffer in glViewport itself.
175 ST_MANAGER_BROKEN_INVALIDATE
179 struct pipe_resource
;
180 struct pipe_fence_handle
;
183 * Used in st_context_iface->get_resource_for_egl_image.
185 struct st_context_resource
187 /* these fields are filled in by the caller */
188 enum st_context_resource_type type
;
191 /* this is owned by the caller */
192 struct pipe_resource
*texture
;
196 * Used in st_manager_iface->get_egl_image.
200 /* this is owned by the caller */
201 struct pipe_resource
*texture
;
208 * Represent the visual of a framebuffer.
213 * Available buffers. Tested with ST_FRAMEBUFFER_*_MASK.
215 unsigned buffer_mask
;
218 * Buffer formats. The formats are always set even when the buffer is
221 enum pipe_format color_format
;
222 enum pipe_format depth_stencil_format
;
223 enum pipe_format accum_format
;
227 * Desired render buffer.
229 enum st_attachment_type render_buffer
;
234 * Configuration options from driconf
236 struct st_config_options
238 boolean disable_blend_func_extended
;
239 boolean disable_glsl_line_continuations
;
240 boolean disable_shader_bit_encoding
;
241 boolean force_glsl_extensions_warn
;
242 unsigned force_glsl_version
;
243 boolean force_s3tc_enable
;
244 boolean allow_glsl_extension_directive_midshader
;
248 * Represent the attributes of a context.
250 struct st_context_attribs
253 * The profile and minimal version to support.
255 * The valid profiles and versions are rendering API dependent. The latest
256 * version satisfying the request should be returned.
258 enum st_profile_type profile
;
261 /** Mask of ST_CONTEXT_FLAG_x bits */
265 * The visual of the framebuffers the context will be bound to.
267 struct st_visual visual
;
270 * Configuration options.
272 struct st_config_options options
;
275 struct st_context_iface
;
278 * Represent a windowing system drawable.
280 * The framebuffer is implemented by the state tracker manager and
281 * used by the state trackers.
283 * Instead of the winsys poking into the API context to figure
284 * out what buffers that might be needed in the future by the API
285 * context, it calls into the framebuffer to get the textures.
287 * This structure along with the notify_invalid_framebuffer
288 * allows framebuffers to be shared between different threads
289 * but at the same make the API context free from thread
290 * synchronization primitves, with the exception of a small
291 * atomic flag used for notification of framebuffer dirty status.
293 * The thread synchronization is put inside the framebuffer
294 * and only called once the framebuffer has become dirty.
296 struct st_framebuffer_iface
299 * Atomic stamp which changes when framebuffers need to be updated.
304 * Available for the state tracker manager to use.
306 void *st_manager_private
;
309 * The visual of a framebuffer.
311 const struct st_visual
*visual
;
314 * Flush the front buffer.
316 * On some window systems, changes to the front buffers are not immediately
317 * visible. They need to be flushed.
319 * @att is one of the front buffer attachments.
321 boolean (*flush_front
)(struct st_context_iface
*stctx
,
322 struct st_framebuffer_iface
*stfbi
,
323 enum st_attachment_type statt
);
326 * The state tracker asks for the textures it needs.
328 * It should try to only ask for attachments that it currently renders
329 * to, thus allowing the winsys to delay the allocation of textures not
330 * needed. For example front buffer attachments are not needed if you
331 * only do back buffer rendering.
333 * The implementor of this function needs to also ensure
334 * thread safty as this call might be done from multiple threads.
336 * The returned textures are owned by the caller. They should be
337 * unreferenced when no longer used. If this function is called multiple
338 * times with different sets of attachments, those buffers not included in
339 * the last call might be destroyed. This behavior might change in the
342 boolean (*validate
)(struct st_context_iface
*stctx
,
343 struct st_framebuffer_iface
*stfbi
,
344 const enum st_attachment_type
*statts
,
346 struct pipe_resource
**out
);
350 * Represent a rendering context.
352 * This entity is created from st_api and used by the state tracker manager.
354 struct st_context_iface
357 * Available for the state tracker and the manager to use.
359 void *st_context_private
;
360 void *st_manager_private
;
363 * The CSO context associated with this context in case we need to draw
364 * something before swap buffers.
366 struct cso_context
*cso_context
;
369 * The gallium context.
371 struct pipe_context
*pipe
;
374 * Destroy the context.
376 void (*destroy
)(struct st_context_iface
*stctxi
);
379 * Flush all drawing from context to the pipe also flushes the pipe.
381 void (*flush
)(struct st_context_iface
*stctxi
, unsigned flags
,
382 struct pipe_fence_handle
**fence
);
385 * Replace the texture image of a texture object at the specified level.
387 * This function is optional.
389 boolean (*teximage
)(struct st_context_iface
*stctxi
,
390 enum st_texture_type target
,
391 int level
, enum pipe_format internal_format
,
392 struct pipe_resource
*tex
, boolean mipmap
);
395 * Used to implement glXCopyContext.
397 void (*copy
)(struct st_context_iface
*stctxi
,
398 struct st_context_iface
*stsrci
, unsigned mask
);
401 * Used to implement wglShareLists.
403 boolean (*share
)(struct st_context_iface
*stctxi
,
404 struct st_context_iface
*stsrci
);
407 * Look up and return the info of a resource for EGLImage.
409 * This function is optional.
411 boolean (*get_resource_for_egl_image
)(struct st_context_iface
*stctxi
,
412 struct st_context_resource
*stres
);
417 * Represent a state tracker manager.
419 * This interface is implemented by the state tracker manager. It corresponds
420 * to a "display" in the window system.
424 struct pipe_screen
*screen
;
427 * Look up and return the info of an EGLImage.
429 * This is used to implement for example EGLImageTargetTexture2DOES.
430 * The GLeglImageOES agrument of that call is passed directly to this
431 * function call and the information needed to access this is returned
432 * in the given struct out.
434 * @smapi: manager owning the caller context
435 * @stctx: caller context
436 * @egl_image: EGLImage that caller recived
437 * @out: return struct filled out with access information.
439 * This function is optional.
441 boolean (*get_egl_image
)(struct st_manager
*smapi
,
443 struct st_egl_image
*out
);
446 * Query an manager param.
448 int (*get_param
)(struct st_manager
*smapi
,
449 enum st_manager_param param
);
453 * Represent a rendering API such as OpenGL or OpenVG.
455 * Implemented by the state tracker and used by the state tracker manager.
460 * The name of the rendering API. This is informative.
465 * The supported rendering API.
467 enum st_api_type api
;
470 * The supported profiles. Tested with ST_PROFILE_*_MASK.
472 unsigned profile_mask
;
475 * The supported optional features. Tested with ST_FEATURE_*_MASK.
477 unsigned feature_mask
;
482 void (*destroy
)(struct st_api
*stapi
);
485 * Query supported OpenGL versions. (if applicable)
486 * The format is (major*10+minor).
488 void (*query_versions
)(struct st_api
*stapi
, struct st_manager
*sm
,
489 struct st_config_options
*options
,
490 int *gl_core_version
,
491 int *gl_compat_version
,
493 int *gl_es2_version
);
496 * Create a rendering context.
498 struct st_context_iface
*(*create_context
)(struct st_api
*stapi
,
499 struct st_manager
*smapi
,
500 const struct st_context_attribs
*attribs
,
501 enum st_context_error
*error
,
502 struct st_context_iface
*stsharei
);
505 * Bind the context to the calling thread with draw and read as drawables.
507 * The framebuffers might be NULL, or might have different visuals than the
510 boolean (*make_current
)(struct st_api
*stapi
,
511 struct st_context_iface
*stctxi
,
512 struct st_framebuffer_iface
*stdrawi
,
513 struct st_framebuffer_iface
*streadi
);
516 * Get the currently bound context in the calling thread.
518 struct st_context_iface
*(*get_current
)(struct st_api
*stapi
);
522 * Return true if the visual has the specified buffers.
524 static inline boolean
525 st_visual_have_buffers(const struct st_visual
*visual
, unsigned mask
)
527 return ((visual
->buffer_mask
& mask
) == mask
);
530 #endif /* _ST_API_H_ */