Blame - docs/egl.html - platform/external/mesa3d

blob: fb94f8c713606586edc87a5f7a661396ce4644ab [file] [log] [blame]

Andreas Boll	ecd5c7c	2012-06-12 09:05:03 +0200	[diff] [blame]	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
				2	<html lang="en">
				3	<head>
				4	<meta http-equiv="content-type" content="text/html; charset=utf-8">
				5	<title>Mesa EGL</title>
				6	<link rel="stylesheet" type="text/css" href="mesa.css">
				7	</head>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	8	<body>
				9
Andreas Boll	b5da52a	2012-09-18 18:57:02 +0200	[diff] [blame]	10	<div class="header">
				11	<h1>The Mesa 3D Graphics Library</h1>
				12	</div>
				13
				14	<iframe src="contents.html"></iframe>
				15	<div class="content">
				16
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	17	<h1>Mesa EGL</h1>
				18
				19	<p>The current version of EGL in Mesa implements EGL 1.4. More information
				20	about EGL can be found at
Andreas Boll	a73c59b	2012-09-18 19:31:28 +0200	[diff] [blame]	21	<a href="http://www.khronos.org/egl/">
Brian Paul	aeff9f9	2010-01-21 08:13:32 -0700	[diff] [blame]	22	http://www.khronos.org/egl/</a>.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	23
				24	<p>The Mesa's implementation of EGL uses a driver architecture. The main
				25	library (<code>libEGL</code>) is window system neutral. It provides the EGL
				26	API entry points and helper functions for use by the drivers. Drivers are
				27	dynamically loaded by the main library and most of the EGL API calls are
				28	directly dispatched to the drivers.</p>
				29
Chia-I Wu	65e8f81	2010-12-25 02:45:13 +0800	[diff] [blame]	30	<p>The driver in use decides the window system to support.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	31
				32	<h2>Build EGL</h2>
				33
				34	<ol>
				35	<li>
Chia-I Wu	3418f74	2010-11-02 23:55:56 +0800	[diff] [blame]	36	<p>Run <code>configure</code> with the desired client APIs and enable
				37	the driver for your hardware. For example</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	38
				39	<pre>
Chia-I Wu	8eea050	2011-06-20 11:14:56 +0900	[diff] [blame]	40	$ ./configure --enable-gles1 --enable-gles2 \
				41	--with-dri-drivers=... \
				42	--with-gallium-drivers=...
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	43	</pre>
				44
Chia-I Wu	8eea050	2011-06-20 11:14:56 +0900	[diff] [blame]	45	<p>The main library and OpenGL is enabled by default. The first two options
				46	above enables <a href="opengles.html">OpenGL ES 1.x and 2.x</a>. The last two
				47	options enables the listed classic and and Gallium drivers respectively.</p>
Chia-I Wu	c6320c5	2010-10-28 17:25:07 +0800	[diff] [blame]	48
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	49	</li>
				50
				51	<li>Build and install Mesa as usual.</li>
				52	</ol>
				53
				54	<p>In the given example, it will build and install <code>libEGL</code>,
Chia-I Wu	8eea050	2011-06-20 11:14:56 +0900	[diff] [blame]	55	<code>libGL</code>, <code>libGLESv1_CM</code>, <code>libGLESv2</code>, and one
				56	or more EGL drivers.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	57
				58	<h3>Configure Options</h3>
				59
				60	<p>There are several options that control the build of EGL at configuration
				61	time</p>
				62
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	63	<dl>
				64	<dt><code>--enable-egl</code></dt>
				65	<dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	66
				67	<p>By default, EGL is enabled. When disabled, the main library and the drivers
				68	will not be built.</p>
				69
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	70	</dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	71
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	72	<dt><code>--with-egl-driver-dir</code></dt>
				73	<dd>
Chia-I Wu	a6342af	2010-01-26 10:54:45 +0800	[diff] [blame]	74
				75	<p>The directory EGL drivers should be installed to. If not specified, EGL
				76	drivers will be installed to <code>${libdir}/egl</code>.</p>
				77
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	78	</dd>
Chia-I Wu	a6342af	2010-01-26 10:54:45 +0800	[diff] [blame]	79
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	80	<dt><code>--with-egl-platforms</code></dt>
				81	<dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	82
