dali/internal/render/gl-resources/context.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   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  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/render/gl-resources/context.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <algorithm>
  23 #include <limits>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/common/constants.h>
  27 #include <dali/internal/render/shaders/program.h>
  28 #include <dali/integration-api/platform-abstraction.h>
  29 #include <dali/internal/render/common/render-manager.h>
  30 #include <dali/integration-api/debug.h>
  31
  32 using namespace std;
  33
  34 namespace Dali
  35 {
  36
  37 namespace Internal
  38 {
  39
  40 namespace // unnamed namespace
  41 {
  42
  43 /**
  44  * GL error strings
  45  */
  46 struct errorStrings
  47 {
  48   const GLenum errorCode;
  49   const char* errorString;
  50 };
  51 errorStrings errors[] =
  52 {
  53    { GL_NO_ERROR,           "GL_NO_ERROR" },
  54    { GL_INVALID_ENUM,       "GL_INVALID_ENUM" },
  55    { GL_INVALID_VALUE,      "GL_INVALID_VALUE" },
  56    { GL_INVALID_OPERATION,  "GL_INVALID_OPERATION" },
  57    { GL_OUT_OF_MEMORY,      "GL_OUT_OF_MEMORY" }
  58 };
  59
  60 /*
  61  * Called by std::for_each from ~Context
  62  */
  63 void deletePrograms(std::pair< std::size_t, Program* > hashProgram)
  64 {
  65   DALI_ASSERT_DEBUG( hashProgram.second );
  66   delete hashProgram.second;
  67 }
  68
  69 const unsigned int UNINITIALIZED_TEXTURE_UNIT = std::numeric_limits<unsigned int>::max();// GL_MAX_TEXTURE_UNITS can't be used because it's depreciated in gles2
  70
  71 } // unnamed namespace
  72
  73 #ifdef DEBUG_ENABLED
  74 Debug::Filter* Context::gGlLogFilter = Debug::Filter::New(Debug::Concise, false, "LOG_CONTEXT");
  75 #endif
  76
  77 Context::Context(Integration::GlAbstraction& glAbstraction)
  78 : mGlAbstraction(glAbstraction),
  79   mGlContextCreated(false),
  80   mColorMask(true),
  81   mStencilMask(0xFF),
  82   mBlendEnabled(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( UNINITIALIZED_TEXTURE_UNIT ),
  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 ),
 103   mMaxTextureSize(0),
 104   mMaxTextureUnits(0),
 105   mClearColor(Color::WHITE),    // initial color, never used until it's been set by the user
 106   mCullFaceMode(CullNone),
 107   mViewPort( 0, 0, 0, 0 ),
 108   mCurrentProgram( NULL ),
 109   mFrameCount( 0 ),
 110   mCulledCount( 0 ),
 111   mRendererCount( 0 )
 112 {
 113 }
 114
 115 Context::~Context()
 116 {
 117   // release the cached programs
 118   std::for_each(mProgramCache.begin(), mProgramCache.end(), deletePrograms);
 119   mProgramCache.clear();
 120 }
 121
 122 void Context::GlContextCreated()
 123 {
 124   DALI_ASSERT_DEBUG(!mGlContextCreated);
 125
 126   mGlContextCreated = true;
 127
 128   // Set the initial GL state, and check it.
 129   ResetGlState();
 130
 131   const ProgramContainer::iterator endp = mProgramCache.end();
 132   for ( ProgramContainer::iterator itp = mProgramCache.begin(); itp != endp; ++itp )
 133   {
 134     (*itp).second->GlContextCreated();
 135   }
 136 }
 137
 138 void Context::GlContextDestroyed()
 139 {
 140   const ProgramContainer::iterator endp = mProgramCache.end();
 141   for ( ProgramContainer::iterator itp = mProgramCache.begin(); itp != endp; ++itp )
 142   {
 143     (*itp).second->GlContextDestroyed();
 144   }
 145
 146   mGlContextCreated = false;
 147 }
 148
 149 const char* Context::ErrorToString( GLenum errorCode )
 150 {
 151   for( unsigned int i = 0; i < sizeof(errors) / sizeof(errors[0]); ++i)
 152   {
 153     if (errorCode == errors[i].errorCode)
 154     {
 155       return errors[i].errorString;
 156     }
 157   }
 158   return "Unknown Open GLES error";
 159 }
 160
 161 void Context::ResetProgramMatrices()
 162 {
 163   const ProgramContainer::iterator endp = mProgramCache.end();
 164   for ( ProgramContainer::iterator itp = mProgramCache.begin(); itp != endp; ++itp )
 165   {
 166     (*itp).second->SetProjectionMatrix( NULL );
 167     (*itp).second->SetViewMatrix( NULL );
 168   }
 169 }
 170
 171 Program* Context::GetCachedProgram( std::size_t hash ) const
 172 {
 173   std::map< std::size_t, Program* >::const_iterator iter = mProgramCache.find(hash);
 174
 175   if (iter != mProgramCache.end())
 176   {
 177      return iter->second;
 178   }
 179   return NULL;
 180 }
 181
 182 void Context::CacheProgram( std::size_t hash, Program* pointer )
 183 {
 184   mProgramCache[ hash ] = pointer;
 185 }
 186
 187 const Rect< int >& Context::GetViewport()
 188 {
 189   return mViewPort;
 190 }
 191
 192 void Context::FlushVertexAttributeLocations()
 193 {
 194   for( unsigned int i = 0; i < MAX_ATTRIBUTE_CACHE_SIZE; ++i )
 195   {
 196     // see if our cached state is different to the actual state
 197     if (mVertexAttributeCurrentState[ i ] != mVertexAttributeCachedState[ i ] )
 198     {
 199       // it's different so make the change to the driver
 200       // and update the cached state
 201       mVertexAttributeCurrentState[ i ] = mVertexAttributeCachedState[ i ];
 202
 203       if (mVertexAttributeCurrentState[ i ] )
 204       {
 205         LOG_GL("EnableVertexAttribArray %d\n", i);
 206         CHECK_GL( *this, mGlAbstraction.EnableVertexAttribArray( i ) );
 207       }
 208       else
 209       {
 210         LOG_GL("DisableVertexAttribArray %d\n", i);
 211         CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( i ) );
 212       }
 213     }
 214   }
 215
 216 }
 217
 218 void Context::SetVertexAttributeLocation(unsigned int location, bool state)
 219 {
 220
 221   if( location >= MAX_ATTRIBUTE_CACHE_SIZE )
 222   {
 223     // not cached, make the gl call through context
 224     if ( state )
 225     {
 226        LOG_GL("EnableVertexAttribArray %d\n", location);
 227        CHECK_GL( *this, mGlAbstraction.EnableVertexAttribArray( location ) );
 228     }
 229     else
 230     {
 231       LOG_GL("DisableVertexAttribArray %d\n", location);
 232       CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( location ) );
 233     }
 234   }
 235   else
 236   {
 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;
 240   }
 241 }
 242
 243 void Context::ResetVertexAttributeState()
 244 {
 245   // reset attribute cache
 246   for( unsigned int i=0; i < MAX_ATTRIBUTE_CACHE_SIZE; ++i )
 247   {
 248     mVertexAttributeCachedState[ i ] = false;
 249     mVertexAttributeCurrentState[ i ] = false;
 250
 251     LOG_GL("DisableVertexAttribArray %d\n", i);
 252     CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( i ) );
 253   }
 254 }
 255
 256 void Context::ResetGlState()
 257 {
 258   DALI_ASSERT_DEBUG(mGlContextCreated);
 259
 260   mClearColorSet = false;
 261   // Render manager will call clear in next render
 262
 263   // Reset internal state and Synchronize it with real OpenGL context.
 264   // This may seem like overkill, but the GL context is not owned by dali-core,
 265   // and no assumptions should be made about the initial state.
 266   mColorMask = true;
 267   mGlAbstraction.ColorMask( true, true, true, true );
 268
 269   mStencilMask = 0xFF;
 270   mGlAbstraction.StencilMask( 0xFF );
 271
 272   mBlendEnabled = false;
 273   mGlAbstraction.Disable(GL_BLEND);
 274
 275   mDepthTestEnabled = false;
 276   mGlAbstraction.Disable(GL_DEPTH_TEST);
 277
 278   mDepthMaskEnabled = false;
 279   mGlAbstraction.DepthMask(GL_FALSE);
 280
 281   mDitherEnabled = false; // This the only GL capability which defaults to true
 282   mGlAbstraction.Disable(GL_DITHER);
 283
 284   mPolygonOffsetFillEnabled = false;
 285   mGlAbstraction.Disable(GL_POLYGON_OFFSET_FILL);
 286
 287   mSampleAlphaToCoverageEnabled = false;
 288   mGlAbstraction.Disable(GL_SAMPLE_ALPHA_TO_COVERAGE);
 289
 290   mSampleCoverageEnabled = false;
 291   mGlAbstraction.Disable(GL_SAMPLE_COVERAGE);
 292
 293   mScissorTestEnabled = false;
 294   mGlAbstraction.Disable(GL_SCISSOR_TEST);
 295
 296   mStencilTestEnabled = false;
 297   mGlAbstraction.Disable(GL_STENCIL_TEST);
 298
 299   mBoundArrayBufferId = 0;
 300   LOG_GL("BindBuffer GL_ARRAY_BUFFER 0\n");
 301   mGlAbstraction.BindBuffer(GL_ARRAY_BUFFER, mBoundArrayBufferId);
 302
 303   mBoundElementArrayBufferId = 0;
 304   LOG_GL("BindBuffer GL_ELEMENT_ARRAY_BUFFER 0\n");
 305   mGlAbstraction.BindBuffer(GL_ELEMENT_ARRAY_BUFFER, mBoundElementArrayBufferId);
 306
 307 #ifndef EMSCRIPTEN // not in WebGL
 308   mBoundTransformFeedbackBufferId = 0;
 309   LOG_GL("BindBuffer GL_TRANSFORM_FEEDBACK_BUFFER 0\n");
 310   mGlAbstraction.BindBuffer(GL_TRANSFORM_FEEDBACK_BUFFER, mBoundTransformFeedbackBufferId);
 311 #endif
 312
 313   mActiveTextureUnit = UNINITIALIZED_TEXTURE_UNIT;
 314
 315   mUsingDefaultBlendColor = true;
 316   mGlAbstraction.BlendColor( 0.0f, 0.0f, 0.0f, 0.0f );
 317
 318   mBlendFuncSeparateSrcRGB = GL_ONE;
 319   mBlendFuncSeparateDstRGB = GL_ZERO;
 320   mBlendFuncSeparateSrcAlpha = GL_ONE;
 321   mBlendFuncSeparateDstAlpha = GL_ZERO;
 322   mGlAbstraction.BlendFuncSeparate( mBlendFuncSeparateSrcRGB, mBlendFuncSeparateDstRGB,
 323                                     mBlendFuncSeparateSrcAlpha, mBlendFuncSeparateDstAlpha );
 324
 325   // initial state is GL_FUNC_ADD for both RGB and Alpha blend modes
 326   mBlendEquationSeparateModeRGB = GL_FUNC_ADD;
 327   mBlendEquationSeparateModeAlpha = GL_FUNC_ADD;
 328   mGlAbstraction.BlendEquationSeparate( mBlendEquationSeparateModeRGB, mBlendEquationSeparateModeAlpha);
 329
 330   mCullFaceMode = CullNone;
 331   mGlAbstraction.Disable(GL_CULL_FACE);
 332   mGlAbstraction.FrontFace(GL_CCW);
 333   mGlAbstraction.CullFace(GL_BACK);
 334
 335   // get max texture units
 336   mGlAbstraction.GetIntegerv(GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, &mMaxTextureUnits);
 337   DALI_ASSERT_DEBUG(mMaxTextureUnits > 7);  // according to GLES 2.0 specification
 338   mBound2dTextureId.reserve(mMaxTextureUnits);
 339   // rebind texture units
 340   for( int i=0; i < mMaxTextureUnits; ++i )
 341   {
 342     mBound2dTextureId[ i ] = 0;
 343     // set active texture
 344     mGlAbstraction.ActiveTexture( GL_TEXTURE0 + i );
 345     // bind the previous texture
 346     mGlAbstraction.BindTexture(GL_TEXTURE_2D, mBound2dTextureId[ i ] );
 347   }
 348
 349   // get maximum texture size
 350   mGlAbstraction.GetIntegerv(GL_MAX_TEXTURE_SIZE, &mMaxTextureSize);
 351
 352   GLint numProgramBinaryFormats;
 353   mGlAbstraction.GetIntegerv(GL_NUM_PROGRAM_BINARY_FORMATS_OES, &numProgramBinaryFormats);
 354   if( GL_NO_ERROR == mGlAbstraction.GetError() && 0 != numProgramBinaryFormats )
 355   {
 356     mProgramBinaryFormats.resize(numProgramBinaryFormats);
 357     mGlAbstraction.GetIntegerv(GL_PROGRAM_BINARY_FORMATS_OES, &mProgramBinaryFormats[0]);
 358   }
 359
 360   // reset viewport, this will be set to something useful when rendering
 361   mViewPort.x = mViewPort.y = mViewPort.width = mViewPort.height = 0;
 362
 363   ResetVertexAttributeState();
 364 }
 365
 366 #ifdef DALI_CONTEXT_LOGGING
 367
 368 void Context::PrintCurrentState()
 369 {
 370   DALI_LOG_INFO(SceneGraph::Context::gGlLogFilter, Debug::General,
 371                 "----------------- Context State BEGIN -----------------\n"
 372                 "Blend = %s\n"
 373                 "Cull Face = %s\n"
 374                 "Depth Test = %s\n"
 375                 "Depth Mask = %s\n"
 376                 "Dither = %s\n"
 377                 "Polygon Offset Fill = %s\n"
 378                 "Sample Alpha To Coverage = %s\n"
 379                 "Sample Coverage = %s\n"
 380                 "Scissor Test = %s\n"
 381                 "Stencil Test = %s\n"
 382                 "----------------- Context State END -----------------\n",
 383                 mBlendEnabled ? "Enabled" : "Disabled",
 384                 mDepthTestEnabled ? "Enabled" : "Disabled",
 385                 mDepthMaskEnabled ? "Enabled" : "Disabled",
 386                 mDitherEnabled ? "Enabled" : "Disabled",
 387                 mPolygonOffsetFillEnabled ? "Enabled" : "Disabled",
 388                 mSampleAlphaToCoverageEnabled ? "Enabled" : "Disabled",
 389                 mSampleCoverageEnabled ? "Enabled" : "Disabled",
 390                 mScissorTestEnabled ? "Enabled" : "Disabled",
 391                 mStencilTestEnabled ? "Enabled" : "Disabled");
 392 }
 393
 394 #endif // DALI_CONTEXT_LOGGING
 395
 396 } // namespace Internal
 397
 398 } // namespace Dali