2 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include <dali/internal/graphics/gles/egl-implementation.h>
24 #include <dali/integration-api/debug.h>
25 #include <dali/public-api/common/dali-vector.h>
28 #include <dali/public-api/dali-adaptor-common.h>
29 #include <dali/internal/graphics/gles/gl-implementation.h>
30 #include <dali/internal/graphics/gles/egl-debug.h>
32 // EGL constants use C style casts
33 #pragma GCC diagnostic push
34 #pragma GCC diagnostic ignored "-Wold-style-cast"
38 const std::string EGL_KHR_SURFACELESS_CONTEXT = "EGL_KHR_surfaceless_context";
50 #define TEST_EGL_ERROR(lastCommand) \
52 EGLint err = eglGetError(); \
53 if (err != EGL_SUCCESS) \
55 DALI_LOG_ERROR("EGL error after %s\n", lastCommand); \
56 Egl::PrintError(err); \
57 DALI_ASSERT_ALWAYS(0 && "EGL error"); \
61 EglImplementation::EglImplementation( int multiSamplingLevel,
62 Integration::DepthBufferAvailable depthBufferRequired,
63 Integration::StencilBufferAvailable stencilBufferRequired )
65 mEglNativeDisplay( 0 ),
66 mEglNativeWindow( 0 ),
67 mCurrentEglNativePixmap( 0 ),
71 mCurrentEglSurface( 0 ),
72 mCurrentEglContext( EGL_NO_CONTEXT ),
73 mMultiSamplingLevel( multiSamplingLevel ),
75 mColorDepth( COLOR_DEPTH_24 ),
76 mGlesInitialized( false ),
77 mIsOwnSurface( true ),
79 mDepthBufferRequired( depthBufferRequired == Integration::DepthBufferAvailable::TRUE ),
80 mStencilBufferRequired( stencilBufferRequired == Integration::StencilBufferAvailable::TRUE ),
81 mIsSurfacelessContextSupported( false )
85 EglImplementation::~EglImplementation()
90 bool EglImplementation::InitializeGles( EGLNativeDisplayType display, bool isOwnSurface )
92 if ( !mGlesInitialized )
94 mEglNativeDisplay = display;
96 //@todo see if we can just EGL_DEFAULT_DISPLAY instead
97 mEglDisplay = eglGetDisplay(mEglNativeDisplay);
98 EGLint error = eglGetError();
100 if( mEglDisplay == NULL && error != EGL_SUCCESS )
102 throw Dali::DaliException( "", "OpenGL ES is not supported");
105 EGLint majorVersion = 0;
106 EGLint minorVersion = 0;
107 if ( !eglInitialize( mEglDisplay, &majorVersion, &minorVersion ) )
111 eglBindAPI(EGL_OPENGL_ES_API);
113 mGlesInitialized = true;
114 mIsOwnSurface = isOwnSurface;
117 // Query EGL extensions to check whether surfaceless context is supported
118 const char* const extensionStr = eglQueryString( mEglDisplay, EGL_EXTENSIONS );
119 std::istringstream stream(extensionStr);
120 std::string currentExtension;
121 while ( std::getline( stream, currentExtension, ' ' ) )
123 if ( currentExtension == EGL_KHR_SURFACELESS_CONTEXT )
125 mIsSurfacelessContextSupported = true;
130 // We want to display this information all the time, so use the LogMessage directly
131 Integration::Log::LogMessage(Integration::Log::DebugInfo, "EGL Information\n"
136 eglQueryString( mEglDisplay, EGL_VENDOR ),
137 eglQueryString( mEglDisplay, EGL_VERSION ),
138 eglQueryString( mEglDisplay, EGL_CLIENT_APIS ),
141 return mGlesInitialized;
144 bool EglImplementation::CreateContext()
146 // make sure a context isn't created twice
147 DALI_ASSERT_ALWAYS( (mEglContext == 0) && "EGL context recreated" );
149 mEglContext = eglCreateContext(mEglDisplay, mEglConfig, NULL, &(mContextAttribs[0]));
150 if ( eglGetError() != EGL_SUCCESS )
152 if( mGlesVersion >= 30 )
154 eglDestroySurface( mEglDisplay, mEglContext );
157 DALI_LOG_ERROR("Fail to use OpenGL es 3.0. Retrying to use OpenGL es 2.0.");
161 TEST_EGL_ERROR("eglCreateContext render thread");
163 DALI_ASSERT_ALWAYS( EGL_NO_CONTEXT != mEglContext && "EGL context not created" );
165 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VENDOR : %s ***\n", glGetString(GL_VENDOR));
166 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_RENDERER : %s ***\n", glGetString(GL_RENDERER));
167 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VERSION : %s ***\n", glGetString(GL_VERSION));
168 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_SHADING_LANGUAGE_VERSION : %s***\n", glGetString(GL_SHADING_LANGUAGE_VERSION));
169 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** Supported Extensions ***\n%s\n\n", glGetString(GL_EXTENSIONS));
174 bool EglImplementation::CreateWindowContext( EGLContext& eglContext )
176 // make sure a context isn't created twice
177 DALI_ASSERT_ALWAYS( (eglContext == 0) && "EGL context recreated" );
179 eglContext = eglCreateContext(mEglDisplay, mEglConfig, mEglContext, &(mContextAttribs[0]));
180 TEST_EGL_ERROR("eglCreateContext render thread");
182 DALI_ASSERT_ALWAYS( EGL_NO_CONTEXT != eglContext && "EGL context not created" );
184 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VENDOR : %s ***\n", glGetString(GL_VENDOR));
185 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_RENDERER : %s ***\n", glGetString(GL_RENDERER));
186 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VERSION : %s ***\n", glGetString(GL_VERSION));
187 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_SHADING_LANGUAGE_VERSION : %s***\n", glGetString(GL_SHADING_LANGUAGE_VERSION));
188 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** Supported Extensions ***\n%s\n\n", glGetString(GL_EXTENSIONS));
190 mEglWindowContexts.push_back( eglContext );
195 void EglImplementation::DestroyContext( EGLContext& eglContext )
197 DALI_ASSERT_ALWAYS( mEglContext && "no EGL context" );
199 eglDestroyContext( mEglDisplay, eglContext );
203 void EglImplementation::DestroySurface( EGLSurface& eglSurface )
205 if(mIsOwnSurface && eglSurface)
207 // Make context null to prevent crash in driver side
209 eglDestroySurface( mEglDisplay, eglSurface );
214 void EglImplementation::MakeContextCurrent( EGLSurface eglSurface, EGLContext eglContext )
216 if (mCurrentEglContext == eglContext)
221 mCurrentEglSurface = eglSurface;
225 if( mCurrentEglContext != EGL_NO_CONTEXT )
230 eglMakeCurrent( mEglDisplay, eglSurface, eglSurface, eglContext );
232 mCurrentEglContext = eglContext;
235 EGLint error = eglGetError();
237 if ( error != EGL_SUCCESS )
239 Egl::PrintError(error);
241 DALI_ASSERT_ALWAYS(false && "MakeContextCurrent failed!");
245 void EglImplementation::MakeCurrent( EGLNativePixmapType pixmap, EGLSurface eglSurface )
247 if (mCurrentEglContext == mEglContext)
252 mCurrentEglNativePixmap = pixmap;
253 mCurrentEglSurface = eglSurface;
257 if( mCurrentEglContext != EGL_NO_CONTEXT )
262 eglMakeCurrent( mEglDisplay, eglSurface, eglSurface, mEglContext );
264 mCurrentEglContext = mEglContext;
267 EGLint error = eglGetError();
269 if ( error != EGL_SUCCESS )
271 Egl::PrintError(error);
273 DALI_ASSERT_ALWAYS(false && "MakeCurrent failed!");
277 void EglImplementation::MakeContextNull()
279 // clear the current context
280 eglMakeCurrent( mEglDisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT );
281 mCurrentEglContext = EGL_NO_CONTEXT;
284 void EglImplementation::TerminateGles()
286 if ( mGlesInitialized )
288 // Make context null to prevent crash in driver side
291 for ( auto eglSurface : mEglWindowSurfaces )
293 if(mIsOwnSurface && eglSurface)
295 eglDestroySurface(mEglDisplay, eglSurface);
298 eglDestroyContext(mEglDisplay, mEglContext);
299 for ( auto eglContext : mEglWindowContexts )
301 eglDestroyContext(mEglDisplay, eglContext);
304 eglTerminate(mEglDisplay);
309 mCurrentEglSurface = NULL;
310 mCurrentEglContext = EGL_NO_CONTEXT;
312 mGlesInitialized = false;
316 bool EglImplementation::IsGlesInitialized() const
318 return mGlesInitialized;
321 void EglImplementation::SwapBuffers( EGLSurface& eglSurface )
323 if ( eglSurface != EGL_NO_SURFACE ) // skip if using surfaceless context
325 eglSwapBuffers( mEglDisplay, eglSurface );
329 void EglImplementation::CopyBuffers( EGLSurface& eglSurface )
331 eglCopyBuffers( mEglDisplay, eglSurface, mCurrentEglNativePixmap );
334 void EglImplementation::WaitGL()
339 bool EglImplementation::ChooseConfig( bool isWindowType, ColorDepth depth )
341 if(mEglConfig && isWindowType == mIsWindow && mColorDepth == depth)
347 mIsWindow = isWindowType;
350 Vector<EGLint> configAttribs;
351 configAttribs.Reserve(31);
355 configAttribs.PushBack( EGL_SURFACE_TYPE );
356 configAttribs.PushBack( EGL_WINDOW_BIT );
360 configAttribs.PushBack( EGL_SURFACE_TYPE );
361 configAttribs.PushBack( EGL_PIXMAP_BIT );
364 configAttribs.PushBack( EGL_RENDERABLE_TYPE );
366 if( mGlesVersion >= 30 )
368 configAttribs.PushBack( EGL_OPENGL_ES3_BIT_KHR );
372 configAttribs.PushBack( EGL_OPENGL_ES2_BIT );
375 // TODO: enable this flag when it becomes supported
376 // configAttribs.PushBack( EGL_CONTEXT_FLAGS_KHR );
377 // configAttribs.PushBack( EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE_BIT_KHR );
379 configAttribs.PushBack( EGL_RED_SIZE );
380 configAttribs.PushBack( 8 );
381 configAttribs.PushBack( EGL_GREEN_SIZE );
382 configAttribs.PushBack( 8 );
383 configAttribs.PushBack( EGL_BLUE_SIZE );
384 configAttribs.PushBack( 8 );
386 // In the previous code, there was a branch for ARM.
387 // If there is an issue in only ARM, we need to check here again.
388 configAttribs.PushBack( EGL_ALPHA_SIZE );
389 configAttribs.PushBack( 8 );
391 configAttribs.PushBack( EGL_DEPTH_SIZE );
392 configAttribs.PushBack( mDepthBufferRequired ? 24 : 0 );
393 configAttribs.PushBack( EGL_STENCIL_SIZE );
394 configAttribs.PushBack( mStencilBufferRequired ? 8 : 0 );
396 #ifndef DALI_PROFILE_UBUNTU
397 if( mMultiSamplingLevel != EGL_DONT_CARE )
399 configAttribs.PushBack( EGL_SAMPLES );
400 configAttribs.PushBack( mMultiSamplingLevel );
401 configAttribs.PushBack( EGL_SAMPLE_BUFFERS );
402 configAttribs.PushBack( 1 );
404 #endif // DALI_PROFILE_UBUNTU
405 configAttribs.PushBack( EGL_NONE );
407 // Ensure number of configs is set to 1 as on some drivers,
408 // eglChooseConfig succeeds but does not actually create a proper configuration.
409 if ( ( eglChooseConfig( mEglDisplay, &(configAttribs[0]), &mEglConfig, 1, &numConfigs ) != EGL_TRUE ) ||
410 ( numConfigs != 1 ) )
412 if( mGlesVersion >= 30 )
415 DALI_LOG_ERROR("Fail to use OpenGL es 3.0. Retrying to use OpenGL es 2.0.");
419 if ( numConfigs != 1 )
421 DALI_LOG_ERROR("No configurations found.\n");
423 TEST_EGL_ERROR("eglChooseConfig");
426 EGLint error = eglGetError();
429 case EGL_BAD_DISPLAY:
431 DALI_LOG_ERROR("Display is not an EGL display connection\n");
434 case EGL_BAD_ATTRIBUTE:
436 DALI_LOG_ERROR("The parameter configAttribs contains an invalid frame buffer configuration attribute or an attribute value that is unrecognized or out of range\n");
439 case EGL_NOT_INITIALIZED:
441 DALI_LOG_ERROR("Display has not been initialized\n");
444 case EGL_BAD_PARAMETER:
446 DALI_LOG_ERROR("The parameter numConfig is NULL\n");
451 DALI_LOG_ERROR("Unknown error.\n");
454 DALI_ASSERT_ALWAYS(false && "eglChooseConfig failed!");
457 Integration::Log::LogMessage(Integration::Log::DebugInfo, "Using OpenGL es %d.%d.\n", mGlesVersion / 10, mGlesVersion % 10 );
459 mContextAttribs.Clear();
460 if( mGlesVersion >= 30 )
462 mContextAttribs.Reserve(5);
463 mContextAttribs.PushBack( EGL_CONTEXT_MAJOR_VERSION_KHR );
464 mContextAttribs.PushBack( mGlesVersion / 10 );
465 mContextAttribs.PushBack( EGL_CONTEXT_MINOR_VERSION_KHR );
466 mContextAttribs.PushBack( mGlesVersion % 10 );
470 mContextAttribs.Reserve(3);
471 mContextAttribs.PushBack( EGL_CONTEXT_CLIENT_VERSION );
472 mContextAttribs.PushBack( 2 );
474 mContextAttribs.PushBack( EGL_NONE );
479 EGLSurface EglImplementation::CreateSurfaceWindow( EGLNativeWindowType window, ColorDepth depth )
481 mEglNativeWindow = window;
486 ChooseConfig(mIsWindow, mColorDepth);
488 mCurrentEglSurface = eglCreateWindowSurface( mEglDisplay, mEglConfig, mEglNativeWindow, NULL );
489 TEST_EGL_ERROR("eglCreateWindowSurface");
491 DALI_ASSERT_ALWAYS( mCurrentEglSurface && "Create window surface failed" );
493 return mCurrentEglSurface;
496 EGLSurface EglImplementation::CreateSurfacePixmap( EGLNativePixmapType pixmap, ColorDepth depth )
498 mCurrentEglNativePixmap = pixmap;
503 ChooseConfig(mIsWindow, mColorDepth);
505 mCurrentEglSurface = eglCreatePixmapSurface( mEglDisplay, mEglConfig, mCurrentEglNativePixmap, NULL );
506 TEST_EGL_ERROR("eglCreatePixmapSurface");
508 DALI_ASSERT_ALWAYS( mCurrentEglSurface && "Create pixmap surface failed" );
510 return mCurrentEglSurface;
513 bool EglImplementation::ReplaceSurfaceWindow( EGLNativeWindowType window, EGLSurface& eglSurface, EGLContext& eglContext )
515 bool contextLost = false;
517 // display connection has not changed, then we can just create a new surface
518 // the surface is bound to the context, so set the context to null
521 // destroy the surface
522 DestroySurface( eglSurface );
524 // create the EGL surface
525 EGLSurface newEglSurface = CreateSurfaceWindow( window, mColorDepth );
527 // set the context to be current with the new surface
528 MakeContextCurrent( newEglSurface, eglContext );
533 bool EglImplementation::ReplaceSurfacePixmap( EGLNativePixmapType pixmap, EGLSurface& eglSurface )
535 bool contextLost = false;
537 // display connection has not changed, then we can just create a new surface
538 // create the EGL surface
539 eglSurface = CreateSurfacePixmap( pixmap, mColorDepth );
541 // set the eglSurface to be current
542 MakeCurrent( pixmap, eglSurface );
547 void EglImplementation::SetGlesVersion( const int32_t glesVersion )
549 mGlesVersion = glesVersion;
552 EGLDisplay EglImplementation::GetDisplay() const
557 EGLContext EglImplementation::GetContext() const
562 int32_t EglImplementation::GetGlesVersion() const
567 bool EglImplementation::IsSurfacelessContextSupported() const
569 return mIsSurfacelessContextSupported;
572 } // namespace Adaptor
574 } // namespace Internal
578 #pragma GCC diagnostic pop