Chia-I Wu	b365b15	2010-07-03 17:18:40 +0800	[diff] [blame]	83	<p>List the platforms (window systems) to support. Its argument is a comma
Nathan Kidd	0691b37	2014-01-03 16:44:00 -0700	[diff] [blame]	84	separated string such as <code>--with-egl-platforms=x11,drm</code>. It decides
Chia-I Wu	b365b15	2010-07-03 17:18:40 +0800	[diff] [blame]	85	the platforms a driver may support. The first listed platform is also used by
				86	the main library to decide the native platform: the platform the EGL native
				87	types such as <code>EGLNativeDisplayType</code> or
				88	<code>EGLNativeWindowType</code> defined for.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	89
Chia-I Wu	e7424d7	2010-09-19 16:54:39 +0800	[diff] [blame]	90	<p>The available platforms are <code>x11</code>, <code>drm</code>,
Emil Velikov	b0a9299	2015-07-10 00:16:21 +0100	[diff] [blame]	91	<code>wayland</code>, <code>surfaceless</code>, <code>android</code>,
Nicolas Boichat	a9b2b5e	2016-05-24 13:55:20 +0800	[diff] [blame]	92	and <code>haiku</code>.
				93	The <code>android</code> platform can either be built as a system
				94	component, part of AOSP, using <code>Android.mk</code> files, or
				95	cross-compiled using appropriate <code>configure</code> options.
				96	The <code>haiku</code> platform can only be built with SCons.
Emil Velikov	55029b2	2015-03-14 22:36:29 +0000	[diff] [blame]	97	Unless for special needs, the build system should
Chia-I Wu	3418f74	2010-11-02 23:55:56 +0800	[diff] [blame]	98	select the right platforms automatically.</p>
Chia-I Wu	2e3c4e4	2010-05-07 14:13:08 +0800	[diff] [blame]	99
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	100	</dd>
Chia-I Wu	2e3c4e4	2010-05-07 14:13:08 +0800	[diff] [blame]	101
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	102	<dt><code>--enable-gles1</code></dt>
				103	<dt><code>--enable-gles2</code></dt>
				104	<dd>
Chia-I Wu	2e3c4e4	2010-05-07 14:13:08 +0800	[diff] [blame]	105
Chia-I Wu	65e8f81	2010-12-25 02:45:13 +0800	[diff] [blame]	106	<p>These options enable OpenGL ES support in OpenGL. The result is one big
				107	internal library that supports multiple APIs.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	108
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	109	</dd>
Chia-I Wu	a1306f4	2010-01-22 15:51:51 +0800	[diff] [blame]	110
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	111	<dt><code>--enable-shared-glapi</code></dt>
				112	<dd>
Chia-I Wu	c6320c5	2010-10-28 17:25:07 +0800	[diff] [blame]	113
Chia-I Wu	8eea050	2011-06-20 11:14:56 +0900	[diff] [blame]	114	<p>By default, <code>libGL</code> has its own copy of <code>libglapi</code>.
				115	This options makes <code>libGL</code> use the shared <code>libglapi</code>. This
				116	is required if applications mix OpenGL and OpenGL ES.</p>
Chia-I Wu	c6320c5	2010-10-28 17:25:07 +0800	[diff] [blame]	117
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	118	</dd>
Chia-I Wu	c6320c5	2010-10-28 17:25:07 +0800	[diff] [blame]	119
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	120	</dl>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	121
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	122	<h2>Use EGL</h2>
				123
Chia-I Wu	411bba3	2010-06-11 12:47:14 +0800	[diff] [blame]	124	<h3>Demos</h3>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	125
Chia-I Wu	411bba3	2010-06-11 12:47:14 +0800	[diff] [blame]	126	<p>There are demos for the client APIs supported by EGL. They can be found in
				127	mesa/demos repository.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	128
				129	<h3>Environment Variables</h3>
				130
				131	<p>There are several environment variables that control the behavior of EGL at
				132	runtime</p>
				133
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	134	<dl>
				135	<dt><code>EGL_DRIVERS_PATH</code></dt>
				136	<dd>
Chia-I Wu	5d8646c	2010-02-02 15:34:55 +0800	[diff] [blame]	137
				138	<p>By default, the main library will look for drivers in the directory where
				139	the drivers are installed to. This variable specifies a list of
				140	colon-separated directories where the main library will look for drivers, in
Chia-I Wu	6fd8b6a	2010-02-02 16:47:53 +0800	[diff] [blame]	141	addition to the default directory. This variable is ignored for setuid/setgid
				142	binaries.</p>
