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( OwnerPointer<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 =  mRenderDataProvider->GetTextures().size();
 174   Program* program = mRenderDataProvider->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 }
 220
 221 void Renderer::GlCleanup()
 222 {
 223 }
 224
 225 void Renderer::SetUniforms( BufferIndex bufferIndex, const SceneGraph::NodeDataProvider& node, const Vector3& size, Program& program )
 226 {
 227   // Check if the map has changed
 228
 229
 230
 231 #if 0
 232   DALI_ASSERT_DEBUG( mRenderDataProvider && "No Uniform map data provider available" );
 233
 234
 235   const SceneGraph::UniformMapDataProvider& uniformMapDataProvider = mRenderDataProvider->GetUniformMap();
 236
 237   if( uniformMapDataProvider.GetUniformMapChanged( bufferIndex ) ||
 238       node.GetUniformMapChanged(bufferIndex))
 239   {
 240     const SceneGraph::CollectedUniformMap& uniformMap = uniformMapDataProvider.GetUniformMap( bufferIndex );
 241     const SceneGraph::CollectedUniformMap& uniformMapNode = node.GetUniformMap( bufferIndex );
 242
 243     unsigned int maxMaps = uniformMap.Count() + uniformMapNode.Count();
 244     mUniformIndexMap.Clear(); // Clear contents, but keep memory if we don't change size
 245     mUniformIndexMap.Resize( maxMaps );
 246
 247     unsigned int mapIndex(0);
 248     for(; mapIndex < uniformMap.Count() ; ++mapIndex )
 249     {
 250       mUniformIndexMap[mapIndex].propertyValue = uniformMap[mapIndex]->propertyPtr;
 251       mUniformIndexMap[mapIndex].uniformIndex = program.RegisterUniform( uniformMap[mapIndex]->uniformName );
 252     }
 253
 254     for( unsigned int nodeMapIndex = 0; nodeMapIndex < uniformMapNode.Count() ; ++nodeMapIndex )
 255     {
 256       unsigned int uniformIndex = program.RegisterUniform( uniformMapNode[nodeMapIndex]->uniformName );
 257       bool found(false);
 258       for( unsigned int i(0); i<uniformMap.Count(); ++i )
 259       {
 260         if( mUniformIndexMap[i].uniformIndex == uniformIndex )
 261         {
 262           mUniformIndexMap[i].propertyValue = uniformMapNode[nodeMapIndex]->propertyPtr;
 263           found = true;
 264           break;
 265         }
 266       }
 267
 268       if( !found )
 269       {
 270         mUniformIndexMap[mapIndex].propertyValue = uniformMapNode[nodeMapIndex]->propertyPtr;
 271         mUniformIndexMap[mapIndex].uniformIndex = uniformIndex;
 272         ++mapIndex;
 273       }
 274     }
 275
 276     mUniformIndexMap.Resize( mapIndex );
 277   }
 278
 279   // Set uniforms in local map
 280   for( UniformIndexMappings::Iterator iter = mUniformIndexMap.Begin(),
 281          end = mUniformIndexMap.End() ;
 282        iter != end ;
 283        ++iter )
 284   {
 285     SetUniformFromProperty( bufferIndex, program, *iter );
 286   }
 287
 288   GLint sizeLoc = program.GetUniformLocation( Program::UNIFORM_SIZE );
 289   if( -1 != sizeLoc )
 290   {
 291     program.SetSizeUniform3f( sizeLoc, size.x, size.y, size.z );
 292   }
 293 #endif
 294
 295 }
 296
 297 void Renderer::SetUniformFromProperty( BufferIndex bufferIndex, Program& program, UniformIndexMap& map )
 298 {
 299   GLint location = program.GetUniformLocation(map.uniformIndex);
 300   if( Program::UNIFORM_UNKNOWN != location )
 301   {
 302     // switch based on property type to use correct GL uniform setter
 303     switch ( map.propertyValue->GetType() )
 304     {
 305       case Property::INTEGER:
 306       {
 307         program.SetUniform1i( location, map.propertyValue->GetInteger( bufferIndex ) );
 308         break;
 309       }
 310       case Property::FLOAT:
 311       {
 312         program.SetUniform1f( location, map.propertyValue->GetFloat( bufferIndex ) );
 313         break;
 314       }
 315       case Property::VECTOR2:
 316       {
 317         Vector2 value( map.propertyValue->GetVector2( bufferIndex ) );
 318         program.SetUniform2f( location, value.x, value.y );
 319         break;
 320       }
 321
 322       case Property::VECTOR3:
 323       {
 324         Vector3 value( map.propertyValue->GetVector3( bufferIndex ) );
 325         program.SetUniform3f( location, value.x, value.y, value.z );
 326         break;
 327       }
 328
 329       case Property::VECTOR4:
 330       {
 331         Vector4 value( map.propertyValue->GetVector4( bufferIndex ) );
 332         program.SetUniform4f( location, value.x, value.y, value.z, value.w );
 333         break;
 334       }
 335
 336       case Property::ROTATION:
 337       {
 338         Quaternion value( map.propertyValue->GetQuaternion( bufferIndex ) );
 339         program.SetUniform4f( location, value.mVector.x, value.mVector.y, value.mVector.z, value.mVector.w );
 340         break;
 341       }
 342
 343       case Property::MATRIX:
 344       {
 345         const Matrix& value = map.propertyValue->GetMatrix(bufferIndex);
 346         program.SetUniformMatrix4fv(location, 1, value.AsFloat() );
 347         break;
 348       }
 349
 350       case Property::MATRIX3:
 351       {
 352         const Matrix3& value = map.propertyValue->GetMatrix3(bufferIndex);
 353         program.SetUniformMatrix3fv(location, 1, value.AsFloat() );
 354         break;
 355       }
 356
 357       default:
 358       {
 359         // Other property types are ignored
 360         break;
 361       }
 362     }
 363   }
 364 }
 365
 366 bool Renderer::BindTextures( Context& context, Program& program )
 367 {
 368   unsigned int textureUnit = 0;
 369   bool result = true;
 370
 371   GLint uniformLocation(-1);
 372   std::vector<Render::Sampler*>& samplers( mRenderDataProvider->GetSamplers() );
 373   std::vector<Render::Texture*>& textures( mRenderDataProvider->GetTextures() );
 374   for( size_t i(0); i<textures.size() && result; ++i )
 375   {
 376     if( textures[i] )
 377     {
 378       result = textures[i]->Bind(context, textureUnit, samplers[i] );
 379       if( result && program.GetSamplerUniformLocation( i, uniformLocation ) )
 380       {
 381         program.SetUniform1i( uniformLocation, textureUnit );
 382         ++textureUnit;
 383       }
 384     }
 385   }
 386
 387   return result;
 388 }
 389
 390 void Renderer::SetFaceCullingMode( FaceCullingMode::Type mode )
 391 {
 392   mFaceCullingMode =  mode;
 393 }
 394
 395 void Renderer::SetBlendingBitMask( unsigned int bitmask )
 396 {
 397   mBlendingOptions.SetBitmask( bitmask );
 398 }
 399
 400 void Renderer::SetBlendColor( const Vector4& color )
 401 {
 402   mBlendingOptions.SetBlendColor( color );
 403 }
 404
 405 void Renderer::SetIndexedDrawFirstElement( size_t firstElement )
 406 {
 407   mIndexedDrawFirstElement = firstElement;
 408 }
 409
 410 void Renderer::SetIndexedDrawElementsCount( size_t elementsCount )
 411 {
 412   mIndexedDrawElementsCount = elementsCount;
 413 }
 414
 415 void Renderer::EnablePreMultipliedAlpha( bool enable )
 416 {
 417   mPremultipledAlphaEnabled = enable;
 418 }
 419
 420 void Renderer::SetDepthWriteMode( DepthWriteMode::Type depthWriteMode )
 421 {
 422   mDepthWriteMode = depthWriteMode;
 423 }
 424
 425 void Renderer::SetDepthTestMode( DepthTestMode::Type depthTestMode )
 426 {
 427   mDepthTestMode = depthTestMode;
 428 }
 429
 430 DepthWriteMode::Type Renderer::GetDepthWriteMode() const
 431 {
 432   return mDepthWriteMode;
 433 }
 434
 435 DepthTestMode::Type Renderer::GetDepthTestMode() const
 436 {
 437   return mDepthTestMode;
 438 }
 439
 440 void Renderer::SetDepthFunction( DepthFunction::Type depthFunction )
 441 {
 442   mDepthFunction = depthFunction;
 443 }
 444
 445 DepthFunction::Type Renderer::GetDepthFunction() const
 446 {
 447   return mDepthFunction;
 448 }
 449
 450 void Renderer::SetRenderMode( RenderMode::Type renderMode )
 451 {
 452   mStencilParameters.renderMode = renderMode;
 453 }
 454
 455 RenderMode::Type Renderer::GetRenderMode() const
 456 {
 457   return mStencilParameters.renderMode;
 458 }
 459
 460 void Renderer::SetStencilFunction( StencilFunction::Type stencilFunction )
 461 {
 462   mStencilParameters.stencilFunction = stencilFunction;
 463 }
 464
 465 StencilFunction::Type Renderer::GetStencilFunction() const
 466 {
 467   return mStencilParameters.stencilFunction;
 468 }
 469
 470 void Renderer::SetStencilFunctionMask( int stencilFunctionMask )
 471 {
 472   mStencilParameters.stencilFunctionMask = stencilFunctionMask;
 473 }
 474
 475 int Renderer::GetStencilFunctionMask() const
 476 {
 477   return mStencilParameters.stencilFunctionMask;
 478 }
 479
 480 void Renderer::SetStencilFunctionReference( int stencilFunctionReference )
 481 {
 482   mStencilParameters.stencilFunctionReference = stencilFunctionReference;
 483 }
 484
 485 int Renderer::GetStencilFunctionReference() const
 486 {
 487   return mStencilParameters.stencilFunctionReference;
 488 }
 489
 490 void Renderer::SetStencilMask( int stencilMask )
 491 {
 492   mStencilParameters.stencilMask = stencilMask;
 493 }
 494
 495 int Renderer::GetStencilMask() const
 496 {
 497   return mStencilParameters.stencilMask;
 498 }
 499
 500 void Renderer::SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail )
 501 {
 502   mStencilParameters.stencilOperationOnFail = stencilOperationOnFail;
 503 }
 504
 505 StencilOperation::Type Renderer::GetStencilOperationOnFail() const
 506 {
 507   return mStencilParameters.stencilOperationOnFail;
 508 }
 509
 510 void Renderer::SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail )
 511 {
 512   mStencilParameters.stencilOperationOnZFail = stencilOperationOnZFail;
 513 }
 514
 515 StencilOperation::Type Renderer::GetStencilOperationOnZFail() const
 516 {
 517   return mStencilParameters.stencilOperationOnZFail;
 518 }
 519
 520 void Renderer::SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass )
 521 {
 522   mStencilParameters.stencilOperationOnZPass = stencilOperationOnZPass;
 523 }
 524
 525 StencilOperation::Type Renderer::GetStencilOperationOnZPass() const
 526 {
 527   return mStencilParameters.stencilOperationOnZPass;
 528 }
 529
 530 void Renderer::Render( Context& context,
 531                        BufferIndex bufferIndex,
 532                        const SceneGraph::NodeDataProvider& node,
 533                        const Matrix& modelMatrix,
 534                        const Matrix& modelViewMatrix,
 535                        const Matrix& viewMatrix,
 536                        const Matrix& projectionMatrix,
 537                        const Vector3& size,
 538                        bool blend )
 539 {
 540   // TODO: AB: no callig any GL now, to avoid asserts whole function commented out
 541   return;
 542 #if 0
 543   // Get the program to use:
 544   Program* program = mRenderDataProvider->GetShader().GetProgram();
 545   if( !program )
 546   {
 547     return;
 548   }
 549
 550   //Set cull face  mode
 551   context.CullFace( mFaceCullingMode );
 552
 553   //Set blending mode
 554   SetBlending( context, blend );
 555
 556   // Take the program into use so we can send uniforms to it
 557   program->Use();
 558
 559   if( DALI_LIKELY( BindTextures( context, *program ) ) )
 560   {
 561     // Only set up and draw if we have textures and they are all valid
 562
 563     // set projection and view matrix if program has not yet received them yet this frame
 564     SetMatrices( *program, modelMatrix, viewMatrix, projectionMatrix, modelViewMatrix );
 565
 566     // set color uniform
 567     GLint loc = program->GetUniformLocation( Program::UNIFORM_COLOR );
 568     if( Program::UNIFORM_UNKNOWN != loc )
 569     {
 570       const Vector4& color = node.GetRenderColor( bufferIndex );
 571       if( mPremultipledAlphaEnabled )
 572       {
 573         program->SetUniform4f( loc, color.r*color.a, color.g*color.a, color.b*color.a, color.a );
 574       }
 575       else
 576       {
 577         program->SetUniform4f( loc, color.r, color.g, color.b, color.a );
 578       }
 579     }
 580
 581     SetUniforms( bufferIndex, node, size, *program );
 582
 583     if( mUpdateAttributesLocation || mGeometry->AttributesChanged() )
 584     {
 585       mGeometry->GetAttributeLocationFromProgram( mAttributesLocation, *program, bufferIndex );
 586       mUpdateAttributesLocation = false;
 587     }
 588
 589     mGeometry->UploadAndDraw( context,
 590                               bufferIndex,
 591                               mAttributesLocation,
 592                               mIndexedDrawFirstElement,
 593                               mIndexedDrawElementsCount );
 594   }
 595 #endif
 596 }
 597
 598 void Renderer::SetSortAttributes( BufferIndex bufferIndex,
 599                                   SceneGraph::RenderInstructionProcessor::SortAttributes& sortAttributes ) const
 600 {
 601   sortAttributes.shader = &( mRenderDataProvider->GetShader() );
 602   sortAttributes.geometry = mGeometry;
 603 }
 604
 605 } // namespace SceneGraph
 606
 607 } // namespace Internal
 608
 609 } // namespace Dali