GLSurfaceView.java revision 80b3cd6bc608c5929096e3407de2b157be925d3e
1/* 2 * Copyright (C) 2008 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.opengl; 18 19import java.io.Writer; 20import java.lang.ref.WeakReference; 21import java.util.ArrayList; 22 23import javax.microedition.khronos.egl.EGL10; 24import javax.microedition.khronos.egl.EGL11; 25import javax.microedition.khronos.egl.EGLConfig; 26import javax.microedition.khronos.egl.EGLContext; 27import javax.microedition.khronos.egl.EGLDisplay; 28import javax.microedition.khronos.egl.EGLSurface; 29import javax.microedition.khronos.opengles.GL; 30import javax.microedition.khronos.opengles.GL10; 31 32import android.content.Context; 33import android.content.pm.ConfigurationInfo; 34import android.os.SystemProperties; 35import android.util.AttributeSet; 36import android.util.Log; 37import android.view.SurfaceHolder; 38import android.view.SurfaceView; 39 40/** 41 * An implementation of SurfaceView that uses the dedicated surface for 42 * displaying OpenGL rendering. 43 * <p> 44 * A GLSurfaceView provides the following features: 45 * <p> 46 * <ul> 47 * <li>Manages a surface, which is a special piece of memory that can be 48 * composited into the Android view system. 49 * <li>Manages an EGL display, which enables OpenGL to render into a surface. 50 * <li>Accepts a user-provided Renderer object that does the actual rendering. 51 * <li>Renders on a dedicated thread to decouple rendering performance from the 52 * UI thread. 53 * <li>Supports both on-demand and continuous rendering. 54 * <li>Optionally wraps, traces, and/or error-checks the renderer's OpenGL calls. 55 * </ul> 56 * 57 * <div class="special reference"> 58 * <h3>Developer Guides</h3> 59 * <p>For more information about how to use OpenGL, read the 60 * <a href="{@docRoot}guide/topics/graphics/opengl.html">OpenGL</a> developer guide.</p> 61 * </div> 62 * 63 * <h3>Using GLSurfaceView</h3> 64 * <p> 65 * Typically you use GLSurfaceView by subclassing it and overriding one or more of the 66 * View system input event methods. If your application does not need to override event 67 * methods then GLSurfaceView can be used as-is. For the most part 68 * GLSurfaceView behavior is customized by calling "set" methods rather than by subclassing. 69 * For example, unlike a regular View, drawing is delegated to a separate Renderer object which 70 * is registered with the GLSurfaceView 71 * using the {@link #setRenderer(Renderer)} call. 72 * <p> 73 * <h3>Initializing GLSurfaceView</h3> 74 * All you have to do to initialize a GLSurfaceView is call {@link #setRenderer(Renderer)}. 75 * However, if desired, you can modify the default behavior of GLSurfaceView by calling one or 76 * more of these methods before calling setRenderer: 77 * <ul> 78 * <li>{@link #setDebugFlags(int)} 79 * <li>{@link #setEGLConfigChooser(boolean)} 80 * <li>{@link #setEGLConfigChooser(EGLConfigChooser)} 81 * <li>{@link #setEGLConfigChooser(int, int, int, int, int, int)} 82 * <li>{@link #setGLWrapper(GLWrapper)} 83 * </ul> 84 * <p> 85 * <h4>Specifying the android.view.Surface</h4> 86 * By default GLSurfaceView will create a PixelFormat.RGB_565 format surface. If a translucent 87 * surface is required, call getHolder().setFormat(PixelFormat.TRANSLUCENT). 88 * The exact format of a TRANSLUCENT surface is device dependent, but it will be 89 * a 32-bit-per-pixel surface with 8 bits per component. 90 * <p> 91 * <h4>Choosing an EGL Configuration</h4> 92 * A given Android device may support multiple EGLConfig rendering configurations. 93 * The available configurations may differ in how may channels of data are present, as 94 * well as how many bits are allocated to each channel. Therefore, the first thing 95 * GLSurfaceView has to do when starting to render is choose what EGLConfig to use. 96 * <p> 97 * By default GLSurfaceView chooses a EGLConfig that has an RGB_565 pixel format, 98 * with at least a 16-bit depth buffer and no stencil. 99 * <p> 100 * If you would prefer a different EGLConfig 101 * you can override the default behavior by calling one of the 102 * setEGLConfigChooser methods. 103 * <p> 104 * <h4>Debug Behavior</h4> 105 * You can optionally modify the behavior of GLSurfaceView by calling 106 * one or more of the debugging methods {@link #setDebugFlags(int)}, 107 * and {@link #setGLWrapper}. These methods may be called before and/or after setRenderer, but 108 * typically they are called before setRenderer so that they take effect immediately. 109 * <p> 110 * <h4>Setting a Renderer</h4> 111 * Finally, you must call {@link #setRenderer} to register a {@link Renderer}. 112 * The renderer is 113 * responsible for doing the actual OpenGL rendering. 114 * <p> 115 * <h3>Rendering Mode</h3> 116 * Once the renderer is set, you can control whether the renderer draws 117 * continuously or on-demand by calling 118 * {@link #setRenderMode}. The default is continuous rendering. 119 * <p> 120 * <h3>Activity Life-cycle</h3> 121 * A GLSurfaceView must be notified when the activity is paused and resumed. GLSurfaceView clients 122 * are required to call {@link #onPause()} when the activity pauses and 123 * {@link #onResume()} when the activity resumes. These calls allow GLSurfaceView to 124 * pause and resume the rendering thread, and also allow GLSurfaceView to release and recreate 125 * the OpenGL display. 126 * <p> 127 * <h3>Handling events</h3> 128 * <p> 129 * To handle an event you will typically subclass GLSurfaceView and override the 130 * appropriate method, just as you would with any other View. However, when handling 131 * the event, you may need to communicate with the Renderer object 132 * that's running in the rendering thread. You can do this using any 133 * standard Java cross-thread communication mechanism. In addition, 134 * one relatively easy way to communicate with your renderer is 135 * to call 136 * {@link #queueEvent(Runnable)}. For example: 137 * <pre class="prettyprint"> 138 * class MyGLSurfaceView extends GLSurfaceView { 139 * 140 * private MyRenderer mMyRenderer; 141 * 142 * public void start() { 143 * mMyRenderer = ...; 144 * setRenderer(mMyRenderer); 145 * } 146 * 147 * public boolean onKeyDown(int keyCode, KeyEvent event) { 148 * if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) { 149 * queueEvent(new Runnable() { 150 * // This method will be called on the rendering 151 * // thread: 152 * public void run() { 153 * mMyRenderer.handleDpadCenter(); 154 * }}); 155 * return true; 156 * } 157 * return super.onKeyDown(keyCode, event); 158 * } 159 * } 160 * </pre> 161 * 162 */ 163public class GLSurfaceView extends SurfaceView implements SurfaceHolder.Callback { 164 private final static String TAG = "GLSurfaceView"; 165 private final static boolean LOG_ATTACH_DETACH = false; 166 private final static boolean LOG_THREADS = false; 167 private final static boolean LOG_PAUSE_RESUME = false; 168 private final static boolean LOG_SURFACE = false; 169 private final static boolean LOG_RENDERER = false; 170 private final static boolean LOG_RENDERER_DRAW_FRAME = false; 171 private final static boolean LOG_EGL = false; 172 /** 173 * The renderer only renders 174 * when the surface is created, or when {@link #requestRender} is called. 175 * 176 * @see #getRenderMode() 177 * @see #setRenderMode(int) 178 * @see #requestRender() 179 */ 180 public final static int RENDERMODE_WHEN_DIRTY = 0; 181 /** 182 * The renderer is called 183 * continuously to re-render the scene. 184 * 185 * @see #getRenderMode() 186 * @see #setRenderMode(int) 187 */ 188 public final static int RENDERMODE_CONTINUOUSLY = 1; 189 190 /** 191 * Check glError() after every GL call and throw an exception if glError indicates 192 * that an error has occurred. This can be used to help track down which OpenGL ES call 193 * is causing an error. 194 * 195 * @see #getDebugFlags 196 * @see #setDebugFlags 197 */ 198 public final static int DEBUG_CHECK_GL_ERROR = 1; 199 200 /** 201 * Log GL calls to the system log at "verbose" level with tag "GLSurfaceView". 202 * 203 * @see #getDebugFlags 204 * @see #setDebugFlags 205 */ 206 public final static int DEBUG_LOG_GL_CALLS = 2; 207 208 /** 209 * Standard View constructor. In order to render something, you 210 * must call {@link #setRenderer} to register a renderer. 211 */ 212 public GLSurfaceView(Context context) { 213 super(context); 214 init(); 215 } 216 217 /** 218 * Standard View constructor. In order to render something, you 219 * must call {@link #setRenderer} to register a renderer. 220 */ 221 public GLSurfaceView(Context context, AttributeSet attrs) { 222 super(context, attrs); 223 init(); 224 } 225 226 @Override 227 protected void finalize() throws Throwable { 228 try { 229 if (mGLThread != null) { 230 // GLThread may still be running if this view was never 231 // attached to a window. 232 mGLThread.requestExitAndWait(); 233 } 234 } finally { 235 super.finalize(); 236 } 237 } 238 239 private void init() { 240 // Install a SurfaceHolder.Callback so we get notified when the 241 // underlying surface is created and destroyed 242 SurfaceHolder holder = getHolder(); 243 holder.addCallback(this); 244 // setFormat is done by SurfaceView in SDK 2.3 and newer. Uncomment 245 // this statement if back-porting to 2.2 or older: 246 // holder.setFormat(PixelFormat.RGB_565); 247 // 248 // setType is not needed for SDK 2.0 or newer. Uncomment this 249 // statement if back-porting this code to older SDKs. 250 // holder.setType(SurfaceHolder.SURFACE_TYPE_GPU); 251 } 252 253 /** 254 * Set the glWrapper. If the glWrapper is not null, its 255 * {@link GLWrapper#wrap(GL)} method is called 256 * whenever a surface is created. A GLWrapper can be used to wrap 257 * the GL object that's passed to the renderer. Wrapping a GL 258 * object enables examining and modifying the behavior of the 259 * GL calls made by the renderer. 260 * <p> 261 * Wrapping is typically used for debugging purposes. 262 * <p> 263 * The default value is null. 264 * @param glWrapper the new GLWrapper 265 */ 266 public void setGLWrapper(GLWrapper glWrapper) { 267 mGLWrapper = glWrapper; 268 } 269 270 /** 271 * Set the debug flags to a new value. The value is 272 * constructed by OR-together zero or more 273 * of the DEBUG_CHECK_* constants. The debug flags take effect 274 * whenever a surface is created. The default value is zero. 275 * @param debugFlags the new debug flags 276 * @see #DEBUG_CHECK_GL_ERROR 277 * @see #DEBUG_LOG_GL_CALLS 278 */ 279 public void setDebugFlags(int debugFlags) { 280 mDebugFlags = debugFlags; 281 } 282 283 /** 284 * Get the current value of the debug flags. 285 * @return the current value of the debug flags. 286 */ 287 public int getDebugFlags() { 288 return mDebugFlags; 289 } 290 291 /** 292 * Control whether the EGL context is preserved when the GLSurfaceView is paused and 293 * resumed. 294 * <p> 295 * If set to true, then the EGL context may be preserved when the GLSurfaceView is paused. 296 * Whether the EGL context is actually preserved or not depends upon whether the 297 * Android device that the program is running on can support an arbitrary number of EGL 298 * contexts or not. Devices that can only support a limited number of EGL contexts must 299 * release the EGL context in order to allow multiple applications to share the GPU. 300 * <p> 301 * If set to false, the EGL context will be released when the GLSurfaceView is paused, 302 * and recreated when the GLSurfaceView is resumed. 303 * <p> 304 * 305 * The default is false. 306 * 307 * @param preserveOnPause preserve the EGL context when paused 308 */ 309 public void setPreserveEGLContextOnPause(boolean preserveOnPause) { 310 mPreserveEGLContextOnPause = preserveOnPause; 311 } 312 313 /** 314 * @return true if the EGL context will be preserved when paused 315 */ 316 public boolean getPreserveEGLContextOnPause() { 317 return mPreserveEGLContextOnPause; 318 } 319 320 /** 321 * Set the renderer associated with this view. Also starts the thread that 322 * will call the renderer, which in turn causes the rendering to start. 323 * <p>This method should be called once and only once in the life-cycle of 324 * a GLSurfaceView. 325 * <p>The following GLSurfaceView methods can only be called <em>before</em> 326 * setRenderer is called: 327 * <ul> 328 * <li>{@link #setEGLConfigChooser(boolean)} 329 * <li>{@link #setEGLConfigChooser(EGLConfigChooser)} 330 * <li>{@link #setEGLConfigChooser(int, int, int, int, int, int)} 331 * </ul> 332 * <p> 333 * The following GLSurfaceView methods can only be called <em>after</em> 334 * setRenderer is called: 335 * <ul> 336 * <li>{@link #getRenderMode()} 337 * <li>{@link #onPause()} 338 * <li>{@link #onResume()} 339 * <li>{@link #queueEvent(Runnable)} 340 * <li>{@link #requestRender()} 341 * <li>{@link #setRenderMode(int)} 342 * </ul> 343 * 344 * @param renderer the renderer to use to perform OpenGL drawing. 345 */ 346 public void setRenderer(Renderer renderer) { 347 checkRenderThreadState(); 348 if (mEGLConfigChooser == null) { 349 mEGLConfigChooser = new SimpleEGLConfigChooser(true); 350 } 351 if (mEGLContextFactory == null) { 352 mEGLContextFactory = new DefaultContextFactory(); 353 } 354 if (mEGLWindowSurfaceFactory == null) { 355 mEGLWindowSurfaceFactory = new DefaultWindowSurfaceFactory(); 356 } 357 mRenderer = renderer; 358 mGLThread = new GLThread(mThisWeakRef); 359 mGLThread.start(); 360 } 361 362 /** 363 * Install a custom EGLContextFactory. 364 * <p>If this method is 365 * called, it must be called before {@link #setRenderer(Renderer)} 366 * is called. 367 * <p> 368 * If this method is not called, then by default 369 * a context will be created with no shared context and 370 * with a null attribute list. 371 */ 372 public void setEGLContextFactory(EGLContextFactory factory) { 373 checkRenderThreadState(); 374 mEGLContextFactory = factory; 375 } 376 377 /** 378 * Install a custom EGLWindowSurfaceFactory. 379 * <p>If this method is 380 * called, it must be called before {@link #setRenderer(Renderer)} 381 * is called. 382 * <p> 383 * If this method is not called, then by default 384 * a window surface will be created with a null attribute list. 385 */ 386 public void setEGLWindowSurfaceFactory(EGLWindowSurfaceFactory factory) { 387 checkRenderThreadState(); 388 mEGLWindowSurfaceFactory = factory; 389 } 390 391 /** 392 * Install a custom EGLConfigChooser. 393 * <p>If this method is 394 * called, it must be called before {@link #setRenderer(Renderer)} 395 * is called. 396 * <p> 397 * If no setEGLConfigChooser method is called, then by default the 398 * view will choose an EGLConfig that is compatible with the current 399 * android.view.Surface, with a depth buffer depth of 400 * at least 16 bits. 401 * @param configChooser 402 */ 403 public void setEGLConfigChooser(EGLConfigChooser configChooser) { 404 checkRenderThreadState(); 405 mEGLConfigChooser = configChooser; 406 } 407 408 /** 409 * Install a config chooser which will choose a config 410 * as close to 16-bit RGB as possible, with or without an optional depth 411 * buffer as close to 16-bits as possible. 412 * <p>If this method is 413 * called, it must be called before {@link #setRenderer(Renderer)} 414 * is called. 415 * <p> 416 * If no setEGLConfigChooser method is called, then by default the 417 * view will choose an RGB_565 surface with a depth buffer depth of 418 * at least 16 bits. 419 * 420 * @param needDepth 421 */ 422 public void setEGLConfigChooser(boolean needDepth) { 423 setEGLConfigChooser(new SimpleEGLConfigChooser(needDepth)); 424 } 425 426 /** 427 * Install a config chooser which will choose a config 428 * with at least the specified depthSize and stencilSize, 429 * and exactly the specified redSize, greenSize, blueSize and alphaSize. 430 * <p>If this method is 431 * called, it must be called before {@link #setRenderer(Renderer)} 432 * is called. 433 * <p> 434 * If no setEGLConfigChooser method is called, then by default the 435 * view will choose an RGB_565 surface with a depth buffer depth of 436 * at least 16 bits. 437 * 438 */ 439 public void setEGLConfigChooser(int redSize, int greenSize, int blueSize, 440 int alphaSize, int depthSize, int stencilSize) { 441 setEGLConfigChooser(new ComponentSizeChooser(redSize, greenSize, 442 blueSize, alphaSize, depthSize, stencilSize)); 443 } 444 445 /** 446 * Inform the default EGLContextFactory and default EGLConfigChooser 447 * which EGLContext client version to pick. 448 * <p>Use this method to create an OpenGL ES 2.0-compatible context. 449 * Example: 450 * <pre class="prettyprint"> 451 * public MyView(Context context) { 452 * super(context); 453 * setEGLContextClientVersion(2); // Pick an OpenGL ES 2.0 context. 454 * setRenderer(new MyRenderer()); 455 * } 456 * </pre> 457 * <p>Note: Activities which require OpenGL ES 2.0 should indicate this by 458 * setting @lt;uses-feature android:glEsVersion="0x00020000" /> in the activity's 459 * AndroidManifest.xml file. 460 * <p>If this method is called, it must be called before {@link #setRenderer(Renderer)} 461 * is called. 462 * <p>This method only affects the behavior of the default EGLContexFactory and the 463 * default EGLConfigChooser. If 464 * {@link #setEGLContextFactory(EGLContextFactory)} has been called, then the supplied 465 * EGLContextFactory is responsible for creating an OpenGL ES 2.0-compatible context. 466 * If 467 * {@link #setEGLConfigChooser(EGLConfigChooser)} has been called, then the supplied 468 * EGLConfigChooser is responsible for choosing an OpenGL ES 2.0-compatible config. 469 * @param version The EGLContext client version to choose. Use 2 for OpenGL ES 2.0 470 */ 471 public void setEGLContextClientVersion(int version) { 472 checkRenderThreadState(); 473 mEGLContextClientVersion = version; 474 } 475 476 /** 477 * Set the rendering mode. When renderMode is 478 * RENDERMODE_CONTINUOUSLY, the renderer is called 479 * repeatedly to re-render the scene. When renderMode 480 * is RENDERMODE_WHEN_DIRTY, the renderer only rendered when the surface 481 * is created, or when {@link #requestRender} is called. Defaults to RENDERMODE_CONTINUOUSLY. 482 * <p> 483 * Using RENDERMODE_WHEN_DIRTY can improve battery life and overall system performance 484 * by allowing the GPU and CPU to idle when the view does not need to be updated. 485 * <p> 486 * This method can only be called after {@link #setRenderer(Renderer)} 487 * 488 * @param renderMode one of the RENDERMODE_X constants 489 * @see #RENDERMODE_CONTINUOUSLY 490 * @see #RENDERMODE_WHEN_DIRTY 491 */ 492 public void setRenderMode(int renderMode) { 493 mGLThread.setRenderMode(renderMode); 494 } 495 496 /** 497 * Get the current rendering mode. May be called 498 * from any thread. Must not be called before a renderer has been set. 499 * @return the current rendering mode. 500 * @see #RENDERMODE_CONTINUOUSLY 501 * @see #RENDERMODE_WHEN_DIRTY 502 */ 503 public int getRenderMode() { 504 return mGLThread.getRenderMode(); 505 } 506 507 /** 508 * Request that the renderer render a frame. 509 * This method is typically used when the render mode has been set to 510 * {@link #RENDERMODE_WHEN_DIRTY}, so that frames are only rendered on demand. 511 * May be called 512 * from any thread. Must not be called before a renderer has been set. 513 */ 514 public void requestRender() { 515 mGLThread.requestRender(); 516 } 517 518 /** 519 * This method is part of the SurfaceHolder.Callback interface, and is 520 * not normally called or subclassed by clients of GLSurfaceView. 521 */ 522 public void surfaceCreated(SurfaceHolder holder) { 523 mGLThread.surfaceCreated(); 524 } 525 526 /** 527 * This method is part of the SurfaceHolder.Callback interface, and is 528 * not normally called or subclassed by clients of GLSurfaceView. 529 */ 530 public void surfaceDestroyed(SurfaceHolder holder) { 531 // Surface will be destroyed when we return 532 mGLThread.surfaceDestroyed(); 533 } 534 535 /** 536 * This method is part of the SurfaceHolder.Callback interface, and is 537 * not normally called or subclassed by clients of GLSurfaceView. 538 */ 539 public void surfaceChanged(SurfaceHolder holder, int format, int w, int h) { 540 mGLThread.onWindowResize(w, h); 541 } 542 543 /** 544 * Inform the view that the activity is paused. The owner of this view must 545 * call this method when the activity is paused. Calling this method will 546 * pause the rendering thread. 547 * Must not be called before a renderer has been set. 548 */ 549 public void onPause() { 550 mGLThread.onPause(); 551 } 552 553 /** 554 * Inform the view that the activity is resumed. The owner of this view must 555 * call this method when the activity is resumed. Calling this method will 556 * recreate the OpenGL display and resume the rendering 557 * thread. 558 * Must not be called before a renderer has been set. 559 */ 560 public void onResume() { 561 mGLThread.onResume(); 562 } 563 564 /** 565 * Queue a runnable to be run on the GL rendering thread. This can be used 566 * to communicate with the Renderer on the rendering thread. 567 * Must not be called before a renderer has been set. 568 * @param r the runnable to be run on the GL rendering thread. 569 */ 570 public void queueEvent(Runnable r) { 571 mGLThread.queueEvent(r); 572 } 573 574 /** 575 * This method is used as part of the View class and is not normally 576 * called or subclassed by clients of GLSurfaceView. 577 */ 578 @Override 579 protected void onAttachedToWindow() { 580 super.onAttachedToWindow(); 581 if (LOG_ATTACH_DETACH) { 582 Log.d(TAG, "onAttachedToWindow reattach =" + mDetached); 583 } 584 if (mDetached && (mRenderer != null)) { 585 int renderMode = RENDERMODE_CONTINUOUSLY; 586 if (mGLThread != null) { 587 renderMode = mGLThread.getRenderMode(); 588 } 589 mGLThread = new GLThread(mThisWeakRef); 590 if (renderMode != RENDERMODE_CONTINUOUSLY) { 591 mGLThread.setRenderMode(renderMode); 592 } 593 mGLThread.start(); 594 } 595 mDetached = false; 596 } 597 598 /** 599 * This method is used as part of the View class and is not normally 600 * called or subclassed by clients of GLSurfaceView. 601 * Must not be called before a renderer has been set. 602 */ 603 @Override 604 protected void onDetachedFromWindow() { 605 if (LOG_ATTACH_DETACH) { 606 Log.d(TAG, "onDetachedFromWindow"); 607 } 608 if (mGLThread != null) { 609 mGLThread.requestExitAndWait(); 610 } 611 mDetached = true; 612 super.onDetachedFromWindow(); 613 } 614 615 // ---------------------------------------------------------------------- 616 617 /** 618 * An interface used to wrap a GL interface. 619 * <p>Typically 620 * used for implementing debugging and tracing on top of the default 621 * GL interface. You would typically use this by creating your own class 622 * that implemented all the GL methods by delegating to another GL instance. 623 * Then you could add your own behavior before or after calling the 624 * delegate. All the GLWrapper would do was instantiate and return the 625 * wrapper GL instance: 626 * <pre class="prettyprint"> 627 * class MyGLWrapper implements GLWrapper { 628 * GL wrap(GL gl) { 629 * return new MyGLImplementation(gl); 630 * } 631 * static class MyGLImplementation implements GL,GL10,GL11,... { 632 * ... 633 * } 634 * } 635 * </pre> 636 * @see #setGLWrapper(GLWrapper) 637 */ 638 public interface GLWrapper { 639 /** 640 * Wraps a gl interface in another gl interface. 641 * @param gl a GL interface that is to be wrapped. 642 * @return either the input argument or another GL object that wraps the input argument. 643 */ 644 GL wrap(GL gl); 645 } 646 647 /** 648 * A generic renderer interface. 649 * <p> 650 * The renderer is responsible for making OpenGL calls to render a frame. 651 * <p> 652 * GLSurfaceView clients typically create their own classes that implement 653 * this interface, and then call {@link GLSurfaceView#setRenderer} to 654 * register the renderer with the GLSurfaceView. 655 * <p> 656 * 657 * <div class="special reference"> 658 * <h3>Developer Guides</h3> 659 * <p>For more information about how to use OpenGL, read the 660 * <a href="{@docRoot}guide/topics/graphics/opengl.html">OpenGL</a> developer guide.</p> 661 * </div> 662 * 663 * <h3>Threading</h3> 664 * The renderer will be called on a separate thread, so that rendering 665 * performance is decoupled from the UI thread. Clients typically need to 666 * communicate with the renderer from the UI thread, because that's where 667 * input events are received. Clients can communicate using any of the 668 * standard Java techniques for cross-thread communication, or they can 669 * use the {@link GLSurfaceView#queueEvent(Runnable)} convenience method. 670 * <p> 671 * <h3>EGL Context Lost</h3> 672 * There are situations where the EGL rendering context will be lost. This 673 * typically happens when device wakes up after going to sleep. When 674 * the EGL context is lost, all OpenGL resources (such as textures) that are 675 * associated with that context will be automatically deleted. In order to 676 * keep rendering correctly, a renderer must recreate any lost resources 677 * that it still needs. The {@link #onSurfaceCreated(GL10, EGLConfig)} method 678 * is a convenient place to do this. 679 * 680 * 681 * @see #setRenderer(Renderer) 682 */ 683 public interface Renderer { 684 /** 685 * Called when the surface is created or recreated. 686 * <p> 687 * Called when the rendering thread 688 * starts and whenever the EGL context is lost. The EGL context will typically 689 * be lost when the Android device awakes after going to sleep. 690 * <p> 691 * Since this method is called at the beginning of rendering, as well as 692 * every time the EGL context is lost, this method is a convenient place to put 693 * code to create resources that need to be created when the rendering 694 * starts, and that need to be recreated when the EGL context is lost. 695 * Textures are an example of a resource that you might want to create 696 * here. 697 * <p> 698 * Note that when the EGL context is lost, all OpenGL resources associated 699 * with that context will be automatically deleted. You do not need to call 700 * the corresponding "glDelete" methods such as glDeleteTextures to 701 * manually delete these lost resources. 702 * <p> 703 * @param gl the GL interface. Use <code>instanceof</code> to 704 * test if the interface supports GL11 or higher interfaces. 705 * @param config the EGLConfig of the created surface. Can be used 706 * to create matching pbuffers. 707 */ 708 void onSurfaceCreated(GL10 gl, EGLConfig config); 709 710 /** 711 * Called when the surface changed size. 712 * <p> 713 * Called after the surface is created and whenever 714 * the OpenGL ES surface size changes. 715 * <p> 716 * Typically you will set your viewport here. If your camera 717 * is fixed then you could also set your projection matrix here: 718 * <pre class="prettyprint"> 719 * void onSurfaceChanged(GL10 gl, int width, int height) { 720 * gl.glViewport(0, 0, width, height); 721 * // for a fixed camera, set the projection too 722 * float ratio = (float) width / height; 723 * gl.glMatrixMode(GL10.GL_PROJECTION); 724 * gl.glLoadIdentity(); 725 * gl.glFrustumf(-ratio, ratio, -1, 1, 1, 10); 726 * } 727 * </pre> 728 * @param gl the GL interface. Use <code>instanceof</code> to 729 * test if the interface supports GL11 or higher interfaces. 730 * @param width 731 * @param height 732 */ 733 void onSurfaceChanged(GL10 gl, int width, int height); 734 735 /** 736 * Called to draw the current frame. 737 * <p> 738 * This method is responsible for drawing the current frame. 739 * <p> 740 * The implementation of this method typically looks like this: 741 * <pre class="prettyprint"> 742 * void onDrawFrame(GL10 gl) { 743 * gl.glClear(GL10.GL_COLOR_BUFFER_BIT | GL10.GL_DEPTH_BUFFER_BIT); 744 * //... other gl calls to render the scene ... 745 * } 746 * </pre> 747 * @param gl the GL interface. Use <code>instanceof</code> to 748 * test if the interface supports GL11 or higher interfaces. 749 */ 750 void onDrawFrame(GL10 gl); 751 } 752 753 /** 754 * An interface for customizing the eglCreateContext and eglDestroyContext calls. 755 * <p> 756 * This interface must be implemented by clients wishing to call 757 * {@link GLSurfaceView#setEGLContextFactory(EGLContextFactory)} 758 */ 759 public interface EGLContextFactory { 760 EGLContext createContext(EGL10 egl, EGLDisplay display, EGLConfig eglConfig); 761 void destroyContext(EGL10 egl, EGLDisplay display, EGLContext context); 762 } 763 764 private class DefaultContextFactory implements EGLContextFactory { 765 private int EGL_CONTEXT_CLIENT_VERSION = 0x3098; 766 767 public EGLContext createContext(EGL10 egl, EGLDisplay display, EGLConfig config) { 768 int[] attrib_list = {EGL_CONTEXT_CLIENT_VERSION, mEGLContextClientVersion, 769 EGL10.EGL_NONE }; 770 771 return egl.eglCreateContext(display, config, EGL10.EGL_NO_CONTEXT, 772 mEGLContextClientVersion != 0 ? attrib_list : null); 773 } 774 775 public void destroyContext(EGL10 egl, EGLDisplay display, 776 EGLContext context) { 777 if (!egl.eglDestroyContext(display, context)) { 778 Log.e("DefaultContextFactory", "display:" + display + " context: " + context); 779 if (LOG_THREADS) { 780 Log.i("DefaultContextFactory", "tid=" + Thread.currentThread().getId()); 781 } 782 throw new RuntimeException("eglDestroyContext failed: " 783 + EGLLogWrapper.getErrorString(egl.eglGetError())); 784 } 785 } 786 } 787 788 /** 789 * An interface for customizing the eglCreateWindowSurface and eglDestroySurface calls. 790 * <p> 791 * This interface must be implemented by clients wishing to call 792 * {@link GLSurfaceView#setEGLWindowSurfaceFactory(EGLWindowSurfaceFactory)} 793 */ 794 public interface EGLWindowSurfaceFactory { 795 /** 796 * @return null if the surface cannot be constructed. 797 */ 798 EGLSurface createWindowSurface(EGL10 egl, EGLDisplay display, EGLConfig config, 799 Object nativeWindow); 800 void destroySurface(EGL10 egl, EGLDisplay display, EGLSurface surface); 801 } 802 803 private static class DefaultWindowSurfaceFactory implements EGLWindowSurfaceFactory { 804 805 public EGLSurface createWindowSurface(EGL10 egl, EGLDisplay display, 806 EGLConfig config, Object nativeWindow) { 807 EGLSurface result = null; 808 try { 809 result = egl.eglCreateWindowSurface(display, config, nativeWindow, null); 810 } catch (IllegalArgumentException e) { 811 // This exception indicates that the surface flinger surface 812 // is not valid. This can happen if the surface flinger surface has 813 // been torn down, but the application has not yet been 814 // notified via SurfaceHolder.Callback.surfaceDestroyed. 815 // In theory the application should be notified first, 816 // but in practice sometimes it is not. See b/4588890 817 Log.e(TAG, "eglCreateWindowSurface", e); 818 } 819 return result; 820 } 821 822 public void destroySurface(EGL10 egl, EGLDisplay display, 823 EGLSurface surface) { 824 egl.eglDestroySurface(display, surface); 825 } 826 } 827 828 /** 829 * An interface for choosing an EGLConfig configuration from a list of 830 * potential configurations. 831 * <p> 832 * This interface must be implemented by clients wishing to call 833 * {@link GLSurfaceView#setEGLConfigChooser(EGLConfigChooser)} 834 */ 835 public interface EGLConfigChooser { 836 /** 837 * Choose a configuration from the list. Implementors typically 838 * implement this method by calling 839 * {@link EGL10#eglChooseConfig} and iterating through the results. Please consult the 840 * EGL specification available from The Khronos Group to learn how to call eglChooseConfig. 841 * @param egl the EGL10 for the current display. 842 * @param display the current display. 843 * @return the chosen configuration. 844 */ 845 EGLConfig chooseConfig(EGL10 egl, EGLDisplay display); 846 } 847 848 private abstract class BaseConfigChooser 849 implements EGLConfigChooser { 850 public BaseConfigChooser(int[] configSpec) { 851 mConfigSpec = filterConfigSpec(configSpec); 852 } 853 854 public EGLConfig chooseConfig(EGL10 egl, EGLDisplay display) { 855 int[] num_config = new int[1]; 856 if (!egl.eglChooseConfig(display, mConfigSpec, null, 0, 857 num_config)) { 858 throw new IllegalArgumentException("eglChooseConfig failed"); 859 } 860 861 int numConfigs = num_config[0]; 862 863 if (numConfigs <= 0) { 864 throw new IllegalArgumentException( 865 "No configs match configSpec"); 866 } 867 868 EGLConfig[] configs = new EGLConfig[numConfigs]; 869 if (!egl.eglChooseConfig(display, mConfigSpec, configs, numConfigs, 870 num_config)) { 871 throw new IllegalArgumentException("eglChooseConfig#2 failed"); 872 } 873 EGLConfig config = chooseConfig(egl, display, configs); 874 if (config == null) { 875 throw new IllegalArgumentException("No config chosen"); 876 } 877 return config; 878 } 879 880 abstract EGLConfig chooseConfig(EGL10 egl, EGLDisplay display, 881 EGLConfig[] configs); 882 883 protected int[] mConfigSpec; 884 885 private int[] filterConfigSpec(int[] configSpec) { 886 if (mEGLContextClientVersion != 2) { 887 return configSpec; 888 } 889 /* We know none of the subclasses define EGL_RENDERABLE_TYPE. 890 * And we know the configSpec is well formed. 891 */ 892 int len = configSpec.length; 893 int[] newConfigSpec = new int[len + 2]; 894 System.arraycopy(configSpec, 0, newConfigSpec, 0, len-1); 895 newConfigSpec[len-1] = EGL10.EGL_RENDERABLE_TYPE; 896 newConfigSpec[len] = 4; /* EGL_OPENGL_ES2_BIT */ 897 newConfigSpec[len+1] = EGL10.EGL_NONE; 898 return newConfigSpec; 899 } 900 } 901 902 /** 903 * Choose a configuration with exactly the specified r,g,b,a sizes, 904 * and at least the specified depth and stencil sizes. 905 */ 906 private class ComponentSizeChooser extends BaseConfigChooser { 907 public ComponentSizeChooser(int redSize, int greenSize, int blueSize, 908 int alphaSize, int depthSize, int stencilSize) { 909 super(new int[] { 910 EGL10.EGL_RED_SIZE, redSize, 911 EGL10.EGL_GREEN_SIZE, greenSize, 912 EGL10.EGL_BLUE_SIZE, blueSize, 913 EGL10.EGL_ALPHA_SIZE, alphaSize, 914 EGL10.EGL_DEPTH_SIZE, depthSize, 915 EGL10.EGL_STENCIL_SIZE, stencilSize, 916 EGL10.EGL_NONE}); 917 mValue = new int[1]; 918 mRedSize = redSize; 919 mGreenSize = greenSize; 920 mBlueSize = blueSize; 921 mAlphaSize = alphaSize; 922 mDepthSize = depthSize; 923 mStencilSize = stencilSize; 924 } 925 926 @Override 927 public EGLConfig chooseConfig(EGL10 egl, EGLDisplay display, 928 EGLConfig[] configs) { 929 for (EGLConfig config : configs) { 930 int d = findConfigAttrib(egl, display, config, 931 EGL10.EGL_DEPTH_SIZE, 0); 932 int s = findConfigAttrib(egl, display, config, 933 EGL10.EGL_STENCIL_SIZE, 0); 934 if ((d >= mDepthSize) && (s >= mStencilSize)) { 935 int r = findConfigAttrib(egl, display, config, 936 EGL10.EGL_RED_SIZE, 0); 937 int g = findConfigAttrib(egl, display, config, 938 EGL10.EGL_GREEN_SIZE, 0); 939 int b = findConfigAttrib(egl, display, config, 940 EGL10.EGL_BLUE_SIZE, 0); 941 int a = findConfigAttrib(egl, display, config, 942 EGL10.EGL_ALPHA_SIZE, 0); 943 if ((r == mRedSize) && (g == mGreenSize) 944 && (b == mBlueSize) && (a == mAlphaSize)) { 945 return config; 946 } 947 } 948 } 949 return null; 950 } 951 952 private int findConfigAttrib(EGL10 egl, EGLDisplay display, 953 EGLConfig config, int attribute, int defaultValue) { 954 955 if (egl.eglGetConfigAttrib(display, config, attribute, mValue)) { 956 return mValue[0]; 957 } 958 return defaultValue; 959 } 960 961 private int[] mValue; 962 // Subclasses can adjust these values: 963 protected int mRedSize; 964 protected int mGreenSize; 965 protected int mBlueSize; 966 protected int mAlphaSize; 967 protected int mDepthSize; 968 protected int mStencilSize; 969 } 970 971 /** 972 * This class will choose a RGB_565 surface with 973 * or without a depth buffer. 974 * 975 */ 976 private class SimpleEGLConfigChooser extends ComponentSizeChooser { 977 public SimpleEGLConfigChooser(boolean withDepthBuffer) { 978 super(5, 6, 5, 0, withDepthBuffer ? 16 : 0, 0); 979 } 980 } 981 982 /** 983 * An EGL helper class. 984 */ 985 986 private static class EglHelper { 987 public EglHelper(WeakReference<GLSurfaceView> glSurfaceViewWeakRef) { 988 mGLSurfaceViewWeakRef = glSurfaceViewWeakRef; 989 } 990 991 /** 992 * Initialize EGL for a given configuration spec. 993 * @param configSpec 994 */ 995 public void start() { 996 if (LOG_EGL) { 997 Log.w("EglHelper", "start() tid=" + Thread.currentThread().getId()); 998 } 999 /* 1000 * Get an EGL instance 1001 */ 1002 mEgl = (EGL10) EGLContext.getEGL(); 1003 1004 /* 1005 * Get to the default display. 1006 */ 1007 mEglDisplay = mEgl.eglGetDisplay(EGL10.EGL_DEFAULT_DISPLAY); 1008 1009 if (mEglDisplay == EGL10.EGL_NO_DISPLAY) { 1010 throw new RuntimeException("eglGetDisplay failed"); 1011 } 1012 1013 /* 1014 * We can now initialize EGL for that display 1015 */ 1016 int[] version = new int[2]; 1017 if(!mEgl.eglInitialize(mEglDisplay, version)) { 1018 throw new RuntimeException("eglInitialize failed"); 1019 } 1020 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1021 if (view == null) { 1022 mEglConfig = null; 1023 mEglContext = null; 1024 } else { 1025 mEglConfig = view.mEGLConfigChooser.chooseConfig(mEgl, mEglDisplay); 1026 1027 /* 1028 * Create an EGL context. We want to do this as rarely as we can, because an 1029 * EGL context is a somewhat heavy object. 1030 */ 1031 mEglContext = view.mEGLContextFactory.createContext(mEgl, mEglDisplay, mEglConfig); 1032 } 1033 if (mEglContext == null || mEglContext == EGL10.EGL_NO_CONTEXT) { 1034 mEglContext = null; 1035 throwEglException("createContext"); 1036 } 1037 if (LOG_EGL) { 1038 Log.w("EglHelper", "createContext " + mEglContext + " tid=" + Thread.currentThread().getId()); 1039 } 1040 1041 mEglSurface = null; 1042 } 1043 1044 /** 1045 * Create an egl surface for the current SurfaceHolder surface. If a surface 1046 * already exists, destroy it before creating the new surface. 1047 * 1048 * @return true if the surface was created successfully. 1049 */ 1050 public boolean createSurface() { 1051 if (LOG_EGL) { 1052 Log.w("EglHelper", "createSurface() tid=" + Thread.currentThread().getId()); 1053 } 1054 /* 1055 * Check preconditions. 1056 */ 1057 if (mEgl == null) { 1058 throw new RuntimeException("egl not initialized"); 1059 } 1060 if (mEglDisplay == null) { 1061 throw new RuntimeException("eglDisplay not initialized"); 1062 } 1063 if (mEglConfig == null) { 1064 throw new RuntimeException("mEglConfig not initialized"); 1065 } 1066 1067 /* 1068 * The window size has changed, so we need to create a new 1069 * surface. 1070 */ 1071 destroySurfaceImp(); 1072 1073 /* 1074 * Create an EGL surface we can render into. 1075 */ 1076 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1077 if (view != null) { 1078 mEglSurface = view.mEGLWindowSurfaceFactory.createWindowSurface(mEgl, 1079 mEglDisplay, mEglConfig, view.getHolder()); 1080 } else { 1081 mEglSurface = null; 1082 } 1083 1084 if (mEglSurface == null || mEglSurface == EGL10.EGL_NO_SURFACE) { 1085 int error = mEgl.eglGetError(); 1086 if (error == EGL10.EGL_BAD_NATIVE_WINDOW) { 1087 Log.e("EglHelper", "createWindowSurface returned EGL_BAD_NATIVE_WINDOW."); 1088 } 1089 return false; 1090 } 1091 1092 /* 1093 * Before we can issue GL commands, we need to make sure 1094 * the context is current and bound to a surface. 1095 */ 1096 if (!mEgl.eglMakeCurrent(mEglDisplay, mEglSurface, mEglSurface, mEglContext)) { 1097 throwEglException("eglMakeCurrent"); 1098 } 1099 1100 return true; 1101 } 1102 1103 /** 1104 * Create a GL object for the current EGL context. 1105 * @return 1106 */ 1107 GL createGL() { 1108 1109 GL gl = mEglContext.getGL(); 1110 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1111 if (view != null) { 1112 if (view.mGLWrapper != null) { 1113 gl = view.mGLWrapper.wrap(gl); 1114 } 1115 1116 if ((view.mDebugFlags & (DEBUG_CHECK_GL_ERROR | DEBUG_LOG_GL_CALLS)) != 0) { 1117 int configFlags = 0; 1118 Writer log = null; 1119 if ((view.mDebugFlags & DEBUG_CHECK_GL_ERROR) != 0) { 1120 configFlags |= GLDebugHelper.CONFIG_CHECK_GL_ERROR; 1121 } 1122 if ((view.mDebugFlags & DEBUG_LOG_GL_CALLS) != 0) { 1123 log = new LogWriter(); 1124 } 1125 gl = GLDebugHelper.wrap(gl, configFlags, log); 1126 } 1127 } 1128 return gl; 1129 } 1130 1131 /** 1132 * Display the current render surface. 1133 * @return false if the context has been lost. 1134 */ 1135 public boolean swap() { 1136 if (! mEgl.eglSwapBuffers(mEglDisplay, mEglSurface)) { 1137 1138 /* 1139 * Check for EGL_CONTEXT_LOST, which means the context 1140 * and all associated data were lost (For instance because 1141 * the device went to sleep). We need to sleep until we 1142 * get a new surface. 1143 */ 1144 int error = mEgl.eglGetError(); 1145 switch(error) { 1146 case EGL11.EGL_CONTEXT_LOST: 1147 return false; 1148 case EGL10.EGL_BAD_NATIVE_WINDOW: 1149 // The native window is bad, probably because the 1150 // window manager has closed it. Ignore this error, 1151 // on the expectation that the application will be closed soon. 1152 Log.e("EglHelper", "eglSwapBuffers returned EGL_BAD_NATIVE_WINDOW. tid=" + Thread.currentThread().getId()); 1153 break; 1154 default: 1155 throwEglException("eglSwapBuffers", error); 1156 } 1157 } 1158 return true; 1159 } 1160 1161 public void destroySurface() { 1162 if (LOG_EGL) { 1163 Log.w("EglHelper", "destroySurface() tid=" + Thread.currentThread().getId()); 1164 } 1165 destroySurfaceImp(); 1166 } 1167 1168 private void destroySurfaceImp() { 1169 if (mEglSurface != null && mEglSurface != EGL10.EGL_NO_SURFACE) { 1170 mEgl.eglMakeCurrent(mEglDisplay, EGL10.EGL_NO_SURFACE, 1171 EGL10.EGL_NO_SURFACE, 1172 EGL10.EGL_NO_CONTEXT); 1173 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1174 if (view != null) { 1175 view.mEGLWindowSurfaceFactory.destroySurface(mEgl, mEglDisplay, mEglSurface); 1176 } 1177 mEglSurface = null; 1178 } 1179 } 1180 1181 public void finish() { 1182 if (LOG_EGL) { 1183 Log.w("EglHelper", "finish() tid=" + Thread.currentThread().getId()); 1184 } 1185 if (mEglContext != null) { 1186 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1187 if (view != null) { 1188 view.mEGLContextFactory.destroyContext(mEgl, mEglDisplay, mEglContext); 1189 } 1190 mEglContext = null; 1191 } 1192 if (mEglDisplay != null) { 1193 mEgl.eglTerminate(mEglDisplay); 1194 mEglDisplay = null; 1195 } 1196 } 1197 1198 private void throwEglException(String function) { 1199 throwEglException(function, mEgl.eglGetError()); 1200 } 1201 1202 private void throwEglException(String function, int error) { 1203 String message = function + " failed: " + EGLLogWrapper.getErrorString(error); 1204 if (LOG_THREADS) { 1205 Log.e("EglHelper", "throwEglException tid=" + Thread.currentThread().getId() + " " + message); 1206 } 1207 throw new RuntimeException(message); 1208 } 1209 1210 private WeakReference<GLSurfaceView> mGLSurfaceViewWeakRef; 1211 EGL10 mEgl; 1212 EGLDisplay mEglDisplay; 1213 EGLSurface mEglSurface; 1214 EGLConfig mEglConfig; 1215 EGLContext mEglContext; 1216 1217 } 1218 1219 /** 1220 * A generic GL Thread. Takes care of initializing EGL and GL. Delegates 1221 * to a Renderer instance to do the actual drawing. Can be configured to 1222 * render continuously or on request. 1223 * 1224 * All potentially blocking synchronization is done through the 1225 * sGLThreadManager object. This avoids multiple-lock ordering issues. 1226 * 1227 */ 1228 static class GLThread extends Thread { 1229 GLThread(WeakReference<GLSurfaceView> glSurfaceViewWeakRef) { 1230 super(); 1231 mWidth = 0; 1232 mHeight = 0; 1233 mRequestRender = true; 1234 mRenderMode = RENDERMODE_CONTINUOUSLY; 1235 mGLSurfaceViewWeakRef = glSurfaceViewWeakRef; 1236 } 1237 1238 @Override 1239 public void run() { 1240 setName("GLThread " + getId()); 1241 if (LOG_THREADS) { 1242 Log.i("GLThread", "starting tid=" + getId()); 1243 } 1244 1245 try { 1246 guardedRun(); 1247 } catch (InterruptedException e) { 1248 // fall thru and exit normally 1249 } finally { 1250 sGLThreadManager.threadExiting(this); 1251 } 1252 } 1253 1254 /* 1255 * This private method should only be called inside a 1256 * synchronized(sGLThreadManager) block. 1257 */ 1258 private void stopEglSurfaceLocked() { 1259 if (mHaveEglSurface) { 1260 mHaveEglSurface = false; 1261 mEglHelper.destroySurface(); 1262 } 1263 } 1264 1265 /* 1266 * This private method should only be called inside a 1267 * synchronized(sGLThreadManager) block. 1268 */ 1269 private void stopEglContextLocked() { 1270 if (mHaveEglContext) { 1271 mEglHelper.finish(); 1272 mHaveEglContext = false; 1273 sGLThreadManager.releaseEglContextLocked(this); 1274 } 1275 } 1276 private void guardedRun() throws InterruptedException { 1277 mEglHelper = new EglHelper(mGLSurfaceViewWeakRef); 1278 mHaveEglContext = false; 1279 mHaveEglSurface = false; 1280 try { 1281 GL10 gl = null; 1282 boolean createEglContext = false; 1283 boolean createEglSurface = false; 1284 boolean createGlInterface = false; 1285 boolean lostEglContext = false; 1286 boolean sizeChanged = false; 1287 boolean wantRenderNotification = false; 1288 boolean doRenderNotification = false; 1289 boolean askedToReleaseEglContext = false; 1290 int w = 0; 1291 int h = 0; 1292 Runnable event = null; 1293 1294 while (true) { 1295 synchronized (sGLThreadManager) { 1296 while (true) { 1297 if (mShouldExit) { 1298 return; 1299 } 1300 1301 if (! mEventQueue.isEmpty()) { 1302 event = mEventQueue.remove(0); 1303 break; 1304 } 1305 1306 // Update the pause state. 1307 if (mPaused != mRequestPaused) { 1308 mPaused = mRequestPaused; 1309 sGLThreadManager.notifyAll(); 1310 if (LOG_PAUSE_RESUME) { 1311 Log.i("GLThread", "mPaused is now " + mPaused + " tid=" + getId()); 1312 } 1313 } 1314 1315 // Do we need to give up the EGL context? 1316 if (mShouldReleaseEglContext) { 1317 if (LOG_SURFACE) { 1318 Log.i("GLThread", "releasing EGL context because asked to tid=" + getId()); 1319 } 1320 stopEglSurfaceLocked(); 1321 stopEglContextLocked(); 1322 mShouldReleaseEglContext = false; 1323 askedToReleaseEglContext = true; 1324 } 1325 1326 // Have we lost the EGL context? 1327 if (lostEglContext) { 1328 stopEglSurfaceLocked(); 1329 stopEglContextLocked(); 1330 lostEglContext = false; 1331 } 1332 1333 // Do we need to release the EGL surface? 1334 if (mHaveEglSurface && mPaused) { 1335 if (LOG_SURFACE) { 1336 Log.i("GLThread", "releasing EGL surface because paused tid=" + getId()); 1337 } 1338 stopEglSurfaceLocked(); 1339 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1340 boolean preserveEglContextOnPause = view == null ? 1341 false : view.mPreserveEGLContextOnPause; 1342 if (!preserveEglContextOnPause || sGLThreadManager.shouldReleaseEGLContextWhenPausing()) { 1343 stopEglContextLocked(); 1344 if (LOG_SURFACE) { 1345 Log.i("GLThread", "releasing EGL context because paused tid=" + getId()); 1346 } 1347 } 1348 if (sGLThreadManager.shouldTerminateEGLWhenPausing()) { 1349 mEglHelper.finish(); 1350 if (LOG_SURFACE) { 1351 Log.i("GLThread", "terminating EGL because paused tid=" + getId()); 1352 } 1353 } 1354 } 1355 1356 // Have we lost the surface view surface? 1357 if ((! mHasSurface) && (! mWaitingForSurface)) { 1358 if (LOG_SURFACE) { 1359 Log.i("GLThread", "noticed surfaceView surface lost tid=" + getId()); 1360 } 1361 if (mHaveEglSurface) { 1362 stopEglSurfaceLocked(); 1363 } 1364 mWaitingForSurface = true; 1365 sGLThreadManager.notifyAll(); 1366 } 1367 1368 // Have we acquired the surface view surface? 1369 if (mHasSurface && mWaitingForSurface) { 1370 if (LOG_SURFACE) { 1371 Log.i("GLThread", "noticed surfaceView surface acquired tid=" + getId()); 1372 } 1373 mWaitingForSurface = false; 1374 sGLThreadManager.notifyAll(); 1375 } 1376 1377 if (doRenderNotification) { 1378 if (LOG_SURFACE) { 1379 Log.i("GLThread", "sending render notification tid=" + getId()); 1380 } 1381 wantRenderNotification = false; 1382 doRenderNotification = false; 1383 mRenderComplete = true; 1384 sGLThreadManager.notifyAll(); 1385 } 1386 1387 // Ready to draw? 1388 if (readyToDraw()) { 1389 1390 // If we don't have an EGL context, try to acquire one. 1391 if (! mHaveEglContext) { 1392 if (askedToReleaseEglContext) { 1393 askedToReleaseEglContext = false; 1394 } else if (sGLThreadManager.tryAcquireEglContextLocked(this)) { 1395 try { 1396 mEglHelper.start(); 1397 } catch (RuntimeException t) { 1398 sGLThreadManager.releaseEglContextLocked(this); 1399 throw t; 1400 } 1401 mHaveEglContext = true; 1402 createEglContext = true; 1403 1404 sGLThreadManager.notifyAll(); 1405 } 1406 } 1407 1408 if (mHaveEglContext && !mHaveEglSurface) { 1409 mHaveEglSurface = true; 1410 createEglSurface = true; 1411 createGlInterface = true; 1412 sizeChanged = true; 1413 } 1414 1415 if (mHaveEglSurface) { 1416 if (mSizeChanged) { 1417 sizeChanged = true; 1418 w = mWidth; 1419 h = mHeight; 1420 wantRenderNotification = true; 1421 if (LOG_SURFACE) { 1422 Log.i("GLThread", "noticing that we want render notification tid=" + getId()); 1423 } 1424 1425 // Destroy and recreate the EGL surface. 1426 createEglSurface = true; 1427 1428 mSizeChanged = false; 1429 } 1430 mRequestRender = false; 1431 sGLThreadManager.notifyAll(); 1432 break; 1433 } 1434 } 1435 1436 // By design, this is the only place in a GLThread thread where we wait(). 1437 if (LOG_THREADS) { 1438 Log.i("GLThread", "waiting tid=" + getId() 1439 + " mHaveEglContext: " + mHaveEglContext 1440 + " mHaveEglSurface: " + mHaveEglSurface 1441 + " mPaused: " + mPaused 1442 + " mHasSurface: " + mHasSurface 1443 + " mWaitingForSurface: " + mWaitingForSurface 1444 + " mWidth: " + mWidth 1445 + " mHeight: " + mHeight 1446 + " mRequestRender: " + mRequestRender 1447 + " mRenderMode: " + mRenderMode); 1448 } 1449 sGLThreadManager.wait(); 1450 } 1451 } // end of synchronized(sGLThreadManager) 1452 1453 if (event != null) { 1454 event.run(); 1455 event = null; 1456 continue; 1457 } 1458 1459 if (createEglSurface) { 1460 if (LOG_SURFACE) { 1461 Log.w("GLThread", "egl createSurface"); 1462 } 1463 if (!mEglHelper.createSurface()) { 1464 // Couldn't create a surface. Quit quietly. 1465 break; 1466 } 1467 createEglSurface = false; 1468 } 1469 1470 if (createGlInterface) { 1471 gl = (GL10) mEglHelper.createGL(); 1472 1473 sGLThreadManager.checkGLDriver(gl); 1474 createGlInterface = false; 1475 } 1476 1477 if (createEglContext) { 1478 if (LOG_RENDERER) { 1479 Log.w("GLThread", "onSurfaceCreated"); 1480 } 1481 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1482 if (view != null) { 1483 view.mRenderer.onSurfaceCreated(gl, mEglHelper.mEglConfig); 1484 } 1485 createEglContext = false; 1486 } 1487 1488 if (sizeChanged) { 1489 if (LOG_RENDERER) { 1490 Log.w("GLThread", "onSurfaceChanged(" + w + ", " + h + ")"); 1491 } 1492 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1493 if (view != null) { 1494 view.mRenderer.onSurfaceChanged(gl, w, h); 1495 } 1496 sizeChanged = false; 1497 } 1498 1499 if (LOG_RENDERER_DRAW_FRAME) { 1500 Log.w("GLThread", "onDrawFrame tid=" + getId()); 1501 } 1502 { 1503 GLSurfaceView view = mGLSurfaceViewWeakRef.get(); 1504 if (view != null) { 1505 view.mRenderer.onDrawFrame(gl); 1506 } 1507 } 1508 if (!mEglHelper.swap()) { 1509 if (LOG_SURFACE) { 1510 Log.i("GLThread", "egl context lost tid=" + getId()); 1511 } 1512 lostEglContext = true; 1513 } 1514 1515 if (wantRenderNotification) { 1516 doRenderNotification = true; 1517 } 1518 } 1519 1520 } finally { 1521 /* 1522 * clean-up everything... 1523 */ 1524 synchronized (sGLThreadManager) { 1525 stopEglSurfaceLocked(); 1526 stopEglContextLocked(); 1527 } 1528 } 1529 } 1530 1531 public boolean ableToDraw() { 1532 return mHaveEglContext && mHaveEglSurface && readyToDraw(); 1533 } 1534 1535 private boolean readyToDraw() { 1536 return (!mPaused) && mHasSurface 1537 && (mWidth > 0) && (mHeight > 0) 1538 && (mRequestRender || (mRenderMode == RENDERMODE_CONTINUOUSLY)); 1539 } 1540 1541 public void setRenderMode(int renderMode) { 1542 if ( !((RENDERMODE_WHEN_DIRTY <= renderMode) && (renderMode <= RENDERMODE_CONTINUOUSLY)) ) { 1543 throw new IllegalArgumentException("renderMode"); 1544 } 1545 synchronized(sGLThreadManager) { 1546 mRenderMode = renderMode; 1547 sGLThreadManager.notifyAll(); 1548 } 1549 } 1550 1551 public int getRenderMode() { 1552 synchronized(sGLThreadManager) { 1553 return mRenderMode; 1554 } 1555 } 1556 1557 public void requestRender() { 1558 synchronized(sGLThreadManager) { 1559 mRequestRender = true; 1560 sGLThreadManager.notifyAll(); 1561 } 1562 } 1563 1564 public void surfaceCreated() { 1565 synchronized(sGLThreadManager) { 1566 if (LOG_THREADS) { 1567 Log.i("GLThread", "surfaceCreated tid=" + getId()); 1568 } 1569 mHasSurface = true; 1570 sGLThreadManager.notifyAll(); 1571 while((mWaitingForSurface) && (!mExited)) { 1572 try { 1573 sGLThreadManager.wait(); 1574 } catch (InterruptedException e) { 1575 Thread.currentThread().interrupt(); 1576 } 1577 } 1578 } 1579 } 1580 1581 public void surfaceDestroyed() { 1582 synchronized(sGLThreadManager) { 1583 if (LOG_THREADS) { 1584 Log.i("GLThread", "surfaceDestroyed tid=" + getId()); 1585 } 1586 mHasSurface = false; 1587 sGLThreadManager.notifyAll(); 1588 while((!mWaitingForSurface) && (!mExited)) { 1589 try { 1590 sGLThreadManager.wait(); 1591 } catch (InterruptedException e) { 1592 Thread.currentThread().interrupt(); 1593 } 1594 } 1595 } 1596 } 1597 1598 public void onPause() { 1599 synchronized (sGLThreadManager) { 1600 if (LOG_PAUSE_RESUME) { 1601 Log.i("GLThread", "onPause tid=" + getId()); 1602 } 1603 mRequestPaused = true; 1604 sGLThreadManager.notifyAll(); 1605 while ((! mExited) && (! mPaused)) { 1606 if (LOG_PAUSE_RESUME) { 1607 Log.i("Main thread", "onPause waiting for mPaused."); 1608 } 1609 try { 1610 sGLThreadManager.wait(); 1611 } catch (InterruptedException ex) { 1612 Thread.currentThread().interrupt(); 1613 } 1614 } 1615 } 1616 } 1617 1618 public void onResume() { 1619 synchronized (sGLThreadManager) { 1620 if (LOG_PAUSE_RESUME) { 1621 Log.i("GLThread", "onResume tid=" + getId()); 1622 } 1623 mRequestPaused = false; 1624 mRequestRender = true; 1625 mRenderComplete = false; 1626 sGLThreadManager.notifyAll(); 1627 while ((! mExited) && mPaused && (!mRenderComplete)) { 1628 if (LOG_PAUSE_RESUME) { 1629 Log.i("Main thread", "onResume waiting for !mPaused."); 1630 } 1631 try { 1632 sGLThreadManager.wait(); 1633 } catch (InterruptedException ex) { 1634 Thread.currentThread().interrupt(); 1635 } 1636 } 1637 } 1638 } 1639 1640 public void onWindowResize(int w, int h) { 1641 synchronized (sGLThreadManager) { 1642 mWidth = w; 1643 mHeight = h; 1644 mSizeChanged = true; 1645 mRequestRender = true; 1646 mRenderComplete = false; 1647 sGLThreadManager.notifyAll(); 1648 1649 // Wait for thread to react to resize and render a frame 1650 while (! mExited && !mPaused && !mRenderComplete 1651 && ableToDraw()) { 1652 if (LOG_SURFACE) { 1653 Log.i("Main thread", "onWindowResize waiting for render complete from tid=" + getId()); 1654 } 1655 try { 1656 sGLThreadManager.wait(); 1657 } catch (InterruptedException ex) { 1658 Thread.currentThread().interrupt(); 1659 } 1660 } 1661 } 1662 } 1663 1664 public void requestExitAndWait() { 1665 // don't call this from GLThread thread or it is a guaranteed 1666 // deadlock! 1667 synchronized(sGLThreadManager) { 1668 mShouldExit = true; 1669 sGLThreadManager.notifyAll(); 1670 while (! mExited) { 1671 try { 1672 sGLThreadManager.wait(); 1673 } catch (InterruptedException ex) { 1674 Thread.currentThread().interrupt(); 1675 } 1676 } 1677 } 1678 } 1679 1680 public void requestReleaseEglContextLocked() { 1681 mShouldReleaseEglContext = true; 1682 sGLThreadManager.notifyAll(); 1683 } 1684 1685 /** 1686 * Queue an "event" to be run on the GL rendering thread. 1687 * @param r the runnable to be run on the GL rendering thread. 1688 */ 1689 public void queueEvent(Runnable r) { 1690 if (r == null) { 1691 throw new IllegalArgumentException("r must not be null"); 1692 } 1693 synchronized(sGLThreadManager) { 1694 mEventQueue.add(r); 1695 sGLThreadManager.notifyAll(); 1696 } 1697 } 1698 1699 // Once the thread is started, all accesses to the following member 1700 // variables are protected by the sGLThreadManager monitor 1701 private boolean mShouldExit; 1702 private boolean mExited; 1703 private boolean mRequestPaused; 1704 private boolean mPaused; 1705 private boolean mHasSurface; 1706 private boolean mWaitingForSurface; 1707 private boolean mHaveEglContext; 1708 private boolean mHaveEglSurface; 1709 private boolean mShouldReleaseEglContext; 1710 private int mWidth; 1711 private int mHeight; 1712 private int mRenderMode; 1713 private boolean mRequestRender; 1714 private boolean mRenderComplete; 1715 private ArrayList<Runnable> mEventQueue = new ArrayList<Runnable>(); 1716 private boolean mSizeChanged = true; 1717 1718 // End of member variables protected by the sGLThreadManager monitor. 1719 1720 private EglHelper mEglHelper; 1721 1722 /** 1723 * Set once at thread construction time, nulled out when the parent view is garbage 1724 * called. This weak reference allows the GLSurfaceView to be garbage collected while 1725 * the GLThread is still alive. 1726 */ 1727 private WeakReference<GLSurfaceView> mGLSurfaceViewWeakRef; 1728 1729 } 1730 1731 static class LogWriter extends Writer { 1732 1733 @Override public void close() { 1734 flushBuilder(); 1735 } 1736 1737 @Override public void flush() { 1738 flushBuilder(); 1739 } 1740 1741 @Override public void write(char[] buf, int offset, int count) { 1742 for(int i = 0; i < count; i++) { 1743 char c = buf[offset + i]; 1744 if ( c == '\n') { 1745 flushBuilder(); 1746 } 1747 else { 1748 mBuilder.append(c); 1749 } 1750 } 1751 } 1752 1753 private void flushBuilder() { 1754 if (mBuilder.length() > 0) { 1755 Log.v("GLSurfaceView", mBuilder.toString()); 1756 mBuilder.delete(0, mBuilder.length()); 1757 } 1758 } 1759 1760 private StringBuilder mBuilder = new StringBuilder(); 1761 } 1762 1763 1764 private void checkRenderThreadState() { 1765 if (mGLThread != null) { 1766 throw new IllegalStateException( 1767 "setRenderer has already been called for this instance."); 1768 } 1769 } 1770 1771 private static class GLThreadManager { 1772 private static String TAG = "GLThreadManager"; 1773 1774 public synchronized void threadExiting(GLThread thread) { 1775 if (LOG_THREADS) { 1776 Log.i("GLThread", "exiting tid=" + thread.getId()); 1777 } 1778 thread.mExited = true; 1779 if (mEglOwner == thread) { 1780 mEglOwner = null; 1781 } 1782 notifyAll(); 1783 } 1784 1785 /* 1786 * Tries once to acquire the right to use an EGL 1787 * context. Does not block. Requires that we are already 1788 * in the sGLThreadManager monitor when this is called. 1789 * 1790 * @return true if the right to use an EGL context was acquired. 1791 */ 1792 public boolean tryAcquireEglContextLocked(GLThread thread) { 1793 if (mEglOwner == thread || mEglOwner == null) { 1794 mEglOwner = thread; 1795 notifyAll(); 1796 return true; 1797 } 1798 checkGLESVersion(); 1799 if (mMultipleGLESContextsAllowed) { 1800 return true; 1801 } 1802 // Notify the owning thread that it should release the context. 1803 // TODO: implement a fairness policy. Currently 1804 // if the owning thread is drawing continuously it will just 1805 // reacquire the EGL context. 1806 if (mEglOwner != null) { 1807 mEglOwner.requestReleaseEglContextLocked(); 1808 } 1809 return false; 1810 } 1811 1812 /* 1813 * Releases the EGL context. Requires that we are already in the 1814 * sGLThreadManager monitor when this is called. 1815 */ 1816 public void releaseEglContextLocked(GLThread thread) { 1817 if (mEglOwner == thread) { 1818 mEglOwner = null; 1819 } 1820 notifyAll(); 1821 } 1822 1823 public synchronized boolean shouldReleaseEGLContextWhenPausing() { 1824 // Release the EGL context when pausing even if 1825 // the hardware supports multiple EGL contexts. 1826 // Otherwise the device could run out of EGL contexts. 1827 return mLimitedGLESContexts; 1828 } 1829 1830 public synchronized boolean shouldTerminateEGLWhenPausing() { 1831 checkGLESVersion(); 1832 return !mMultipleGLESContextsAllowed; 1833 } 1834 1835 public synchronized void checkGLDriver(GL10 gl) { 1836 if (! mGLESDriverCheckComplete) { 1837 checkGLESVersion(); 1838 String renderer = gl.glGetString(GL10.GL_RENDERER); 1839 if (mGLESVersion < kGLES_20) { 1840 mMultipleGLESContextsAllowed = 1841 ! renderer.startsWith(kMSM7K_RENDERER_PREFIX); 1842 notifyAll(); 1843 } 1844 mLimitedGLESContexts = !mMultipleGLESContextsAllowed || renderer.startsWith(kADRENO); 1845 if (LOG_SURFACE) { 1846 Log.w(TAG, "checkGLDriver renderer = \"" + renderer + "\" multipleContextsAllowed = " 1847 + mMultipleGLESContextsAllowed 1848 + " mLimitedGLESContexts = " + mLimitedGLESContexts); 1849 } 1850 mGLESDriverCheckComplete = true; 1851 } 1852 } 1853 1854 private void checkGLESVersion() { 1855 if (! mGLESVersionCheckComplete) { 1856 mGLESVersion = SystemProperties.getInt( 1857 "ro.opengles.version", 1858 ConfigurationInfo.GL_ES_VERSION_UNDEFINED); 1859 if (mGLESVersion >= kGLES_20) { 1860 mMultipleGLESContextsAllowed = true; 1861 } 1862 if (LOG_SURFACE) { 1863 Log.w(TAG, "checkGLESVersion mGLESVersion =" + 1864 " " + mGLESVersion + " mMultipleGLESContextsAllowed = " + mMultipleGLESContextsAllowed); 1865 } 1866 mGLESVersionCheckComplete = true; 1867 } 1868 } 1869 1870 private boolean mGLESVersionCheckComplete; 1871 private int mGLESVersion; 1872 private boolean mGLESDriverCheckComplete; 1873 private boolean mMultipleGLESContextsAllowed; 1874 private boolean mLimitedGLESContexts; 1875 private static final int kGLES_20 = 0x20000; 1876 private static final String kMSM7K_RENDERER_PREFIX = 1877 "Q3Dimension MSM7500 "; 1878 private static final String kADRENO = "Adreno"; 1879 private GLThread mEglOwner; 1880 } 1881 1882 private static final GLThreadManager sGLThreadManager = new GLThreadManager(); 1883 1884 private final WeakReference<GLSurfaceView> mThisWeakRef = 1885 new WeakReference<GLSurfaceView>(this); 1886 private GLThread mGLThread; 1887 private Renderer mRenderer; 1888 private boolean mDetached; 1889 private EGLConfigChooser mEGLConfigChooser; 1890 private EGLContextFactory mEGLContextFactory; 1891 private EGLWindowSurfaceFactory mEGLWindowSurfaceFactory; 1892 private GLWrapper mGLWrapper; 1893 private int mDebugFlags; 1894 private int mEGLContextClientVersion; 1895 private boolean mPreserveEGLContextOnPause; 1896} 1897