Chia-I Wu	5d8646c	2010-02-02 15:34:55 +0800	[diff] [blame]	143
Chia-I Wu	cba7786	2011-01-04 00:53:19 +0800	[diff] [blame]	144	<p>This variable is usually set to test an uninstalled build. For example, one
				145	may set</p>
				146
				147	<pre>
				148	$ export LD_LIBRARY_PATH=$mesa/lib
				149	$ export EGL_DRIVERS_PATH=$mesa/lib/egl
				150	</pre>
				151
				152	<p>to test a build without installation</p>
				153
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	154	</dd>
Chia-I Wu	5d8646c	2010-02-02 15:34:55 +0800	[diff] [blame]	155
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	156	<dt><code>EGL_DRIVER</code></dt>
				157	<dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	158
Chia-I Wu	c98ea26	2011-01-07 16:30:08 +0800	[diff] [blame]	159	<p>This variable specifies a full path to or the name of an EGL driver. It
				160	forces the specified EGL driver to be loaded. It comes in handy when one wants
				161	to test a specific driver. This variable is ignored for setuid/setgid
				162	binaries.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	163
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	164	</dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	165
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	166	<dt><code>EGL_PLATFORM</code></dt>
				167	<dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	168
Chia-I Wu	b365b15	2010-07-03 17:18:40 +0800	[diff] [blame]	169	<p>This variable specifies the native platform. The valid values are the same
				170	as those for <code>--with-egl-platforms</code>. When the variable is not set,
				171	the main library uses the first platform listed in
Chia-I Wu	3418f74	2010-11-02 23:55:56 +0800	[diff] [blame]	172	<code>--with-egl-platforms</code> as the native platform.</p>
				173
				174	<p>Extensions like <code>EGL_MESA_drm_display</code> define new functions to
				175	create displays for non-native platforms. These extensions are usually used by
				176	applications that support non-native platforms. Setting this variable is
				177	probably required only for some of the demos found in mesa/demo repository.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	178
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	179	</dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	180
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	181	<dt><code>EGL_LOG_LEVEL</code></dt>
				182	<dd>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	183
				184	<p>This changes the log level of the main library and the drivers. The valid
				185	values are: <code>debug</code>, <code>info</code>, <code>warning</code>, and
				186	<code>fatal</code>.</p>
				187
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	188	</dd>
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	189	</dl>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	190
				191	<h2>EGL Drivers</h2>
				192
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	193	<dl>
				194	<dt><code>egl_dri2</code></dt>
				195	<dd>
Chia-I Wu	3418f74	2010-11-02 23:55:56 +0800	[diff] [blame]	196
				197	<p>This driver supports both <code>x11</code> and <code>drm</code> platforms.
Chia-I Wu	65e8f81	2010-12-25 02:45:13 +0800	[diff] [blame]	198	It functions as a DRI driver loader. For <code>x11</code> support, it talks to
				199	the X server directly using (XCB-)DRI2 protocol.</p>
				200
				201	<p>This driver can share DRI drivers with <code>libGL</code>.</p>
Chia-I Wu	3418f74	2010-11-02 23:55:56 +0800	[diff] [blame]	202
Andreas Boll	76d4f9e	2012-09-20 16:01:08 +0200	[diff] [blame]	203	</dd>
Chia-I Wu	3418f74	2010-11-02 23:55:56 +0800	[diff] [blame]	204
Chia-I Wu	65e8f81	2010-12-25 02:45:13 +0800	[diff] [blame]	205	<h2>Packaging</h2>
				206
				207	<p>The ABI between the main library and its drivers are not stable. Nor is
Jose Fonseca	5564c36	2015-03-03 16:01:22 +0000	[diff] [blame]	208	there a plan to stabilize it at the moment.</p>
Chia-I Wu	65e8f81	2010-12-25 02:45:13 +0800	[diff] [blame]	209
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	210	<h2>Developers</h2>
				211
Jose Fonseca	5564c36	2015-03-03 16:01:22 +0000	[diff] [blame]	212	<p>The sources of the main library and drivers can be found at
				213	<code>src/egl/</code>.</p>
Chia-I Wu	14cbf32	2010-01-27 23:18:22 +0800	[diff] [blame]	214
Chia-I Wu	14cbf32	2010-01-27 23:18:22 +0800	[diff] [blame]	215	<h3>Lifetime of Display Resources</h3>
				216
				217	<p>Contexts and surfaces are examples of display resources. They might live
				218	longer than the display that creates them.</p>
				219
				220	<p>In EGL, when a display is terminated through <code>eglTerminate</code>, all
				221	display resources should be destroyed. Similarly, when a thread is released
