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 entry points of the state trackers.
48 #define ST_MODULE_OPENGL_SYMBOL "st_module_OpenGL"
49 #define ST_MODULE_OPENGL_ES1_SYMBOL "st_module_OpenGL_ES1"
50 #define ST_MODULE_OPENGL_ES2_SYMBOL "st_module_OpenGL_ES2"
51 #define ST_MODULE_OPENVG_SYMBOL "st_module_OpenVG"
54 * The supported rendering API of a state tracker.
66 * Used in st_context_iface->teximage.
68 enum st_texture_type
{
76 * Available attachments of framebuffer.
78 enum st_attachment_type
{
79 ST_ATTACHMENT_FRONT_LEFT
,
80 ST_ATTACHMENT_BACK_LEFT
,
81 ST_ATTACHMENT_FRONT_RIGHT
,
82 ST_ATTACHMENT_BACK_RIGHT
,
83 ST_ATTACHMENT_DEPTH_STENCIL
,
88 ST_ATTACHMENT_INVALID
= -1
91 /* for buffer_mask in st_visual */
92 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
93 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
94 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
95 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
96 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
97 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
98 #define ST_ATTACHMENT_SAMPLE_MASK (1 << ST_ATTACHMENT_SAMPLE)
101 * Enumerations of state tracker context resources.
103 enum st_context_resource_type
{
104 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D
,
105 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D
,
106 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X
,
107 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X
,
108 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y
,
109 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y
,
110 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z
,
111 ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z
,
112 ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER
,
113 ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
,
117 * The return type of st_api->get_proc_address.
119 typedef void (*st_proc_t
)(void);
122 struct pipe_resource
;
123 struct pipe_fence_handle
;
126 * Used in st_context_iface->get_resource_for_egl_image.
128 struct st_context_resource
130 /* these fields are filled by the caller */
131 enum st_context_resource_type type
;
134 /* this is owned by the caller */
135 struct pipe_resource
*texture
;
139 * Used in st_manager_iface->get_egl_image.
143 /* these fields are filled by the caller */
144 struct st_context_iface
*stctxi
;
147 /* this is owned by the caller */
148 struct pipe_resource
*texture
;
156 * Represent the visual of a framebuffer.
161 * Available buffers. Tested with ST_FRAMEBUFFER_*_MASK.
163 unsigned buffer_mask
;
166 * Buffer formats. The formats are always set even when the buffer is
169 enum pipe_format color_format
;
170 enum pipe_format depth_stencil_format
;
171 enum pipe_format accum_format
;
175 * Desired render buffer.
177 enum st_attachment_type render_buffer
;
181 * Represent a windowing system drawable.
183 * The framebuffer is implemented by the state tracker manager and
184 * used by the state trackers.
186 * Instead of the winsys pokeing into the API context to figure
187 * out what buffers that might be needed in the future by the API
188 * context, it calls into the framebuffer to get the textures.
190 * This structure along with the notify_invalid_framebuffer
191 * allows framebuffers to be shared between different threads
192 * but at the same make the API context free from thread
193 * syncronisation primitves, with the exception of a small
194 * atomic flag used for notification of framebuffer dirty status.
196 * The thread syncronisation is put inside the framebuffer
197 * and only called once the framebuffer has become dirty.
199 struct st_framebuffer_iface
202 * Available for the state tracker manager to use.
204 void *st_manager_private
;
207 * The visual of a framebuffer.
209 const struct st_visual
*visual
;
212 * Flush the front buffer.
214 * On some window systems, changes to the front buffers are not immediately
215 * visible. They need to be flushed.
217 * @att is one of the front buffer attachments.
219 boolean (*flush_front
)(struct st_framebuffer_iface
*stfbi
,
220 enum st_attachment_type statt
);
223 * The state tracker asks for the textures it needs.
225 * It should try to only ask for attachments that it currently renders
226 * to, thus allowing the winsys to delay the allocation of textures not
227 * needed. For example front buffer attachments are not needed if you
228 * only do back buffer rendering.
230 * The implementor of this function needs to also ensure
231 * thread safty as this call might be done from multiple threads.
233 * The returned textures are owned by the caller. They should be
234 * unreferenced when no longer used. If this function is called multiple
235 * times with different sets of attachments, those buffers not included in
236 * the last call might be destroyed. This behavior might change in the
239 boolean (*validate
)(struct st_framebuffer_iface
*stfbi
,
240 const enum st_attachment_type
*statts
,
242 struct pipe_resource
**out
);
246 * Represent a rendering context.
248 * This entity is created from st_api and used by the state tracker manager.
250 struct st_context_iface
253 * Available for the state tracker and the manager to use.
255 void *st_context_private
;
256 void *st_manager_private
;
259 * Destroy the context.
261 void (*destroy
)(struct st_context_iface
*stctxi
);
264 * Invalidate the current textures that was taken from a framebuffer.
266 * The state tracker manager calls this function to let the rendering
267 * context know that it should update the textures it got from
268 * st_framebuffer_iface::validate. It should do so at the latest time possible.
269 * Possible right before sending triangles to the pipe context.
271 * For certain platforms this function might be called from a thread other
272 * than the thread that the context is currently bound in, and must
273 * therefore be thread safe. But it is the state tracker manager's
274 * responsibility to make sure that the framebuffer is bound to the context
275 * and the API context is current for the duration of this call.
277 * Thus reducing the sync primitive needed to a single atomic flag.
279 void (*notify_invalid_framebuffer
)(struct st_context_iface
*stctxi
,
280 struct st_framebuffer_iface
*stfbi
);
283 * Flush all drawing from context to the pipe also flushes the pipe.
285 void (*flush
)(struct st_context_iface
*stctxi
, unsigned flags
,
286 struct pipe_fence_handle
**fence
);
289 * Replace the texture image of a texture object at the specified level.
291 * This function is optional.
293 boolean (*teximage
)(struct st_context_iface
*stctxi
, enum st_texture_type target
,
294 int level
, enum pipe_format internal_format
,
295 struct pipe_resource
*tex
, boolean mipmap
);
298 * Used to implement glXCopyContext.
300 void (*copy
)(struct st_context_iface
*stctxi
,
301 struct st_context_iface
*stsrci
, unsigned mask
);
304 * Look up and return the info of a resource for EGLImage.
306 * This function is optional.
308 boolean (*get_resource_for_egl_image
)(struct st_context_iface
*stctxi
,
309 struct st_context_resource
*stres
);
314 * Represent a state tracker manager.
316 * This interface is implemented by the state tracker manager. It corresponds
317 * to a "display" in the window system.
321 struct pipe_screen
*screen
;
324 * Look up and return the info of an EGLImage.
326 * This function is optional.
328 boolean (*get_egl_image
)(struct st_manager
*smapi
,
329 struct st_egl_image
*stimg
);
333 * Represent a rendering API such as OpenGL or OpenVG.
335 * Implemented by the state tracker and used by the state tracker manager.
342 void (*destroy
)(struct st_api
*stapi
);
345 * Return an API entry point.
347 * For GL this is the same as _glapi_get_proc_address.
349 st_proc_t (*get_proc_address
)(struct st_api
*stapi
, const char *procname
);
352 * Return true if the visual is supported by the state tracker.
354 boolean (*is_visual_supported
)(struct st_api
*stapi
,
355 const struct st_visual
*visual
);
358 * Create a rendering context.
360 struct st_context_iface
*(*create_context
)(struct st_api
*stapi
,
361 struct st_manager
*smapi
,
362 const struct st_visual
*visual
,
363 struct st_context_iface
*stsharei
);
366 * Bind the context to the calling thread with draw and read as drawables.
368 * The framebuffers might have different visuals than the context does.
370 boolean (*make_current
)(struct st_api
*stapi
,
371 struct st_context_iface
*stctxi
,
372 struct st_framebuffer_iface
*stdrawi
,
373 struct st_framebuffer_iface
*streadi
);
376 * Get the currently bound context in the calling thread.
378 struct st_context_iface
*(*get_current
)(struct st_api
*stapi
);
382 * Represent a state tracker.
384 * This is the entry point of a state tracker.
388 enum st_api_type api
;
389 struct st_api
*(*create_api
)(void);
393 * Return true if the visual has the specified buffers.
395 static INLINE boolean
396 st_visual_have_buffers(const struct st_visual
*visual
, unsigned mask
)
398 return ((visual
->buffer_mask
& mask
) == mask
);
401 /* these symbols may need to be dynamically lookup up */
402 extern PUBLIC
const struct st_module st_module_OpenGL
;
403 extern PUBLIC
const struct st_module st_module_OpenGL_ES1
;
404 extern PUBLIC
const struct st_module st_module_OpenGL_ES2
;
405 extern PUBLIC
const struct st_module st_module_OpenVG
;
407 #endif /* _ST_API_H_ */