dali/internal/render/renderers/render-renderer.cpp

   1 /*
   2  * Copyright (c) 2017 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/renderers/render-renderer.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/internal/common/image-sampler.h>
  23 #include <dali/internal/render/gl-resources/context.h>
  24 #include <dali/internal/render/renderers/render-sampler.h>
  25 #include <dali/internal/render/shaders/scene-graph-shader.h>
  26 #include <dali/internal/render/shaders/program.h>
  27 #include <dali/internal/render/data-providers/node-data-provider.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 namespace
  36 {
  37
  38 static Matrix gModelViewProjectionMatrix( false ); ///< a shared matrix to calculate the MVP matrix, dont want to store it in object to reduce storage overhead
  39 static Matrix3 gNormalMatrix; ///< a shared matrix to calculate normal matrix, dont want to store it in object to reduce storage overhead
  40
  41 /**
  42  * Helper to set view and projection matrices once per program
  43  * @param program to set the matrices to
  44  * @param modelMatrix to set
  45  * @param viewMatrix to set
  46  * @param projectionMatrix to set
  47  * @param modelViewMatrix to set
  48  * @param modelViewProjectionMatrix to set
  49  */
  50 inline void SetMatrices( Program& program,
  51                          const Matrix& modelMatrix,
  52                          const Matrix& viewMatrix,
  53                          const Matrix& projectionMatrix,
  54                          const Matrix& modelViewMatrix )
  55 {
  56   GLint loc = program.GetUniformLocation( Program::UNIFORM_MODEL_MATRIX );
  57   if( Program::UNIFORM_UNKNOWN != loc )
  58   {
  59     program.SetUniformMatrix4fv( loc, 1, modelMatrix.AsFloat() );
  60   }
  61   loc = program.GetUniformLocation( Program::UNIFORM_VIEW_MATRIX );
  62   if( Program::UNIFORM_UNKNOWN != loc )
  63   {
  64     if( program.GetViewMatrix() != &viewMatrix )
  65     {
  66       program.SetViewMatrix( &viewMatrix );
  67       program.SetUniformMatrix4fv( loc, 1, viewMatrix.AsFloat() );
  68     }
  69   }
  70   // set projection matrix if program has not yet received it this frame or if it is dirty
  71   loc = program.GetUniformLocation( Program::UNIFORM_PROJECTION_MATRIX );
  72   if( Program::UNIFORM_UNKNOWN != loc )
  73   {
  74     if( program.GetProjectionMatrix() != &projectionMatrix )
  75     {
  76       program.SetProjectionMatrix( &projectionMatrix );
  77       program.SetUniformMatrix4fv( loc, 1, projectionMatrix.AsFloat() );
  78     }
  79   }
  80   loc = program.GetUniformLocation(Program::UNIFORM_MODELVIEW_MATRIX);
  81   if( Program::UNIFORM_UNKNOWN != loc )
  82   {
  83     program.SetUniformMatrix4fv( loc, 1, modelViewMatrix.AsFloat() );
  84   }
  85
  86   loc = program.GetUniformLocation( Program::UNIFORM_MVP_MATRIX );
  87   if( Program::UNIFORM_UNKNOWN != loc )
  88   {
  89     Matrix::Multiply( gModelViewProjectionMatrix, modelViewMatrix, projectionMatrix );
  90     program.SetUniformMatrix4fv( loc, 1, gModelViewProjectionMatrix.AsFloat() );
  91   }
  92
  93   loc = program.GetUniformLocation( Program::UNIFORM_NORMAL_MATRIX );
  94   if( Program::UNIFORM_UNKNOWN != loc )
  95   {
  96     gNormalMatrix = modelViewMatrix;
  97     gNormalMatrix.Invert();
  98     gNormalMatrix.Transpose();
  99     program.SetUniformMatrix3fv( loc, 1, gNormalMatrix.AsFloat() );
 100   }
 101 }
 102
 103 }
 104
 105 namespace Render
 106 {
 107
 108 Renderer* Renderer::New( SceneGraph::RenderDataProvider* dataProvider,
 109                          Render::Geometry* geometry,
 110                          unsigned int blendingBitmask,
 111                          const Vector4& blendColor,
 112                          FaceCullingMode::Type faceCullingMode,
 113                          bool preMultipliedAlphaEnabled,
 114                          DepthWriteMode::Type depthWriteMode,
 115                          DepthTestMode::Type depthTestMode,
 116                          DepthFunction::Type depthFunction,
 117                          StencilParameters& stencilParameters )
 118 {
 119   return new Renderer( dataProvider, geometry, blendingBitmask, blendColor,
 120                        faceCullingMode, preMultipliedAlphaEnabled, depthWriteMode, depthTestMode,
 121                        depthFunction, stencilParameters );
 122 }
 123
 124 Renderer::Renderer( SceneGraph::RenderDataProvider* dataProvider,
 125                     Render::Geometry* geometry,
 126                     unsigned int blendingBitmask,
 127                     const Vector4& blendColor,
 128                     FaceCullingMode::Type faceCullingMode,
 129                     bool preMultipliedAlphaEnabled,
 130                     DepthWriteMode::Type depthWriteMode,
 131                     DepthTestMode::Type depthTestMode,
 132                     DepthFunction::Type depthFunction,
 133                     StencilParameters& stencilParameters )
 134 : mRenderDataProvider( dataProvider ),
 135   mContext( NULL),
 136   mGeometry( geometry ),
 137   mUniformIndexMap(),
 138   mAttributesLocation(),
 139   mStencilParameters( stencilParameters ),
 140   mBlendingOptions(),
 141   mIndexedDrawFirstElement( 0 ),
 142   mIndexedDrawElementsCount( 0 ),
 143   mDepthFunction( depthFunction ),
 144   mFaceCullingMode( faceCullingMode ),
 145   mDepthWriteMode( depthWriteMode ),
 146   mDepthTestMode( depthTestMode ),
 147   mUpdateAttributesLocation( true ),
 148   mPremultipledAlphaEnabled( preMultipliedAlphaEnabled )
 149 {
 150   if( blendingBitmask != 0u )
 151   {
 152     mBlendingOptions.SetBitmask( blendingBitmask );
 153   }
 154
 155   mBlendingOptions.SetBlendColor( blendColor );
 156 }
 157
 158 void Renderer::Initialize( Context& context )
 159 {
 160   mContext = &context;
 161 }
 162
 163 Renderer::~Renderer()
 164 {
 165 }
 166
 167 void Renderer::SetRenderDataProvider( SceneGraph::RenderDataProvider* dataProvider )
 168 {
 169   mRenderDataProvider = dataProvider;
 170   mUpdateAttributesLocation = true;
 171
 172   //Check that the number of textures match the number of samplers in the shader
 173   size_t textureCount =  dataProvider->GetTextures().size();
 174   Program* program = dataProvider->GetShader().GetProgram();
 175   if( program && program->GetActiveSamplerCount() != textureCount )
 176   {
 177     DALI_LOG_WARNING("The number of active samplers in the shader(%lu) does not match the number of textures in the TextureSet(%lu)\n",
 178                    program->GetActiveSamplerCount(),
 179                    textureCount );
 180   }
 181 }
 182
 183 void Renderer::SetGeometry( Render::Geometry* geometry )
 184 {
 185   mGeometry = geometry;
 186   mUpdateAttributesLocation = true;
 187 }
 188
 189 void Renderer::SetBlending( Context& context, bool blend )
 190 {
 191   context.SetBlend( blend );
 192   if( blend )
 193   {
 194     // Blend color is optional and rarely used
 195     const Vector4* blendColor = mBlendingOptions.GetBlendColor();
 196     if( blendColor )
 197     {
 198       context.SetCustomBlendColor( *blendColor );
 199     }
 200     else
 201     {
 202       context.SetDefaultBlendColor();
 203     }
 204
 205     // Set blend source & destination factors
 206     context.BlendFuncSeparate( mBlendingOptions.GetBlendSrcFactorRgb(),
 207                                mBlendingOptions.GetBlendDestFactorRgb(),
 208                                mBlendingOptions.GetBlendSrcFactorAlpha(),
 209                                mBlendingOptions.GetBlendDestFactorAlpha() );
 210
 211     // Set blend equations
 212     context.BlendEquationSeparate( mBlendingOptions.GetBlendEquationRgb(),
 213                                    mBlendingOptions.GetBlendEquationAlpha() );
 214   }
 215 }
 216
 217 void Renderer::GlContextDestroyed()
 218 {
 219   mGeometry->GlContextDestroyed();
 220 }
 221
 222 void Renderer::GlCleanup()
 223 {
 224 }
 225
 226 void Renderer::SetUniforms( BufferIndex bufferIndex, const SceneGraph::NodeDataProvider& node, const Vector3& size, Program& program )
 227 {
 228   // Check if the map has changed
 229   DALI_ASSERT_DEBUG( mRenderDataProvider && "No Uniform map data provider available" );
 230
 231   const SceneGraph::UniformMapDataProvider& uniformMapDataProvider = mRenderDataProvider->GetUniformMap();
 232
 233   if( uniformMapDataProvider.GetUniformMapChanged( bufferIndex ) ||
 234       node.GetUniformMapChanged(bufferIndex))
 235   {
 236     const SceneGraph::CollectedUniformMap& uniformMap = uniformMapDataProvider.GetUniformMap( bufferIndex );
 237     const SceneGraph::CollectedUniformMap& uniformMapNode = node.GetUniformMap( bufferIndex );
 238
 239     unsigned int maxMaps = uniformMap.Count() + uniformMapNode.Count();
 240     mUniformIndexMap.Clear(); // Clear contents, but keep memory if we don't change size
 241     mUniformIndexMap.Resize( maxMaps );
 242
 243     unsigned int mapIndex(0);
 244     for(; mapIndex < uniformMap.Count() ; ++mapIndex )
 245     {
 246       mUniformIndexMap[mapIndex].propertyValue = uniformMap[mapIndex]->propertyPtr;
 247       mUniformIndexMap[mapIndex].uniformIndex = program.RegisterUniform( uniformMap[mapIndex]->uniformName );
 248     }
 249
 250     for( unsigned int nodeMapIndex = 0; nodeMapIndex < uniformMapNode.Count() ; ++nodeMapIndex )
 251     {
 252       unsigned int uniformIndex = program.RegisterUniform( uniformMapNode[nodeMapIndex]->uniformName );
 253       bool found(false);
 254       for( unsigned int i(0); i<uniformMap.Count(); ++i )
 255       {
 256         if( mUniformIndexMap[i].uniformIndex == uniformIndex )
 257         {
 258           mUniformIndexMap[i].propertyValue = uniformMapNode[nodeMapIndex]->propertyPtr;
 259           found = true;
 260           break;
 261         }
 262       }
 263
 264       if( !found )
 265       {
 266         mUniformIndexMap[mapIndex].propertyValue = uniformMapNode[nodeMapIndex]->propertyPtr;
 267         mUniformIndexMap[mapIndex].uniformIndex = uniformIndex;
 268         ++mapIndex;
 269       }
 270     }
 271
 272     mUniformIndexMap.Resize( mapIndex );
 273   }
 274
 275   // Set uniforms in local map
 276   for( UniformIndexMappings::Iterator iter = mUniformIndexMap.Begin(),
 277          end = mUniformIndexMap.End() ;
 278        iter != end ;
 279        ++iter )
 280   {
 281     SetUniformFromProperty( bufferIndex, program, *iter );
 282   }
 283
 284   GLint sizeLoc = program.GetUniformLocation( Program::UNIFORM_SIZE );
 285   if( -1 != sizeLoc )
 286   {
 287     program.SetSizeUniform3f( sizeLoc, size.x, size.y, size.z );
 288   }
 289 }
 290
 291 void Renderer::SetUniformFromProperty( BufferIndex bufferIndex, Program& program, UniformIndexMap& map )
 292 {
 293   GLint location = program.GetUniformLocation(map.uniformIndex);
 294   if( Program::UNIFORM_UNKNOWN != location )
 295   {
 296     // switch based on property type to use correct GL uniform setter
 297     switch ( map.propertyValue->GetType() )
 298     {
 299       case Property::INTEGER:
 300       {
 301         program.SetUniform1i( location, map.propertyValue->GetInteger( bufferIndex ) );
 302         break;
 303       }
 304       case Property::FLOAT:
 305       {
 306         program.SetUniform1f( location, map.propertyValue->GetFloat( bufferIndex ) );
 307         break;
 308       }
 309       case Property::VECTOR2:
 310       {
 311         Vector2 value( map.propertyValue->GetVector2( bufferIndex ) );
 312         program.SetUniform2f( location, value.x, value.y );
 313         break;
 314       }
 315
 316       case Property::VECTOR3:
 317       {
 318         Vector3 value( map.propertyValue->GetVector3( bufferIndex ) );
 319         program.SetUniform3f( location, value.x, value.y, value.z );
 320         break;
 321       }
 322
 323       case Property::VECTOR4:
 324       {
 325         Vector4 value( map.propertyValue->GetVector4( bufferIndex ) );
 326         program.SetUniform4f( location, value.x, value.y, value.z, value.w );
 327         break;
 328       }
 329
 330       case Property::ROTATION:
 331       {
 332         Quaternion value( map.propertyValue->GetQuaternion( bufferIndex ) );
 333         program.SetUniform4f( location, value.mVector.x, value.mVector.y, value.mVector.z, value.mVector.w );
 334         break;
 335       }
 336
 337       case Property::MATRIX:
 338       {
 339         const Matrix& value = map.propertyValue->GetMatrix(bufferIndex);
 340         program.SetUniformMatrix4fv(location, 1, value.AsFloat() );
 341         break;
 342       }
 343
 344       case Property::MATRIX3:
 345       {
 346         const Matrix3& value = map.propertyValue->GetMatrix3(bufferIndex);
 347         program.SetUniformMatrix3fv(location, 1, value.AsFloat() );
 348         break;
 349       }
 350
 351       default:
 352       {
 353         // Other property types are ignored
 354         break;
 355       }
 356     }
 357   }
 358 }
 359
 360 bool Renderer::BindTextures( Context& context, Program& program )
 361 {
 362   unsigned int textureUnit = 0;
 363   bool result = true;
 364
 365   GLint uniformLocation(-1);
 366   std::vector<Render::Sampler*>& samplers( mRenderDataProvider->GetSamplers() );
 367   std::vector<Render::Texture*>& textures( mRenderDataProvider->GetTextures() );
 368   for( size_t i(0); i<textures.size() && result; ++i )
 369   {
 370     if( textures[i] )
 371     {
 372       result = textures[i]->Bind(context, textureUnit, samplers[i] );
 373       if( result && program.GetSamplerUniformLocation( i, uniformLocation ) )
 374       {
 375         program.SetUniform1i( uniformLocation, textureUnit );
 376         ++textureUnit;
 377       }
 378     }
 379   }
 380
 381   return result;
 382 }
 383
 384 void Renderer::SetFaceCullingMode( FaceCullingMode::Type mode )
 385 {
 386   mFaceCullingMode =  mode;
 387 }
 388
 389 void Renderer::SetBlendingBitMask( unsigned int bitmask )
 390 {
 391   mBlendingOptions.SetBitmask( bitmask );
 392 }
 393
 394 void Renderer::SetBlendColor( const Vector4& color )
 395 {
 396   mBlendingOptions.SetBlendColor( color );
 397 }
 398
 399 void Renderer::SetIndexedDrawFirstElement( size_t firstElement )
 400 {
 401   mIndexedDrawFirstElement = firstElement;
 402 }
 403
 404 void Renderer::SetIndexedDrawElementsCount( size_t elementsCount )
 405 {
 406   mIndexedDrawElementsCount = elementsCount;
 407 }
 408
 409 void Renderer::EnablePreMultipliedAlpha( bool enable )
 410 {
 411   mPremultipledAlphaEnabled = enable;
 412 }
 413
 414 void Renderer::SetDepthWriteMode( DepthWriteMode::Type depthWriteMode )
 415 {
 416   mDepthWriteMode = depthWriteMode;
 417 }
 418
 419 void Renderer::SetDepthTestMode( DepthTestMode::Type depthTestMode )
 420 {
 421   mDepthTestMode = depthTestMode;
 422 }
 423
 424 DepthWriteMode::Type Renderer::GetDepthWriteMode() const
 425 {
 426   return mDepthWriteMode;
 427 }
 428
 429 DepthTestMode::Type Renderer::GetDepthTestMode() const
 430 {
 431   return mDepthTestMode;
 432 }
 433
 434 void Renderer::SetDepthFunction( DepthFunction::Type depthFunction )
 435 {
 436   mDepthFunction = depthFunction;
 437 }
 438
 439 DepthFunction::Type Renderer::GetDepthFunction() const
 440 {
 441   return mDepthFunction;
 442 }
 443
 444 void Renderer::SetRenderMode( RenderMode::Type renderMode )
 445 {
 446   mStencilParameters.renderMode = renderMode;
 447 }
 448
 449 RenderMode::Type Renderer::GetRenderMode() const
 450 {
 451   return mStencilParameters.renderMode;
 452 }
 453
 454 void Renderer::SetStencilFunction( StencilFunction::Type stencilFunction )
 455 {
 456   mStencilParameters.stencilFunction = stencilFunction;
 457 }
 458
 459 StencilFunction::Type Renderer::GetStencilFunction() const
 460 {
 461   return mStencilParameters.stencilFunction;
 462 }
 463
 464 void Renderer::SetStencilFunctionMask( int stencilFunctionMask )
 465 {
 466   mStencilParameters.stencilFunctionMask = stencilFunctionMask;
 467 }
 468
 469 int Renderer::GetStencilFunctionMask() const
 470 {
 471   return mStencilParameters.stencilFunctionMask;
 472 }
 473
 474 void Renderer::SetStencilFunctionReference( int stencilFunctionReference )
 475 {
 476   mStencilParameters.stencilFunctionReference = stencilFunctionReference;
 477 }
 478
 479 int Renderer::GetStencilFunctionReference() const
 480 {
 481   return mStencilParameters.stencilFunctionReference;
 482 }
 483
 484 void Renderer::SetStencilMask( int stencilMask )
 485 {
 486   mStencilParameters.stencilMask = stencilMask;
 487 }
 488
 489 int Renderer::GetStencilMask() const
 490 {
 491   return mStencilParameters.stencilMask;
 492 }
 493
 494 void Renderer::SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail )
 495 {
 496   mStencilParameters.stencilOperationOnFail = stencilOperationOnFail;
 497 }
 498
 499 StencilOperation::Type Renderer::GetStencilOperationOnFail() const
 500 {
 501   return mStencilParameters.stencilOperationOnFail;
 502 }
 503
 504 void Renderer::SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail )
 505 {
 506   mStencilParameters.stencilOperationOnZFail = stencilOperationOnZFail;
 507 }
 508
 509 StencilOperation::Type Renderer::GetStencilOperationOnZFail() const
 510 {
 511   return mStencilParameters.stencilOperationOnZFail;
 512 }
 513
 514 void Renderer::SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass )
 515 {
 516   mStencilParameters.stencilOperationOnZPass = stencilOperationOnZPass;
 517 }
 518
 519 StencilOperation::Type Renderer::GetStencilOperationOnZPass() const
 520 {
 521   return mStencilParameters.stencilOperationOnZPass;
 522 }
 523
 524 void Renderer::Render( Context& context,
 525                        BufferIndex bufferIndex,
 526                        const SceneGraph::NodeDataProvider& node,
 527                        SceneGraph::Shader& defaultShader,
 528                        const Matrix& modelMatrix,
 529                        const Matrix& modelViewMatrix,
 530                        const Matrix& viewMatrix,
 531                        const Matrix& projectionMatrix,
 532                        const Vector3& size,
 533                        bool blend )
 534 {
 535   // Get the program to use:
 536   Program* program = mRenderDataProvider->GetShader().GetProgram();
 537   if( !program )
 538   {
 539     // if program is NULL it means this is a custom shader with non matching geometry type so we need to use default shaders program
 540     program = defaultShader.GetProgram();
 541     DALI_ASSERT_DEBUG( program && "Default shader should always have a program available." );
 542     if( !program )
 543     {
 544       DALI_LOG_ERROR( "Failed to get program for shader at address %p.\n", (void*)&mRenderDataProvider->GetShader() );
 545       return;
 546     }
 547   }
 548
 549   //Set cull face  mode
 550   context.CullFace( mFaceCullingMode );
 551
 552   //Set blending mode
 553   SetBlending( context, blend );
 554
 555   // Take the program into use so we can send uniforms to it
 556   program->Use();
 557
 558   if( DALI_LIKELY( BindTextures( context, *program ) ) )
 559   {
 560     // Only set up and draw if we have textures and they are all valid
 561
 562     // set projection and view matrix if program has not yet received them yet this frame
 563     SetMatrices( *program, modelMatrix, viewMatrix, projectionMatrix, modelViewMatrix );
 564
 565     // set color uniform
 566     GLint loc = program->GetUniformLocation( Program::UNIFORM_COLOR );
 567     if( Program::UNIFORM_UNKNOWN != loc )
 568     {
 569       const Vector4& color = node.GetRenderColor( bufferIndex );
 570       if( mPremultipledAlphaEnabled )
 571       {
 572         program->SetUniform4f( loc, color.r*color.a, color.g*color.a, color.b*color.a, color.a );
 573       }
 574       else
 575       {
 576         program->SetUniform4f( loc, color.r, color.g, color.b, color.a );
 577       }
 578     }
 579
 580     SetUniforms( bufferIndex, node, size, *program );
 581
 582     if( mUpdateAttributesLocation || mGeometry->AttributesChanged() )
 583     {
 584       mGeometry->GetAttributeLocationFromProgram( mAttributesLocation, *program, bufferIndex );
 585       mUpdateAttributesLocation = false;
 586     }
 587
 588     mGeometry->UploadAndDraw( context,
 589                               bufferIndex,
 590                               mAttributesLocation,
 591                               mIndexedDrawFirstElement,
 592                               mIndexedDrawElementsCount );
 593   }
 594 }
 595
 596 void Renderer::SetSortAttributes( BufferIndex bufferIndex,
 597                                   SceneGraph::RenderInstructionProcessor::SortAttributes& sortAttributes ) const
 598 {
 599   sortAttributes.shader = &( mRenderDataProvider->GetShader() );
 600   sortAttributes.geometry = mGeometry;
 601 }
 602
 603 } // namespace SceneGraph
 604
 605 } // namespace Internal
 606
 607 } // namespace Dali