Nathan Kidd	0691b37	2014-01-03 16:44:00 -0700	[diff] [blame]	222	through <code>eglReleaseThread</code>, all current display resources should be
				223	released. Another way to destroy or release resources is through functions
Chia-I Wu	14cbf32	2010-01-27 23:18:22 +0800	[diff] [blame]	224	such as <code>eglDestroySurface</code> or <code>eglMakeCurrent</code>.</p>
				225
				226	<p>When a resource that is current to some thread is destroyed, the resource
				227	should not be destroyed immediately. EGL requires the resource to live until
				228	it is no longer current. A driver usually calls
				229	<code>eglIs<Resource>Bound</code> to check if a resource is bound
				230	(current) to any thread in the destroy callbacks. If it is still bound, the
				231	resource is not destroyed.</p>
				232
				233	<p>The main library will mark destroyed current resources as unlinked. In a
				234	driver's <code>MakeCurrent</code> callback,
				235	<code>eglIs<Resource>Linked</code> can then be called to check if a newly
				236	released resource is linked to a display. If it is not, the last reference to
				237	the resource is removed and the driver should destroy the resource. But it
				238	should be careful here because <code>MakeCurrent</code> might be called with an
				239	uninitialized display.</p>
				240
				241	<p>This is the only mechanism provided by the main library to help manage the
				242	resources. The drivers are responsible to the correct behavior as defined by
				243	EGL.</p>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	244
Chia-I Wu	1b2b08c	2010-02-05 12:44:45 +0800	[diff] [blame]	245	<h3><code>EGL_RENDER_BUFFER</code></h3>
				246
				247	<p>In EGL, the color buffer a context should try to render to is decided by the
				248	binding surface. It should try to render to the front buffer if the binding
				249	surface has <code>EGL_RENDER_BUFFER</code> set to
				250	<code>EGL_SINGLE_BUFFER</code>; If the same context is later bound to a
				251	surface with <code>EGL_RENDER_BUFFER</code> set to
				252	<code>EGL_BACK_BUFFER</code>, the context should try to render to the back
				253	buffer. However, the context is allowed to make the final decision as to which
				254	color buffer it wants to or is able to render to.</p>
				255
				256	<p>For pbuffer surfaces, the render buffer is always
				257	<code>EGL_BACK_BUFFER</code>. And for pixmap surfaces, the render buffer is
				258	always <code>EGL_SINGLE_BUFFER</code>. Unlike window surfaces, EGL spec
				259	requires their <code>EGL_RENDER_BUFFER</code> values to be honored. As a
				260	result, a driver should never set <code>EGL_PIXMAP_BIT</code> or
				261	<code>EGL_PBUFFER_BIT</code> bits of a config if the contexts created with the
				262	config won't be able to honor the <code>EGL_RENDER_BUFFER</code> of pixmap or
				263	pbuffer surfaces.</p>
				264
				265	<p>It should also be noted that pixmap and pbuffer surfaces are assumed to be
				266	single-buffered, in that <code>eglSwapBuffers</code> has no effect on them. It
				267	is desirable that a driver allocates a private color buffer for each pbuffer
				268	surface created. If the window system the driver supports has native pbuffers,
				269	or if the native pixmaps have more than one color buffers, the driver should
				270	carefully attach the native color buffers to the EGL surfaces, re-route them if
				271	required.</p>
				272
				273	<p>There is no defined behavior as to, for example, how
				274	<code>glDrawBuffer</code> interacts with <code>EGL_RENDER_BUFFER</code>. Right
				275	now, it is desired that the draw buffer in a client API be fixed for pixmap and
				276	pbuffer surfaces. Therefore, the driver is responsible to guarantee that the
				277	client API renders to the specified render buffer for pixmap and pbuffer
				278	surfaces.</p>
				279
Chia-I Wu	e16f577	2010-02-17 19:52:29 +0800	[diff] [blame]	280	<h3><code>EGLDisplay</code> Mutex</h3>
				281
				282	The <code>EGLDisplay</code> will be locked before calling any of the dispatch
				283	functions (well, except for GetProcAddress which does not take an
				284	<code>EGLDisplay</code>). This guarantees that the same dispatch function will
				285	not be called with the sample display at the same time. If a driver has access
				286	to an <code>EGLDisplay</code> without going through the EGL APIs, the driver
				287	should as well lock the display before using it.
				288
Andreas Boll	b5da52a	2012-09-18 18:57:02 +0200	[diff] [blame]	289	</div>
Chia-I Wu	ada4605	2010-01-21 15:29:14 +0800	[diff] [blame]	290	</body>
				291	</html>