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 {
 110 }
 111
 112 Context::~Context()
 113 {
 114   // release the cached programs
 115   std::for_each(mProgramCache.begin(), mProgramCache.end(), deletePrograms);
 116   mProgramCache.clear();
 117 }
 118
 119 void Context::GlContextCreated()
 120 {
 121   DALI_ASSERT_DEBUG(!mGlContextCreated);
 122
 123   mGlContextCreated = true;
 124
 125   // Set the initial GL state, and check it.
 126   ResetGlState();
 127
 128   const ProgramContainer::iterator endp = mProgramCache.end();
 129   for ( ProgramContainer::iterator itp = mProgramCache.begin(); itp != endp; ++itp )
 130   {
 131     (*itp).second->GlContextCreated();
 132   }
 133 }
 134
 135 void Context::GlContextDestroyed()
 136 {
 137   const ProgramContainer::iterator endp = mProgramCache.end();
 138   for ( ProgramContainer::iterator itp = mProgramCache.begin(); itp != endp; ++itp )
 139   {
 140     (*itp).second->GlContextDestroyed();
 141   }
 142
 143   mGlContextCreated = false;
 144 }
 145
 146 const char* Context::ErrorToString( GLenum errorCode )
 147 {
 148   for( unsigned int i = 0; i < sizeof(errors) / sizeof(errors[0]); ++i)
 149   {
 150     if (errorCode == errors[i].errorCode)
 151     {
 152       return errors[i].errorString;
 153     }
 154   }
 155   return "Unknown Open GLES error";
 156 }
 157
 158 Program* Context::GetCachedProgram( std::size_t hash ) const
 159 {
 160   std::map< std::size_t, Program* >::const_iterator iter = mProgramCache.find(hash);
 161
 162   if (iter != mProgramCache.end())
 163   {
 164      return iter->second;
 165   }
 166   return NULL;
 167 }
 168
 169 void Context::CacheProgram( std::size_t hash, Program* pointer )
 170 {
 171   mProgramCache[ hash ] = pointer;
 172 }
 173
 174 const Rect< int >& Context::GetViewport()
 175 {
 176   return mViewPort;
 177 }
 178
 179 void Context::FlushVertexAttributeLocations()
 180 {
 181   for( unsigned int i = 0; i < MAX_ATTRIBUTE_CACHE_SIZE; ++i )
 182   {
 183     // see if our cached state is different to the actual state
 184     if (mVertexAttributeCurrentState[ i ] != mVertexAttributeCachedState[ i ] )
 185     {
 186       // it's different so make the change to the driver
 187       // and update the cached state
 188       mVertexAttributeCurrentState[ i ] = mVertexAttributeCachedState[ i ];
 189
 190       if (mVertexAttributeCurrentState[ i ] )
 191       {
 192         LOG_GL("EnableVertexAttribArray %d\n", i);
 193         CHECK_GL( *this, mGlAbstraction.EnableVertexAttribArray( i ) );
 194       }
 195       else
 196       {
 197         LOG_GL("DisableVertexAttribArray %d\n", i);
 198         CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( i ) );
 199       }
 200     }
 201   }
 202
 203 }
 204
 205 void Context::SetVertexAttributeLocation(unsigned int location, bool state)
 206 {
 207
 208   if( location >= MAX_ATTRIBUTE_CACHE_SIZE )
 209   {
 210     // not cached, make the gl call through context
 211     if ( state )
 212     {
 213        LOG_GL("EnableVertexAttribArray %d\n", location);
 214        CHECK_GL( *this, mGlAbstraction.EnableVertexAttribArray( location ) );
 215     }
 216     else
 217     {
 218       LOG_GL("DisableVertexAttribArray %d\n", location);
 219       CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( location ) );
 220     }
 221   }
 222   else
 223   {
 224     // set the cached state, it will be set at the next draw call
 225     // if it's different from the current driver state
 226     mVertexAttributeCachedState[ location ] = state;
 227   }
 228 }
 229
 230 void Context::ResetVertexAttributeState()
 231 {
 232   // reset attribute cache
 233   for( unsigned int i=0; i < MAX_ATTRIBUTE_CACHE_SIZE; ++i )
 234   {
 235     mVertexAttributeCachedState[ i ] = false;
 236     mVertexAttributeCurrentState[ i ] = false;
 237
 238     LOG_GL("DisableVertexAttribArray %d\n", i);
 239     CHECK_GL( *this, mGlAbstraction.DisableVertexAttribArray( i ) );
 240   }
 241 }
 242
 243 void Context::ResetGlState()
 244 {
 245   DALI_ASSERT_DEBUG(mGlContextCreated);
 246
 247   mClearColorSet = false;
 248   // Render manager will call clear in next render
 249
 250   // Reset internal state and Synchronize it with real OpenGL context.
 251   // This may seem like overkill, but the GL context is not owned by dali-core,
 252   // and no assumptions should be made about the initial state.
 253   mColorMask = true;
 254   mGlAbstraction.ColorMask( true, true, true, true );
 255
 256   mStencilMask = 0xFF;
 257   mGlAbstraction.StencilMask( 0xFF );
 258
 259   mBlendEnabled = false;
 260   mGlAbstraction.Disable(GL_BLEND);
 261
 262   mDepthTestEnabled = false;
 263   mGlAbstraction.Disable(GL_DEPTH_TEST);
 264
 265   mDepthMaskEnabled = false;
 266   mGlAbstraction.DepthMask(GL_FALSE);
 267
 268   mDitherEnabled = false; // This the only GL capability which defaults to true
 269   mGlAbstraction.Disable(GL_DITHER);
 270
 271   mPolygonOffsetFillEnabled = false;
 272   mGlAbstraction.Disable(GL_POLYGON_OFFSET_FILL);
 273
 274   mSampleAlphaToCoverageEnabled = false;
 275   mGlAbstraction.Disable(GL_SAMPLE_ALPHA_TO_COVERAGE);
 276
 277   mSampleCoverageEnabled = false;
 278   mGlAbstraction.Disable(GL_SAMPLE_COVERAGE);
 279
 280   mScissorTestEnabled = false;
 281   mGlAbstraction.Disable(GL_SCISSOR_TEST);
 282
 283   mStencilTestEnabled = false;
 284   mGlAbstraction.Disable(GL_STENCIL_TEST);
 285
 286   mBoundArrayBufferId = 0;
 287   LOG_GL("BindBuffer GL_ARRAY_BUFFER 0\n");
 288   mGlAbstraction.BindBuffer(GL_ARRAY_BUFFER, mBoundArrayBufferId);
 289
 290   mBoundElementArrayBufferId = 0;
 291   LOG_GL("BindBuffer GL_ELEMENT_ARRAY_BUFFER 0\n");
 292   mGlAbstraction.BindBuffer(GL_ELEMENT_ARRAY_BUFFER, mBoundElementArrayBufferId);
 293
 294 #ifndef EMSCRIPTEN // not in WebGL
 295   mBoundTransformFeedbackBufferId = 0;
 296   LOG_GL("BindBuffer GL_TRANSFORM_FEEDBACK_BUFFER 0\n");
 297   mGlAbstraction.BindBuffer(GL_TRANSFORM_FEEDBACK_BUFFER, mBoundTransformFeedbackBufferId);
 298 #endif
 299
 300   mActiveTextureUnit = UNINITIALIZED_TEXTURE_UNIT;
 301
 302   mUsingDefaultBlendColor = true;
 303   mGlAbstraction.BlendColor( 0.0f, 0.0f, 0.0f, 0.0f );
 304
 305   mBlendFuncSeparateSrcRGB = GL_ONE;
 306   mBlendFuncSeparateDstRGB = GL_ZERO;
 307   mBlendFuncSeparateSrcAlpha = GL_ONE;
 308   mBlendFuncSeparateDstAlpha = GL_ZERO;
 309   mGlAbstraction.BlendFuncSeparate( mBlendFuncSeparateSrcRGB, mBlendFuncSeparateDstRGB,
 310                                     mBlendFuncSeparateSrcAlpha, mBlendFuncSeparateDstAlpha );
 311
 312   // initial state is GL_FUNC_ADD for both RGB and Alpha blend modes
 313   mBlendEquationSeparateModeRGB = GL_FUNC_ADD;
 314   mBlendEquationSeparateModeAlpha = GL_FUNC_ADD;
 315   mGlAbstraction.BlendEquationSeparate( mBlendEquationSeparateModeRGB, mBlendEquationSeparateModeAlpha);
 316
 317   mCullFaceMode = CullNone;
 318   mGlAbstraction.Disable(GL_CULL_FACE);
 319   mGlAbstraction.FrontFace(GL_CCW);
 320   mGlAbstraction.CullFace(GL_BACK);
 321
 322   // get max texture units
 323   mGlAbstraction.GetIntegerv(GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, &mMaxTextureUnits);
 324   DALI_ASSERT_DEBUG(mMaxTextureUnits > 7);  // according to GLES 2.0 specification
 325   mBound2dTextureId.reserve(mMaxTextureUnits);
 326   // rebind texture units
 327   for( int i=0; i < mMaxTextureUnits; ++i )
 328   {
 329     mBound2dTextureId[ i ] = 0;
 330     // set active texture
 331     mGlAbstraction.ActiveTexture( GL_TEXTURE0 + i );
 332     // bind the previous texture
 333     mGlAbstraction.BindTexture(GL_TEXTURE_2D, mBound2dTextureId[ i ] );
 334   }
 335
 336   // get maximum texture size
 337   mGlAbstraction.GetIntegerv(GL_MAX_TEXTURE_SIZE, &mMaxTextureSize);
 338
 339   GLint numProgramBinaryFormats;
 340   mGlAbstraction.GetIntegerv(GL_NUM_PROGRAM_BINARY_FORMATS_OES, &numProgramBinaryFormats);
 341   if( GL_NO_ERROR == mGlAbstraction.GetError() && 0 != numProgramBinaryFormats )
 342   {
 343     mProgramBinaryFormats.resize(numProgramBinaryFormats);
 344     mGlAbstraction.GetIntegerv(GL_PROGRAM_BINARY_FORMATS_OES, &mProgramBinaryFormats[0]);
 345   }
 346
 347   // reset viewport, this will be set to something useful when rendering
 348   mViewPort.x = mViewPort.y = mViewPort.width = mViewPort.height = 0;
 349
 350   ResetVertexAttributeState();
 351 }
 352
 353 #ifdef DALI_CONTEXT_LOGGING
 354
 355 void Context::PrintCurrentState()
 356 {
 357   DALI_LOG_INFO(SceneGraph::Context::gGlLogFilter, Debug::General,
 358                 "----------------- Context State BEGIN -----------------\n"
 359                 "Blend = %s\n"
 360                 "Cull Face = %s\n"
 361                 "Depth Test = %s\n"
 362                 "Depth Mask = %s\n"
 363                 "Dither = %s\n"
 364                 "Polygon Offset Fill = %s\n"
 365                 "Sample Alpha To Coverage = %s\n"
 366                 "Sample Coverage = %s\n"
 367                 "Scissor Test = %s\n"
 368                 "Stencil Test = %s\n"
 369                 "----------------- Context State END -----------------\n",
 370                 mBlendEnabled ? "Enabled" : "Disabled",
 371                 mDepthTestEnabled ? "Enabled" : "Disabled",
 372                 mDepthMaskEnabled ? "Enabled" : "Disabled",
 373                 mDitherEnabled ? "Enabled" : "Disabled",
 374                 mPolygonOffsetFillEnabled ? "Enabled" : "Disabled",
 375                 mSampleAlphaToCoverageEnabled ? "Enabled" : "Disabled",
 376                 mSampleCoverageEnabled ? "Enabled" : "Disabled",
 377                 mScissorTestEnabled ? "Enabled" : "Disabled",
 378                 mStencilTestEnabled ? "Enabled" : "Disabled");
 379 }
 380
 381 #endif // DALI_CONTEXT_LOGGING
 382
 383 } // namespace Internal
 384
 385 } // namespace Dali