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.
61 ST_PROFILE_OPENGL_CORE
,
62 ST_PROFILE_OPENGL_ES1
,
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 * New context flags for GL 3.0 and beyond.
75 #define ST_CONTEXT_FLAG_CORE_PROFILE (1 << 0)
76 #define ST_CONTEXT_FLAG_COMPATIBLE_PROFILE (1 << 1)
77 #define ST_CONTEXT_FLAG_FORWARD_COMPATIBLE (1 << 2)
78 #define ST_CONTEXT_FLAG_DEBUG (1 << 3)
79 #define ST_CONTEXT_FLAG_ROBUST_ACCESS (1 << 4)
82 * Used in st_context_iface->teximage.
84 enum st_texture_type
{
92 * Available attachments of framebuffer.
94 enum st_attachment_type
{
95 ST_ATTACHMENT_FRONT_LEFT
,
96 ST_ATTACHMENT_BACK_LEFT
,
97 ST_ATTACHMENT_FRONT_RIGHT
,
98 ST_ATTACHMENT_BACK_RIGHT
,
99 ST_ATTACHMENT_DEPTH_STENCIL
,
101 ST_ATTACHMENT_SAMPLE
,
104 ST_ATTACHMENT_INVALID
= -1
107 /* for buffer_mask in st_visual */
108 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
109 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
110 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
111 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
112 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
113 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
114 #define ST_ATTACHMENT_SAMPLE_MASK (1 << ST_ATTACHMENT_SAMPLE)
117 * Enumerations of state tracker context resources.
119 enum st_context_resource_type
{
120 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D
,
121 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D
,
122 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X
,
123 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X
,
124 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y
,
125 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y
,
126 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z
,
127 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z
,
128 ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER
,
129 ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
135 #define ST_FLUSH_FRONT (1 << 0)
138 * Value to st_manager->get_param function.
140 enum st_manager_param
{
142 * The dri state tracker on old libGL's doesn't do the right thing
143 * with regards to invalidating the framebuffers.
145 * For the mesa state tracker that means that it needs to invalidate
146 * the framebuffer in glViewport itself.
148 ST_MANAGER_BROKEN_INVALIDATE
152 * The return type of st_api->get_proc_address.
154 typedef void (*st_proc_t
)(void);
157 struct pipe_resource
;
158 struct pipe_fence_handle
;
161 * Used in st_context_iface->get_resource_for_egl_image.
163 struct st_context_resource
165 /* these fields are filled by the caller */
166 enum st_context_resource_type type
;
169 /* this is owned by the caller */
170 struct pipe_resource
*texture
;
174 * Used in st_manager_iface->get_egl_image.
178 /* this is owned by the caller */
179 struct pipe_resource
*texture
;
186 * Represent the visual of a framebuffer.
191 * Available buffers. Tested with ST_FRAMEBUFFER_*_MASK.
193 unsigned buffer_mask
;
196 * Buffer formats. The formats are always set even when the buffer is
199 enum pipe_format color_format
;
200 enum pipe_format depth_stencil_format
;
201 enum pipe_format accum_format
;
205 * Desired render buffer.
207 enum st_attachment_type render_buffer
;
211 * Represent the attributes of a context.
213 struct st_context_attribs
216 * The profile and minimal version to support.
218 * The valid profiles and versions are rendering API dependent. The latest
219 * version satisfying the request should be returned, unless the
220 * ST_CONTEXT_FLAG_FORWARD_COMPATIBLE bit is set.
222 enum st_profile_type profile
;
225 /** Mask of ST_CONTEXT_FLAG_x bits */
229 * The visual of the framebuffers the context will be bound to.
231 struct st_visual visual
;
235 * Represent a windowing system drawable.
237 * The framebuffer is implemented by the state tracker manager and
238 * used by the state trackers.
240 * Instead of the winsys pokeing into the API context to figure
241 * out what buffers that might be needed in the future by the API
242 * context, it calls into the framebuffer to get the textures.
244 * This structure along with the notify_invalid_framebuffer
245 * allows framebuffers to be shared between different threads
246 * but at the same make the API context free from thread
247 * syncronisation primitves, with the exception of a small
248 * atomic flag used for notification of framebuffer dirty status.
250 * The thread syncronisation is put inside the framebuffer
251 * and only called once the framebuffer has become dirty.
253 struct st_framebuffer_iface
256 * Atomic stamp which changes when framebuffers need to be updated.
262 * Available for the state tracker manager to use.
264 void *st_manager_private
;
267 * The visual of a framebuffer.
269 const struct st_visual
*visual
;
272 * Flush the front buffer.
274 * On some window systems, changes to the front buffers are not immediately
275 * visible. They need to be flushed.
277 * @att is one of the front buffer attachments.
279 boolean (*flush_front
)(struct st_framebuffer_iface
*stfbi
,
280 enum st_attachment_type statt
);
283 * The state tracker asks for the textures it needs.
285 * It should try to only ask for attachments that it currently renders
286 * to, thus allowing the winsys to delay the allocation of textures not
287 * needed. For example front buffer attachments are not needed if you
288 * only do back buffer rendering.
290 * The implementor of this function needs to also ensure
291 * thread safty as this call might be done from multiple threads.
293 * The returned textures are owned by the caller. They should be
294 * unreferenced when no longer used. If this function is called multiple
295 * times with different sets of attachments, those buffers not included in
296 * the last call might be destroyed. This behavior might change in the
299 boolean (*validate
)(struct st_framebuffer_iface
*stfbi
,
300 const enum st_attachment_type
*statts
,
302 struct pipe_resource
**out
);
306 * Represent a rendering context.
308 * This entity is created from st_api and used by the state tracker manager.
310 struct st_context_iface
313 * Available for the state tracker and the manager to use.
315 void *st_context_private
;
316 void *st_manager_private
;
319 * Destroy the context.
321 void (*destroy
)(struct st_context_iface
*stctxi
);
324 * Flush all drawing from context to the pipe also flushes the pipe.
326 void (*flush
)(struct st_context_iface
*stctxi
, unsigned flags
,
327 struct pipe_fence_handle
**fence
);
330 * Replace the texture image of a texture object at the specified level.
332 * This function is optional.
334 boolean (*teximage
)(struct st_context_iface
*stctxi
, enum st_texture_type target
,
335 int level
, enum pipe_format internal_format
,
336 struct pipe_resource
*tex
, boolean mipmap
);
339 * Used to implement glXCopyContext.
341 void (*copy
)(struct st_context_iface
*stctxi
,
342 struct st_context_iface
*stsrci
, unsigned mask
);
345 * Used to implement wglShareLists.
347 boolean (*share
)(struct st_context_iface
*stctxi
,
348 struct st_context_iface
*stsrci
);
351 * Look up and return the info of a resource for EGLImage.
353 * This function is optional.
355 boolean (*get_resource_for_egl_image
)(struct st_context_iface
*stctxi
,
356 struct st_context_resource
*stres
);
361 * Represent a state tracker manager.
363 * This interface is implemented by the state tracker manager. It corresponds
364 * to a "display" in the window system.
368 struct pipe_screen
*screen
;
371 * Look up and return the info of an EGLImage.
373 * This is used to implement for example EGLImageTargetTexture2DOES.
374 * The GLeglImageOES agrument of that call is passed directly to this
375 * function call and the information needed to access this is returned
376 * in the given struct out.
378 * @smapi: manager owning the caller context
379 * @stctx: caller context
380 * @egl_image: EGLImage that caller recived
381 * @out: return struct filled out with access information.
383 * This function is optional.
385 boolean (*get_egl_image
)(struct st_manager
*smapi
,
387 struct st_egl_image
*out
);
390 * Query an manager param.
392 int (*get_param
)(struct st_manager
*smapi
,
393 enum st_manager_param param
);
397 * Represent a rendering API such as OpenGL or OpenVG.
399 * Implemented by the state tracker and used by the state tracker manager.
404 * The name of the rendering API. This is informative.
409 * The supported rendering API.
411 enum st_api_type api
;
414 * The supported profiles. Tested with ST_PROFILE_*_MASK.
416 unsigned profile_mask
;
421 void (*destroy
)(struct st_api
*stapi
);
424 * Return an API entry point.
426 * For GL this is the same as _glapi_get_proc_address.
428 st_proc_t (*get_proc_address
)(struct st_api
*stapi
, const char *procname
);
431 * Create a rendering context.
433 struct st_context_iface
*(*create_context
)(struct st_api
*stapi
,
434 struct st_manager
*smapi
,
435 const struct st_context_attribs
*attribs
,
436 struct st_context_iface
*stsharei
);
439 * Bind the context to the calling thread with draw and read as drawables.
441 * The framebuffers might be NULL, or might have different visuals than the
444 boolean (*make_current
)(struct st_api
*stapi
,
445 struct st_context_iface
*stctxi
,
446 struct st_framebuffer_iface
*stdrawi
,
447 struct st_framebuffer_iface
*streadi
);
450 * Get the currently bound context in the calling thread.
452 struct st_context_iface
*(*get_current
)(struct st_api
*stapi
);
456 * Return true if the visual has the specified buffers.
458 static INLINE boolean
459 st_visual_have_buffers(const struct st_visual
*visual
, unsigned mask
)
461 return ((visual
->buffer_mask
& mask
) == mask
);
464 #endif /* _ST_API_H_ */