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 uint32_t CHECK_EXTENSION_NUMBER = 2;
39 const std::string EGL_KHR_SURFACELESS_CONTEXT = "EGL_KHR_surfaceless_context";
40 const std::string EGL_KHR_CREATE_CONTEXT = "EGL_KHR_create_context";
52 #define TEST_EGL_ERROR(lastCommand) \
54 EGLint err = eglGetError(); \
55 if (err != EGL_SUCCESS) \
57 DALI_LOG_ERROR("EGL error after %s\n", lastCommand); \
58 Egl::PrintError(err); \
59 DALI_ASSERT_ALWAYS(0 && "EGL error"); \
63 EglImplementation::EglImplementation( int multiSamplingLevel,
64 Integration::DepthBufferAvailable depthBufferRequired,
65 Integration::StencilBufferAvailable stencilBufferRequired )
67 mEglNativeDisplay( 0 ),
68 mEglNativeWindow( 0 ),
69 mCurrentEglNativePixmap( 0 ),
73 mCurrentEglSurface( 0 ),
74 mCurrentEglContext( EGL_NO_CONTEXT ),
75 mMultiSamplingLevel( multiSamplingLevel ),
77 mColorDepth( COLOR_DEPTH_24 ),
78 mGlesInitialized( false ),
79 mIsOwnSurface( true ),
81 mDepthBufferRequired( depthBufferRequired == Integration::DepthBufferAvailable::TRUE ),
82 mStencilBufferRequired( stencilBufferRequired == Integration::StencilBufferAvailable::TRUE ),
83 mIsSurfacelessContextSupported( false ),
84 mIsKhrCreateContextSupported( false )
88 EglImplementation::~EglImplementation()
93 bool EglImplementation::InitializeGles( EGLNativeDisplayType display, bool isOwnSurface )
95 if ( !mGlesInitialized )
97 mEglNativeDisplay = display;
99 //@todo see if we can just EGL_DEFAULT_DISPLAY instead
100 mEglDisplay = eglGetDisplay(mEglNativeDisplay);
101 EGLint error = eglGetError();
103 if( mEglDisplay == NULL && error != EGL_SUCCESS )
105 throw Dali::DaliException( "", "OpenGL ES is not supported");
108 EGLint majorVersion = 0;
109 EGLint minorVersion = 0;
110 if ( !eglInitialize( mEglDisplay, &majorVersion, &minorVersion ) )
114 eglBindAPI(EGL_OPENGL_ES_API);
116 mGlesInitialized = true;
117 mIsOwnSurface = isOwnSurface;
120 // Query EGL extensions to check whether surfaceless context is supported
121 const char* const extensionStr = eglQueryString( mEglDisplay, EGL_EXTENSIONS );
122 std::istringstream stream( extensionStr );
123 std::string currentExtension;
124 uint32_t extensionCheckCount = 0;
125 while( std::getline( stream, currentExtension, ' ' ) && extensionCheckCount < CHECK_EXTENSION_NUMBER )
127 if( currentExtension == EGL_KHR_SURFACELESS_CONTEXT )
129 mIsSurfacelessContextSupported = true;
130 extensionCheckCount++;
132 if( currentExtension == EGL_KHR_CREATE_CONTEXT )
134 mIsKhrCreateContextSupported = true;
135 extensionCheckCount++;
139 // We want to display this information all the time, so use the LogMessage directly
140 Integration::Log::LogMessage(Integration::Log::DebugInfo, "EGL Information\n"
145 eglQueryString( mEglDisplay, EGL_VENDOR ),
146 eglQueryString( mEglDisplay, EGL_VERSION ),
147 eglQueryString( mEglDisplay, EGL_CLIENT_APIS ),
150 return mGlesInitialized;
153 bool EglImplementation::CreateContext()
155 // make sure a context isn't created twice
156 DALI_ASSERT_ALWAYS( (mEglContext == 0) && "EGL context recreated" );
158 mEglContext = eglCreateContext(mEglDisplay, mEglConfig, NULL, &(mContextAttribs[0]));
159 TEST_EGL_ERROR("eglCreateContext render thread");
161 DALI_ASSERT_ALWAYS( EGL_NO_CONTEXT != mEglContext && "EGL context not created" );
163 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VENDOR : %s ***\n", glGetString(GL_VENDOR));
164 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_RENDERER : %s ***\n", glGetString(GL_RENDERER));
165 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VERSION : %s ***\n", glGetString(GL_VERSION));
166 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_SHADING_LANGUAGE_VERSION : %s***\n", glGetString(GL_SHADING_LANGUAGE_VERSION));
167 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** Supported Extensions ***\n%s\n\n", glGetString(GL_EXTENSIONS));
172 bool EglImplementation::CreateWindowContext( EGLContext& eglContext )
174 // make sure a context isn't created twice
175 DALI_ASSERT_ALWAYS( (eglContext == 0) && "EGL context recreated" );
177 eglContext = eglCreateContext(mEglDisplay, mEglConfig, mEglContext, &(mContextAttribs[0]));
178 TEST_EGL_ERROR("eglCreateContext render thread");
180 DALI_ASSERT_ALWAYS( EGL_NO_CONTEXT != eglContext && "EGL context not created" );
182 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VENDOR : %s ***\n", glGetString(GL_VENDOR));
183 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_RENDERER : %s ***\n", glGetString(GL_RENDERER));
184 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_VERSION : %s ***\n", glGetString(GL_VERSION));
185 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_SHADING_LANGUAGE_VERSION : %s***\n", glGetString(GL_SHADING_LANGUAGE_VERSION));
186 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** Supported Extensions ***\n%s\n\n", glGetString(GL_EXTENSIONS));
188 mEglWindowContexts.push_back( eglContext );
193 void EglImplementation::DestroyContext( EGLContext& eglContext )
195 DALI_ASSERT_ALWAYS( mEglContext && "no EGL context" );
197 eglDestroyContext( mEglDisplay, eglContext );
201 void EglImplementation::DestroySurface( EGLSurface& eglSurface )
203 if(mIsOwnSurface && eglSurface)
205 // Make context null to prevent crash in driver side
207 eglDestroySurface( mEglDisplay, eglSurface );
212 void EglImplementation::MakeContextCurrent( EGLSurface eglSurface, EGLContext eglContext )
214 if (mCurrentEglContext == eglContext)
219 mCurrentEglSurface = eglSurface;
223 eglMakeCurrent( mEglDisplay, eglSurface, eglSurface, eglContext );
225 mCurrentEglContext = eglContext;
228 EGLint error = eglGetError();
230 if ( error != EGL_SUCCESS )
232 Egl::PrintError(error);
234 DALI_ASSERT_ALWAYS(false && "MakeContextCurrent failed!");
238 void EglImplementation::MakeCurrent( EGLNativePixmapType pixmap, EGLSurface eglSurface )
240 if (mCurrentEglContext == mEglContext)
245 mCurrentEglNativePixmap = pixmap;
246 mCurrentEglSurface = eglSurface;
250 eglMakeCurrent( mEglDisplay, eglSurface, eglSurface, mEglContext );
252 mCurrentEglContext = mEglContext;
255 EGLint error = eglGetError();
257 if ( error != EGL_SUCCESS )
259 Egl::PrintError(error);
261 DALI_ASSERT_ALWAYS(false && "MakeCurrent failed!");
265 void EglImplementation::MakeContextNull()
267 // clear the current context
268 eglMakeCurrent( mEglDisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT );
269 mCurrentEglContext = EGL_NO_CONTEXT;
272 void EglImplementation::TerminateGles()
274 if ( mGlesInitialized )
276 // Make context null to prevent crash in driver side
279 for ( auto eglSurface : mEglWindowSurfaces )
281 if(mIsOwnSurface && eglSurface)
283 eglDestroySurface(mEglDisplay, eglSurface);
286 eglDestroyContext(mEglDisplay, mEglContext);
287 for ( auto eglContext : mEglWindowContexts )
289 eglDestroyContext(mEglDisplay, eglContext);
292 eglTerminate(mEglDisplay);
297 mCurrentEglSurface = NULL;
298 mCurrentEglContext = EGL_NO_CONTEXT;
300 mGlesInitialized = false;
304 bool EglImplementation::IsGlesInitialized() const
306 return mGlesInitialized;
309 void EglImplementation::SwapBuffers( EGLSurface& eglSurface )
311 if ( eglSurface != EGL_NO_SURFACE ) // skip if using surfaceless context
313 eglSwapBuffers( mEglDisplay, eglSurface );
317 void EglImplementation::CopyBuffers( EGLSurface& eglSurface )
319 eglCopyBuffers( mEglDisplay, eglSurface, mCurrentEglNativePixmap );
322 void EglImplementation::WaitGL()
327 bool EglImplementation::ChooseConfig( bool isWindowType, ColorDepth depth )
329 if(mEglConfig && isWindowType == mIsWindow && mColorDepth == depth)
335 mIsWindow = isWindowType;
338 Vector<EGLint> configAttribs;
339 configAttribs.Reserve(31);
343 configAttribs.PushBack( EGL_SURFACE_TYPE );
344 configAttribs.PushBack( EGL_WINDOW_BIT );
348 configAttribs.PushBack( EGL_SURFACE_TYPE );
349 configAttribs.PushBack( EGL_PIXMAP_BIT );
352 configAttribs.PushBack( EGL_RENDERABLE_TYPE );
354 if( mGlesVersion >= 30 )
356 configAttribs.PushBack( EGL_OPENGL_ES3_BIT_KHR );
360 configAttribs.PushBack( EGL_OPENGL_ES2_BIT );
363 // TODO: enable this flag when it becomes supported
364 // configAttribs.PushBack( EGL_CONTEXT_FLAGS_KHR );
365 // configAttribs.PushBack( EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE_BIT_KHR );
367 configAttribs.PushBack( EGL_RED_SIZE );
368 configAttribs.PushBack( 8 );
369 configAttribs.PushBack( EGL_GREEN_SIZE );
370 configAttribs.PushBack( 8 );
371 configAttribs.PushBack( EGL_BLUE_SIZE );
372 configAttribs.PushBack( 8 );
374 // For underlay video playback, we also need to set the alpha value of the 24/32bit window.
375 configAttribs.PushBack( EGL_ALPHA_SIZE );
376 configAttribs.PushBack( 8 );
378 configAttribs.PushBack( EGL_DEPTH_SIZE );
379 configAttribs.PushBack( mDepthBufferRequired ? 24 : 0 );
380 configAttribs.PushBack( EGL_STENCIL_SIZE );
381 configAttribs.PushBack( mStencilBufferRequired ? 8 : 0 );
383 #ifndef DALI_PROFILE_UBUNTU
384 if( mMultiSamplingLevel != EGL_DONT_CARE )
386 configAttribs.PushBack( EGL_SAMPLES );
387 configAttribs.PushBack( mMultiSamplingLevel );
388 configAttribs.PushBack( EGL_SAMPLE_BUFFERS );
389 configAttribs.PushBack( 1 );
391 #endif // DALI_PROFILE_UBUNTU
392 configAttribs.PushBack( EGL_NONE );
394 // Ensure number of configs is set to 1 as on some drivers,
395 // eglChooseConfig succeeds but does not actually create a proper configuration.
396 if ( ( eglChooseConfig( mEglDisplay, &(configAttribs[0]), &mEglConfig, 1, &numConfigs ) != EGL_TRUE ) ||
397 ( numConfigs != 1 ) )
399 if( mGlesVersion >= 30 )
402 DALI_LOG_ERROR("Fail to use OpenGL es 3.0. Retrying to use OpenGL es 2.0.");
406 if ( numConfigs != 1 )
408 DALI_LOG_ERROR("No configurations found.\n");
410 TEST_EGL_ERROR("eglChooseConfig");
413 EGLint error = eglGetError();
416 case EGL_BAD_DISPLAY:
418 DALI_LOG_ERROR("Display is not an EGL display connection\n");
421 case EGL_BAD_ATTRIBUTE:
423 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");
426 case EGL_NOT_INITIALIZED:
428 DALI_LOG_ERROR("Display has not been initialized\n");
431 case EGL_BAD_PARAMETER:
433 DALI_LOG_ERROR("The parameter numConfig is NULL\n");
438 DALI_LOG_ERROR("Unknown error.\n");
441 DALI_ASSERT_ALWAYS(false && "eglChooseConfig failed!");
444 Integration::Log::LogMessage(Integration::Log::DebugInfo, "Using OpenGL es %d.%d.\n", mGlesVersion / 10, mGlesVersion % 10 );
446 mContextAttribs.Clear();
447 if( mIsKhrCreateContextSupported )
449 mContextAttribs.Reserve(5);
450 mContextAttribs.PushBack( EGL_CONTEXT_MAJOR_VERSION_KHR );
451 mContextAttribs.PushBack( mGlesVersion / 10 );
452 mContextAttribs.PushBack( EGL_CONTEXT_MINOR_VERSION_KHR );
453 mContextAttribs.PushBack( mGlesVersion % 10 );
457 mContextAttribs.Reserve(3);
458 mContextAttribs.PushBack( EGL_CONTEXT_CLIENT_VERSION );
459 mContextAttribs.PushBack( mGlesVersion / 10 );
461 mContextAttribs.PushBack( EGL_NONE );
466 EGLSurface EglImplementation::CreateSurfaceWindow( EGLNativeWindowType window, ColorDepth depth )
468 mEglNativeWindow = window;
473 ChooseConfig(mIsWindow, mColorDepth);
475 mCurrentEglSurface = eglCreateWindowSurface( mEglDisplay, mEglConfig, mEglNativeWindow, NULL );
476 TEST_EGL_ERROR("eglCreateWindowSurface");
478 DALI_ASSERT_ALWAYS( mCurrentEglSurface && "Create window surface failed" );
480 return mCurrentEglSurface;
483 EGLSurface EglImplementation::CreateSurfacePixmap( EGLNativePixmapType pixmap, ColorDepth depth )
485 mCurrentEglNativePixmap = pixmap;
490 ChooseConfig(mIsWindow, mColorDepth);
492 mCurrentEglSurface = eglCreatePixmapSurface( mEglDisplay, mEglConfig, mCurrentEglNativePixmap, NULL );
493 TEST_EGL_ERROR("eglCreatePixmapSurface");
495 DALI_ASSERT_ALWAYS( mCurrentEglSurface && "Create pixmap surface failed" );
497 return mCurrentEglSurface;
500 bool EglImplementation::ReplaceSurfaceWindow( EGLNativeWindowType window, EGLSurface& eglSurface, EGLContext& eglContext )
502 bool contextLost = false;
504 // display connection has not changed, then we can just create a new surface
505 // the surface is bound to the context, so set the context to null
508 // destroy the surface
509 DestroySurface( eglSurface );
511 // create the EGL surface
512 EGLSurface newEglSurface = CreateSurfaceWindow( window, mColorDepth );
514 // set the context to be current with the new surface
515 MakeContextCurrent( newEglSurface, eglContext );
520 bool EglImplementation::ReplaceSurfacePixmap( EGLNativePixmapType pixmap, EGLSurface& eglSurface )
522 bool contextLost = false;
524 // display connection has not changed, then we can just create a new surface
525 // create the EGL surface
526 eglSurface = CreateSurfacePixmap( pixmap, mColorDepth );
528 // set the eglSurface to be current
529 MakeCurrent( pixmap, eglSurface );
534 void EglImplementation::SetGlesVersion( const int32_t glesVersion )
536 mGlesVersion = glesVersion;
539 EGLDisplay EglImplementation::GetDisplay() const
544 EGLContext EglImplementation::GetContext() const
549 int32_t EglImplementation::GetGlesVersion() const
554 bool EglImplementation::IsSurfacelessContextSupported() const
556 return mIsSurfacelessContextSupported;
559 void EglImplementation::WaitClient()
561 // Wait for EGL to finish executing all rendering calls for the current context
562 if ( eglWaitClient() != EGL_TRUE )
564 TEST_EGL_ERROR("eglWaitClient");
568 } // namespace Adaptor
570 } // namespace Internal
574 #pragma GCC diagnostic pop