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 * Used in st_context_iface->teximage.
75 enum st_texture_type
{
83 * Available attachments of framebuffer.
85 enum st_attachment_type
{
86 ST_ATTACHMENT_FRONT_LEFT
,
87 ST_ATTACHMENT_BACK_LEFT
,
88 ST_ATTACHMENT_FRONT_RIGHT
,
89 ST_ATTACHMENT_BACK_RIGHT
,
90 ST_ATTACHMENT_DEPTH_STENCIL
,
95 ST_ATTACHMENT_INVALID
= -1
98 /* for buffer_mask in st_visual */
99 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
100 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
101 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
102 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
103 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
104 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
105 #define ST_ATTACHMENT_SAMPLE_MASK (1 << ST_ATTACHMENT_SAMPLE)
108 * Enumerations of state tracker context resources.
110 enum st_context_resource_type
{
111 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D
,
112 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D
,
113 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X
,
114 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X
,
115 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y
,
116 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y
,
117 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z
,
118 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z
,
119 ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER
,
120 ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
124 * Value to st_manager->get_param function.
126 enum st_manager_param
{
128 * The dri state tracker on old libGL's doesn't do the right thing
129 * with regards to invalidating the framebuffers.
131 * For the mesa state tracker that means that it needs to invalidate
132 * the framebuffer in glViewport itself.
134 ST_MANAGER_BROKEN_INVALIDATE
138 * The return type of st_api->get_proc_address.
140 typedef void (*st_proc_t
)(void);
143 struct pipe_resource
;
144 struct pipe_fence_handle
;
147 * Used in st_context_iface->get_resource_for_egl_image.
149 struct st_context_resource
151 /* these fields are filled by the caller */
152 enum st_context_resource_type type
;
155 /* this is owned by the caller */
156 struct pipe_resource
*texture
;
160 * Used in st_manager_iface->get_egl_image.
164 /* this is owned by the caller */
165 struct pipe_resource
*texture
;
172 * Represent the visual of a framebuffer.
177 * Available buffers. Tested with ST_FRAMEBUFFER_*_MASK.
179 unsigned buffer_mask
;
182 * Buffer formats. The formats are always set even when the buffer is
185 enum pipe_format color_format
;
186 enum pipe_format depth_stencil_format
;
187 enum pipe_format accum_format
;
191 * Desired render buffer.
193 enum st_attachment_type render_buffer
;
197 * Represent the attributes of a context.
199 struct st_context_attribs
202 * The profile and minimal version to support.
204 * The valid profiles and versions are rendering API dependent. The latest
205 * version satisfying the request should be returned, unless
206 * forward_compatiible is true.
208 enum st_profile_type profile
;
217 * Return the exact version and disallow the use of deprecated features.
219 boolean forward_compatible
;
222 * The visual of the framebuffers the context will be bound to.
224 struct st_visual visual
;
228 * Represent a windowing system drawable.
230 * The framebuffer is implemented by the state tracker manager and
231 * used by the state trackers.
233 * Instead of the winsys pokeing into the API context to figure
234 * out what buffers that might be needed in the future by the API
235 * context, it calls into the framebuffer to get the textures.
237 * This structure along with the notify_invalid_framebuffer
238 * allows framebuffers to be shared between different threads
239 * but at the same make the API context free from thread
240 * syncronisation primitves, with the exception of a small
241 * atomic flag used for notification of framebuffer dirty status.
243 * The thread syncronisation is put inside the framebuffer
244 * and only called once the framebuffer has become dirty.
246 struct st_framebuffer_iface
249 * Available for the state tracker manager to use.
251 void *st_manager_private
;
254 * The visual of a framebuffer.
256 const struct st_visual
*visual
;
259 * Flush the front buffer.
261 * On some window systems, changes to the front buffers are not immediately
262 * visible. They need to be flushed.
264 * @att is one of the front buffer attachments.
266 boolean (*flush_front
)(struct st_framebuffer_iface
*stfbi
,
267 enum st_attachment_type statt
);
270 * The state tracker asks for the textures it needs.
272 * It should try to only ask for attachments that it currently renders
273 * to, thus allowing the winsys to delay the allocation of textures not
274 * needed. For example front buffer attachments are not needed if you
275 * only do back buffer rendering.
277 * The implementor of this function needs to also ensure
278 * thread safty as this call might be done from multiple threads.
280 * The returned textures are owned by the caller. They should be
281 * unreferenced when no longer used. If this function is called multiple
282 * times with different sets of attachments, those buffers not included in
283 * the last call might be destroyed. This behavior might change in the
286 boolean (*validate
)(struct st_framebuffer_iface
*stfbi
,
287 const enum st_attachment_type
*statts
,
289 struct pipe_resource
**out
);
293 * Represent a rendering context.
295 * This entity is created from st_api and used by the state tracker manager.
297 struct st_context_iface
300 * Available for the state tracker and the manager to use.
302 void *st_context_private
;
303 void *st_manager_private
;
306 * Destroy the context.
308 void (*destroy
)(struct st_context_iface
*stctxi
);
311 * Invalidate the current textures that was taken from a framebuffer.
313 * The state tracker manager calls this function to let the rendering
314 * context know that it should update the textures it got from
315 * st_framebuffer_iface::validate. It should do so at the latest time possible.
316 * Possible right before sending triangles to the pipe context.
318 * For certain platforms this function might be called from a thread other
319 * than the thread that the context is currently bound in, and must
320 * therefore be thread safe. But it is the state tracker manager's
321 * responsibility to make sure that the framebuffer is bound to the context
322 * and the API context is current for the duration of this call.
324 * Thus reducing the sync primitive needed to a single atomic flag.
326 void (*notify_invalid_framebuffer
)(struct st_context_iface
*stctxi
,
327 struct st_framebuffer_iface
*stfbi
);
330 * Flush all drawing from context to the pipe also flushes the pipe.
332 void (*flush
)(struct st_context_iface
*stctxi
, unsigned flags
,
333 struct pipe_fence_handle
**fence
);
336 * Replace the texture image of a texture object at the specified level.
338 * This function is optional.
340 boolean (*teximage
)(struct st_context_iface
*stctxi
, enum st_texture_type target
,
341 int level
, enum pipe_format internal_format
,
342 struct pipe_resource
*tex
, boolean mipmap
);
345 * Used to implement glXCopyContext.
347 void (*copy
)(struct st_context_iface
*stctxi
,
348 struct st_context_iface
*stsrci
, unsigned mask
);
351 * Used to implement wglShareLists.
353 boolean (*share
)(struct st_context_iface
*stctxi
,
354 struct st_context_iface
*stsrci
);
357 * Look up and return the info of a resource for EGLImage.
359 * This function is optional.
361 boolean (*get_resource_for_egl_image
)(struct st_context_iface
*stctxi
,
362 struct st_context_resource
*stres
);
367 * Represent a state tracker manager.
369 * This interface is implemented by the state tracker manager. It corresponds
370 * to a "display" in the window system.
374 struct pipe_screen
*screen
;
377 * Look up and return the info of an EGLImage.
379 * This is used to implement for example EGLImageTargetTexture2DOES.
380 * The GLeglImageOES agrument of that call is passed directly to this
381 * function call and the information needed to access this is returned
382 * in the given struct out.
384 * @smapi: manager owning the caller context
385 * @stctx: caller context
386 * @egl_image: EGLImage that caller recived
387 * @out: return struct filled out with access information.
389 * This function is optional.
391 boolean (*get_egl_image
)(struct st_manager
*smapi
,
393 struct st_egl_image
*out
);
396 * Query an manager param.
398 int (*get_param
)(struct st_manager
*smapi
,
399 enum st_manager_param param
);
403 * Represent a rendering API such as OpenGL or OpenVG.
405 * Implemented by the state tracker and used by the state tracker manager.
410 * The name of the rendering API. This is informative.
415 * The supported rendering API.
417 enum st_api_type api
;
420 * The supported profiles. Tested with ST_PROFILE_*_MASK.
422 unsigned profile_mask
;
427 void (*destroy
)(struct st_api
*stapi
);
430 * Return an API entry point.
432 * For GL this is the same as _glapi_get_proc_address.
434 st_proc_t (*get_proc_address
)(struct st_api
*stapi
, const char *procname
);
437 * Create a rendering context.
439 struct st_context_iface
*(*create_context
)(struct st_api
*stapi
,
440 struct st_manager
*smapi
,
441 const struct st_context_attribs
*attribs
,
442 struct st_context_iface
*stsharei
);
445 * Bind the context to the calling thread with draw and read as drawables.
447 * The framebuffers might be NULL, or might have different visuals than the
450 boolean (*make_current
)(struct st_api
*stapi
,
451 struct st_context_iface
*stctxi
,
452 struct st_framebuffer_iface
*stdrawi
,
453 struct st_framebuffer_iface
*streadi
);
456 * Get the currently bound context in the calling thread.
458 struct st_context_iface
*(*get_current
)(struct st_api
*stapi
);
462 * Return true if the visual has the specified buffers.
464 static INLINE boolean
465 st_visual_have_buffers(const struct st_visual
*visual
, unsigned mask
)
467 return ((visual
->buffer_mask
& mask
) == mask
);
470 #endif /* _ST_API_H_ */