2 * Copyright (c) 2014 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.
19 #include <dali/internal/render/gl-resources/context.h>
26 #include <dali/public-api/common/constants.h>
27 #include <dali/public-api/common/compile-time-assert.h>
28 #include <dali/internal/render/shaders/program.h>
29 #include <dali/integration-api/platform-abstraction.h>
30 #include <dali/internal/render/common/render-manager.h>
31 #include <dali/integration-api/debug.h>
39 namespace // unnamed namespace
42 DALI_COMPILE_TIME_ASSERT( TEXTURE_UNIT_LAST <= Context::MAX_TEXTURE_UNITS );
49 const GLenum errorCode;
50 const char* errorString;
52 errorStrings errors[] =
54 { GL_NO_ERROR, "GL_NO_ERROR" },
55 { GL_INVALID_ENUM, "GL_INVALID_ENUM" },
56 { GL_INVALID_VALUE, "GL_INVALID_VALUE" },
57 { GL_INVALID_OPERATION, "GL_INVALID_OPERATION" },
58 { GL_OUT_OF_MEMORY, "GL_OUT_OF_MEMORY" }
62 * Called by std::for_each from ~Context
64 void deletePrograms(std::pair< std::size_t, Program* > hashProgram)
66 DALI_ASSERT_DEBUG( hashProgram.second );
67 delete hashProgram.second;
70 } // unnamed namespace
73 Debug::Filter* Context::gGlLogFilter = Debug::Filter::New(Debug::Concise, false, "LOG_CONTEXT");
74 Debug::Filter* gContextLogFilter = Debug::Filter::New(Debug::Concise, false, "LOG_CONTEXT_META");
77 Context::Context(Integration::GlAbstraction& glAbstraction)
78 : mGlAbstraction(glAbstraction),
79 mGlContextCreated(false),
83 mDepthTestEnabled(false),
84 mDepthMaskEnabled(false),
85 mDitherEnabled(true), // This the only GL capability which defaults to true
86 mPolygonOffsetFillEnabled(false),
87 mSampleAlphaToCoverageEnabled(false),
88 mSampleCoverageEnabled(false),
89 mScissorTestEnabled(false),
90 mStencilTestEnabled(false),
91 mClearColorSet(false),
92 mBoundArrayBufferId(0),
93 mBoundElementArrayBufferId(0),
94 mBoundTransformFeedbackBufferId(0),
95 mActiveTextureUnit( TEXTURE_UNIT_LAST ),
96 mUsingDefaultBlendColor(true),
97 mBlendFuncSeparateSrcRGB(GL_ONE),
98 mBlendFuncSeparateDstRGB(GL_ZERO),
99 mBlendFuncSeparateSrcAlpha(GL_ONE),
100 mBlendFuncSeparateDstAlpha(GL_ZERO),
101 mBlendEquationSeparateModeRGB( GL_FUNC_ADD ),
102 mBlendEquationSeparateModeAlpha( GL_FUNC_ADD ),
104 mClearColor(Color::WHITE), // initial color, never used until it's been set by the user
105 mCullFaceMode(CullNone),
106 mViewPort( 0, 0, 0, 0 ),
107 mCurrentProgram( NULL ),
116 // release the cached programs
117 std::for_each(mProgramCache.begin(), mProgramCache.end(), deletePrograms);
118 mProgramCache.clear();
121 void Context::GlContextCreated()
123 DALI_LOG_INFO(gContextLogFilter, Debug::Verbose, "Context::GlContextCreated()\n");
125 DALI_ASSERT_DEBUG(!mGlContextCreated);
127 mGlContextCreated = true;
129 // Set the initial GL state, and check it.
132 // Programs now load on demand
135 void Context::GlContextDestroyed()
137 DALI_LOG_INFO(gContextLogFilter, Debug::Verbose, "Context::GlContextDestroyed()\n");
138 SetCurrentProgram( NULL );
139 // Inform programs they are no longer valid
140 const ProgramContainer::iterator endp = mProgramCache.end();
141 for ( ProgramContainer::iterator itp = mProgramCache.begin(); itp != endp; ++itp )
143 (*itp).second->GlContextDestroyed();
146 mGlContextCreated = false;
149 const char* Context::ErrorToString( GLenum errorCode )
151 for( unsigned int i = 0; i < sizeof(errors) / sizeof(errors[0]); ++i)
153 if (errorCode == errors[i].errorCode)
155 return errors[i].errorString;
158 return "Unknown Open GLES error";
161 void Context::ResetProgramMatrices()
163 const ProgramContainer::iterator endp = mProgramCache.end();
164 for ( ProgramContainer::iterator itp = mProgramCache.begin(); itp != endp; ++itp )
166 (*itp).second->SetProjectionMatrix( NULL );
167 (*itp).second->SetViewMatrix( NULL );
171 Program* Context::GetCachedProgram( std::size_t hash ) const
173 std::map< std::size_t, Program* >::const_iterator iter = mProgramCache.find(hash);
175 if (iter != mProgramCache.end())
182 void Context::CacheProgram( std::size_t hash, Program* pointer )
184 mProgramCache[ hash ] = pointer;
187 const Rect< int >& Context::GetViewport()
192 void Context::FlushVertexAttributeLocations()
194 for( unsigned int i = 0; i < MAX_ATTRIBUTE_CACHE_SIZE; ++i )
196 // see if our cached state is different to the actual state
197 if (mVertexAttributeCurrentState[ i ] != mVertexAttributeCachedState[ i ] )
199 // it's different so make the change to the driver
200 // and update the cached state
201 mVertexAttributeCurrentState[ i ] = mVertexAttributeCachedState[ i ];
203 if (mVertexAttributeCurrentState[ i ] )
205 LOG_GL("EnableVertexAttribArray %d\n", i);
206 CHECK_GL( *this, mGlAbstraction.EnableVertexAttribArray( i ) );
210 LOG_GL("DisableVertexAttribArray %d\n", i);
211 CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( i ) );
218 void Context::SetVertexAttributeLocation(unsigned int location, bool state)
221 if( location >= MAX_ATTRIBUTE_CACHE_SIZE )
223 // not cached, make the gl call through context
226 LOG_GL("EnableVertexAttribArray %d\n", location);
227 CHECK_GL( *this, mGlAbstraction.EnableVertexAttribArray( location ) );
231 LOG_GL("DisableVertexAttribArray %d\n", location);
232 CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( location ) );
237 // set the cached state, it will be set at the next draw call
238 // if it's different from the current driver state
239 mVertexAttributeCachedState[ location ] = state;
243 void Context::ResetVertexAttributeState()
245 // reset attribute cache
246 for( unsigned int i=0; i < MAX_ATTRIBUTE_CACHE_SIZE; ++i )
248 mVertexAttributeCachedState[ i ] = false;
249 mVertexAttributeCurrentState[ i ] = false;
251 LOG_GL("DisableVertexAttribArray %d\n", i);
252 CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( i ) );
256 void Context::ResetGlState()
258 DALI_LOG_INFO(gContextLogFilter, Debug::Verbose, "Context::ResetGlState()\n");
259 DALI_ASSERT_DEBUG(mGlContextCreated);
261 mClearColorSet = false;
262 // Render manager will call clear in next render
264 // Reset internal state and Synchronize it with real OpenGL context.
265 // This may seem like overkill, but the GL context is not owned by dali-core,
266 // and no assumptions should be made about the initial state.
268 mGlAbstraction.ColorMask( true, true, true, true );
271 mGlAbstraction.StencilMask( 0xFF );
273 mBlendEnabled = false;
274 mGlAbstraction.Disable(GL_BLEND);
276 mDepthTestEnabled = false;
277 mGlAbstraction.Disable(GL_DEPTH_TEST);
279 mDepthMaskEnabled = false;
280 mGlAbstraction.DepthMask(GL_FALSE);
282 mDitherEnabled = false; // This the only GL capability which defaults to true
283 mGlAbstraction.Disable(GL_DITHER);
285 mPolygonOffsetFillEnabled = false;
286 mGlAbstraction.Disable(GL_POLYGON_OFFSET_FILL);
288 mSampleAlphaToCoverageEnabled = false;
289 mGlAbstraction.Disable(GL_SAMPLE_ALPHA_TO_COVERAGE);
291 mSampleCoverageEnabled = false;
292 mGlAbstraction.Disable(GL_SAMPLE_COVERAGE);
294 mScissorTestEnabled = false;
295 mGlAbstraction.Disable(GL_SCISSOR_TEST);
297 mStencilTestEnabled = false;
298 mGlAbstraction.Disable(GL_STENCIL_TEST);
300 mBoundArrayBufferId = 0;
301 LOG_GL("BindBuffer GL_ARRAY_BUFFER 0\n");
302 mGlAbstraction.BindBuffer(GL_ARRAY_BUFFER, mBoundArrayBufferId);
304 mBoundElementArrayBufferId = 0;
305 LOG_GL("BindBuffer GL_ELEMENT_ARRAY_BUFFER 0\n");
306 mGlAbstraction.BindBuffer(GL_ELEMENT_ARRAY_BUFFER, mBoundElementArrayBufferId);
308 #ifndef EMSCRIPTEN // not in WebGL
309 mBoundTransformFeedbackBufferId = 0;
310 LOG_GL("BindBuffer GL_TRANSFORM_FEEDBACK_BUFFER 0\n");
311 mGlAbstraction.BindBuffer(GL_TRANSFORM_FEEDBACK_BUFFER, mBoundTransformFeedbackBufferId);
314 mActiveTextureUnit = TEXTURE_UNIT_LAST;
316 mUsingDefaultBlendColor = true;
317 mGlAbstraction.BlendColor( 0.0f, 0.0f, 0.0f, 0.0f );
319 mBlendFuncSeparateSrcRGB = GL_ONE;
320 mBlendFuncSeparateDstRGB = GL_ZERO;
321 mBlendFuncSeparateSrcAlpha = GL_ONE;
322 mBlendFuncSeparateDstAlpha = GL_ZERO;
323 mGlAbstraction.BlendFuncSeparate( mBlendFuncSeparateSrcRGB, mBlendFuncSeparateDstRGB,
324 mBlendFuncSeparateSrcAlpha, mBlendFuncSeparateDstAlpha );
326 // initial state is GL_FUNC_ADD for both RGB and Alpha blend modes
327 mBlendEquationSeparateModeRGB = GL_FUNC_ADD;
328 mBlendEquationSeparateModeAlpha = GL_FUNC_ADD;
329 mGlAbstraction.BlendEquationSeparate( mBlendEquationSeparateModeRGB, mBlendEquationSeparateModeAlpha);
331 mCullFaceMode = CullNone;
332 mGlAbstraction.Disable(GL_CULL_FACE);
333 mGlAbstraction.FrontFace(GL_CCW);
334 mGlAbstraction.CullFace(GL_BACK);
336 // rebind texture units to 0
337 for( unsigned int i=0; i < MAX_TEXTURE_UNITS; ++i )
339 mBound2dTextureId[ i ] = 0;
340 // set active texture
341 mGlAbstraction.ActiveTexture( GL_TEXTURE0 + i );
342 mGlAbstraction.BindTexture(GL_TEXTURE_2D, mBound2dTextureId[ i ] );
345 // get maximum texture size
346 mGlAbstraction.GetIntegerv(GL_MAX_TEXTURE_SIZE, &mMaxTextureSize);
348 GLint numProgramBinaryFormats;
349 mGlAbstraction.GetIntegerv(GL_NUM_PROGRAM_BINARY_FORMATS_OES, &numProgramBinaryFormats);
350 if( GL_NO_ERROR == mGlAbstraction.GetError() && 0 != numProgramBinaryFormats )
352 mProgramBinaryFormats.Resize(numProgramBinaryFormats);
353 mGlAbstraction.GetIntegerv(GL_PROGRAM_BINARY_FORMATS_OES, &mProgramBinaryFormats[0]);
356 // reset viewport, this will be set to something useful when rendering
357 mViewPort.x = mViewPort.y = mViewPort.width = mViewPort.height = 0;
359 ResetVertexAttributeState();
362 #ifdef DALI_CONTEXT_LOGGING
364 void Context::PrintCurrentState()
366 DALI_LOG_INFO(SceneGraph::Context::gGlLogFilter, Debug::General,
367 "----------------- Context State BEGIN -----------------\n"
373 "Polygon Offset Fill = %s\n"
374 "Sample Alpha To Coverage = %s\n"
375 "Sample Coverage = %s\n"
376 "Scissor Test = %s\n"
377 "Stencil Test = %s\n"
378 "----------------- Context State END -----------------\n",
379 mBlendEnabled ? "Enabled" : "Disabled",
380 mDepthTestEnabled ? "Enabled" : "Disabled",
381 mDepthMaskEnabled ? "Enabled" : "Disabled",
382 mDitherEnabled ? "Enabled" : "Disabled",
383 mPolygonOffsetFillEnabled ? "Enabled" : "Disabled",
384 mSampleAlphaToCoverageEnabled ? "Enabled" : "Disabled",
385 mSampleCoverageEnabled ? "Enabled" : "Disabled",
386 mScissorTestEnabled ? "Enabled" : "Disabled",
387 mStencilTestEnabled ? "Enabled" : "Disabled");
390 #endif // DALI_CONTEXT_LOGGING
392 } // namespace Internal