dali/internal/render/common/render-algorithms.cpp

   1 /*
   2  * Copyright (c) 2016 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/common/render-algorithms.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/internal/render/common/render-debug.h>
  23 #include <dali/internal/render/common/render-list.h>
  24 #include <dali/internal/render/common/render-instruction.h>
  25 #include <dali/internal/render/gl-resources/context.h>
  26 #include <dali/internal/render/renderers/render-renderer.h>
  27 #include <dali/internal/update/nodes/scene-graph-layer.h>
  28 #include <dali/internal/update/manager/geometry-batcher.h>
  29
  30 using Dali::Internal::SceneGraph::RenderItem;
  31 using Dali::Internal::SceneGraph::RenderList;
  32 using Dali::Internal::SceneGraph::RenderListContainer;
  33 using Dali::Internal::SceneGraph::RenderInstruction;
  34 using Dali::Internal::SceneGraph::GeometryBatcher;
  35
  36 namespace Dali
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace Render
  43 {
  44
  45 namespace
  46 {
  47
  48 // Table for fast look-up of Dali::DepthFunction enum to a GL depth function.
  49 // Note: These MUST be in the same order as Dali::DepthFunction enum.
  50 const int DaliDepthToGLDepthTable[]  = { GL_NEVER, GL_ALWAYS, GL_LESS, GL_GREATER, GL_EQUAL, GL_NOTEQUAL, GL_LEQUAL, GL_GEQUAL };
  51
  52 // Table for fast look-up of Dali::StencilFunction enum to a GL stencil function.
  53 // Note: These MUST be in the same order as Dali::StencilFunction enum.
  54 const int DaliStencilFunctionToGL[]  = { GL_NEVER, GL_LESS, GL_EQUAL, GL_LEQUAL, GL_GREATER, GL_NOTEQUAL, GL_GEQUAL, GL_ALWAYS };
  55
  56 // Table for fast look-up of Dali::StencilOperation enum to a GL stencil operation.
  57 // Note: These MUST be in the same order as Dali::StencilOperation enum.
  58 const int DaliStencilOperationToGL[] = { GL_ZERO, GL_KEEP, GL_REPLACE, GL_INCR, GL_DECR, GL_INVERT, GL_INCR_WRAP, GL_DECR_WRAP };
  59
  60 } // Unnamed namespace
  61
  62 /**
  63  * Sets up the scissor test if required.
  64  * @param[in] renderList The render list from which to get the clipping flag
  65  * @param[in] context The context
  66  */
  67 inline void SetScissorTest( const RenderList& renderList, Context& context )
  68 {
  69   // Scissor testing
  70   if( renderList.IsClipping() )
  71   {
  72     context.SetScissorTest( true );
  73
  74     const Dali::ClippingBox& clip = renderList.GetClippingBox();
  75     context.Scissor(clip.x, clip.y, clip.width, clip.height);
  76   }
  77   else
  78   {
  79     context.SetScissorTest( false );
  80   }
  81 }
  82
  83 /**
  84  * Sets the render flags for the stencil buffer and clears all required buffers (depth and stencil if required).
  85  * @param[in] renderList The render list from which to get the render flags
  86  * @param[in] context The context
  87  * @param[in] depthTestEnabled True if depth test is enabled for the layer
  88  */
  89 inline void SetRenderFlags( const RenderList& renderList, Context& context, bool depthTestEnabled )
  90 {
  91   const unsigned int renderFlags = renderList.GetFlags();
  92   GLbitfield clearMask = 0u;
  93
  94   // Stencil enabled, writing, and clearing...
  95   const bool enableStencilBuffer( renderFlags & RenderList::STENCIL_BUFFER_ENABLED );
  96   const bool enableStencilWrite( renderFlags & RenderList::STENCIL_WRITE );
  97   context.EnableStencilBuffer( enableStencilBuffer );
  98   if( enableStencilBuffer )
  99   {
 100     context.StencilFunc( ( enableStencilWrite ? GL_ALWAYS : GL_EQUAL ), 1, 0xFF );
 101     context.StencilOp( GL_KEEP, GL_REPLACE, GL_REPLACE );
 102
 103     // Write to stencil buffer or color buffer, but not both.
 104     // These should only be set if the Actor::DrawMode is managing the stencil (and color) buffer.
 105     context.StencilMask( enableStencilWrite ? 0xFF : 0x00 );
 106     context.ColorMask( !enableStencilWrite );
 107
 108     clearMask |= ( renderFlags & RenderList::STENCIL_CLEAR ) ? GL_STENCIL_BUFFER_BIT : 0u;
 109   }
 110
 111   // Enable and Clear the depth buffer if required.
 112   if( depthTestEnabled )
 113   {
 114     clearMask |= GL_DEPTH_BUFFER_BIT;
 115
 116     // We need to enable the depth buffer to clear it.
 117     // Subsequently it is enabled and disabled on a per-RenderItem basis.
 118     context.EnableDepthBuffer( true );
 119   }
 120   else
 121   {
 122     context.EnableDepthBuffer( false );
 123   }
 124
 125   // Clear Depth and/or stencil buffers as required.
 126   // Note: The buffers will only be cleared if written to since a previous clear.
 127   context.Clear( clearMask, Context::CHECK_CACHED_VALUES );
 128 }
 129
 130 /**
 131  * @brief This method sets up the stencil and color buffer based on the current Renderers flags.
 132  * @param[in]     item                     The current RenderItem about to be rendered
 133  * @param[in]     context                  The context
 134  * @param[in/out] usedStencilBuffer        True if the stencil buffer has been used so far within this RenderList
 135  * @param[in]     stencilManagedByDrawMode True if the stencil and color buffer is being managed by DrawMode::STENCIL
 136  */
 137 inline void SetupPerRendererFlags( const RenderItem& item, Context& context, bool& usedStencilBuffer, bool stencilManagedByDrawMode )
 138 {
 139   // DrawMode::STENCIL is deprecated, however to support it we must not set
 140   // flags based on the renderer properties if it is in use.
 141   if( stencilManagedByDrawMode )
 142   {
 143     return;
 144   }
 145
 146   // Setup the color buffer based on the renderers properties.
 147   Renderer *renderer = item.mRenderer;
 148   RenderMode::Type renderMode = renderer->GetRenderMode();
 149   const bool writeToColorBuffer = ( renderMode == RenderMode::AUTO ) || ( renderMode == RenderMode::COLOR ) || ( renderMode == RenderMode::COLOR_STENCIL );
 150   context.ColorMask( writeToColorBuffer );
 151
 152   // If the stencil buffer is disabled for this renderer, exit now to save unnecessary value setting.
 153   if( ( renderMode != RenderMode::STENCIL ) && ( renderMode != RenderMode::COLOR_STENCIL ) )
 154   {
 155     // No per-renderer stencil setup, exit.
 156     context.EnableStencilBuffer( false );
 157     return;
 158   }
 159
 160   // At this point, the stencil buffer is enabled.
 161   context.EnableStencilBuffer( true );
 162
 163   // If this is the first use of the stencil buffer within this RenderList, clear it now.
 164   // This avoids unnecessary clears.
 165   if( !usedStencilBuffer )
 166   {
 167     context.Clear( GL_STENCIL_BUFFER_BIT, Context::CHECK_CACHED_VALUES );
 168     usedStencilBuffer = true;
 169   }
 170
 171   // Setup the stencil buffer based on the renderers properties.
 172   context.StencilFunc( DaliStencilFunctionToGL[ renderer->GetStencilFunction() ],
 173       renderer->GetStencilFunctionReference(),
 174       renderer->GetStencilFunctionMask() );
 175   context.StencilOp( DaliStencilOperationToGL[ renderer->GetStencilOperationOnFail() ],
 176       DaliStencilOperationToGL[ renderer->GetStencilOperationOnZFail() ],
 177       DaliStencilOperationToGL[ renderer->GetStencilOperationOnZPass() ] );
 178   context.StencilMask( renderer->GetStencilMask() );
 179 }
 180
 181 /**
 182  * Sets up the depth buffer for reading and writing based on the current render item.
 183  * The items read and write mode are used if specified.
 184  * If AUTO is selected for reading, the decision will be based on the Layer Behavior.
 185  * If AUTO is selected for writing, the decision will be based on the items opacity.
 186  * @param item The RenderItem to set up the depth buffer for
 187  * @param context The context used to execute GL commands.
 188  * @param depthTestEnabled True if depth testing has been enabled.
 189  */
 190 inline void SetupDepthBuffer( const RenderItem& item, Context& context, bool depthTestEnabled )
 191 {
 192   // Set up whether or not to write to the depth buffer.
 193   const DepthWriteMode::Type depthWriteMode = item.mRenderer->GetDepthWriteMode();
 194   // Most common mode (AUTO) is tested first.
 195   bool enableDepthWrite = ( ( depthWriteMode == DepthWriteMode::AUTO ) && depthTestEnabled && item.mIsOpaque ) ||
 196                           ( depthWriteMode == DepthWriteMode::ON );
 197   context.DepthMask( enableDepthWrite );
 198
 199   // Set up whether or not to read from (test) the depth buffer.
 200   const DepthTestMode::Type depthTestMode = item.mRenderer->GetDepthTestMode();
 201   // Most common mode (AUTO) is tested first.
 202   bool enableDepthTest = ( ( depthTestMode == DepthTestMode::AUTO ) && depthTestEnabled ) ||
 203                          ( depthTestMode == DepthTestMode::ON );
 204   // Look-up the GL depth function from the Dali::DepthFunction enum, and set it.
 205   context.DepthFunc( DaliDepthToGLDepthTable[ item.mRenderer->GetDepthFunction() ] );
 206
 207   // The depth buffer must be enabled if either reading or writing.
 208   context.EnableDepthBuffer( enableDepthWrite || enableDepthTest );
 209 }
 210
 211 /**
 212  * Process a render-list.
 213  * @param[in] renderList The render-list to process.
 214  * @param[in] context The GL context.
 215  * @param[in] defaultShader The default shader to use.
 216  * @param[in] buffer The current render buffer index (previous update buffer)
 217  * @param[in] viewMatrix The view matrix from the appropriate camera.
 218  * @param[in] projectionMatrix The projection matrix from the appropriate camera.
 219  * @param[in] geometryBatcher The instance of the geometry batcher
 220  */
 221 inline void ProcessRenderList(
 222   const RenderList& renderList,
 223   Context& context,
 224   SceneGraph::TextureCache& textureCache,
 225   SceneGraph::Shader& defaultShader,
 226   BufferIndex bufferIndex,
 227   const Matrix& viewMatrix,
 228   const Matrix& projectionMatrix,
 229   GeometryBatcher* geometryBatcher )
 230 {
 231   DALI_PRINT_RENDER_LIST( renderList );
 232
 233   bool autoDepthTestMode = !( renderList.GetSourceLayer()->IsDepthTestDisabled() ) && renderList.HasColorRenderItems();
 234   bool usedStencilBuffer = false;
 235   bool stencilManagedByDrawMode = renderList.GetFlags() & RenderList::STENCIL_BUFFER_ENABLED;
 236
 237   SetScissorTest( renderList, context );
 238   SetRenderFlags( renderList, context, autoDepthTestMode );
 239
 240   const std::size_t count = renderList.Count();
 241   bool skip( false );
 242   for ( size_t index = 0; index < count; ++index )
 243   {
 244     const RenderItem& item = renderList.GetItem( index );
 245     DALI_PRINT_RENDER_ITEM( item );
 246
 247     // Set up the depth buffer based on per-renderer flags.
 248     // If the per renderer flags are set to "ON" or "OFF", they will always override any Layer depth mode or
 249     // draw-mode state, such as Overlays.
 250     // If the flags are set to "AUTO", the behaviour then depends on the type of renderer. Overlay Renderers will always
 251     // disable depth testing and writing. Color Renderers will enable them if the Layer does.
 252     SetupDepthBuffer( item, context, autoDepthTestMode );
 253     SetupPerRendererFlags( item, context, usedStencilBuffer, stencilManagedByDrawMode );
 254
 255     // Check if the node has a valid batch index value ( set previously by
 256     // GeometryBatcher ). If so, then it queries the geometry object for this particular batch.
 257     // If not, it still checks if the batch parent is set as it is possible, batching may
 258     // fail ( for example if vertex format or buffers are not set ). In that case we need
 259     // to skip rendering, otherwise unwanted GPU buffers will get uploaded. This is very rare case.
 260     uint32_t batchIndex = item.mNode->mBatchIndex;
 261     if( batchIndex != BATCH_NULL_HANDLE )
 262     {
 263       item.mBatchRenderGeometry = geometryBatcher->GetGeometry( batchIndex );
 264     }
 265     else
 266     {
 267       skip = item.mNode->GetBatchParent();
 268       item.mBatchRenderGeometry = NULL;
 269     }
 270     if( DALI_LIKELY( !skip ) )
 271     {
 272       item.mRenderer->Render( context, textureCache, bufferIndex, *item.mNode, defaultShader,
 273                             item.mModelMatrix, item.mModelViewMatrix, viewMatrix, projectionMatrix, item.mSize, item.mBatchRenderGeometry, !item.mIsOpaque );
 274     }
 275   }
 276 }
 277
 278 void ProcessRenderInstruction( const RenderInstruction& instruction,
 279                                Context& context,
 280                                SceneGraph::TextureCache& textureCache,
 281                                SceneGraph::Shader& defaultShader,
 282                                GeometryBatcher& geometryBatcher,
 283                                BufferIndex bufferIndex )
 284 {
 285   DALI_PRINT_RENDER_INSTRUCTION( instruction, bufferIndex );
 286
 287   const Matrix* viewMatrix       = instruction.GetViewMatrix( bufferIndex );
 288   const Matrix* projectionMatrix = instruction.GetProjectionMatrix( bufferIndex );
 289
 290   DALI_ASSERT_DEBUG( NULL != viewMatrix );
 291   DALI_ASSERT_DEBUG( NULL != projectionMatrix );
 292
 293   if( NULL != viewMatrix &&
 294       NULL != projectionMatrix )
 295   {
 296     const RenderListContainer::SizeType count = instruction.RenderListCount();
 297
 298     // Iterate through each render list in order. If a pair of render lists
 299     // are marked as interleaved, then process them together.
 300     for( RenderListContainer::SizeType index = 0; index < count; ++index )
 301     {
 302       const RenderList* renderList = instruction.GetRenderList( index );
 303
 304       if(  renderList &&
 305           !renderList->IsEmpty() )
 306       {
 307         ProcessRenderList( *renderList, context, textureCache, defaultShader, bufferIndex, *viewMatrix, *projectionMatrix, &geometryBatcher );
 308       }
 309     }
 310   }
 311 }
 312
 313 } // namespace Render
 314
 315 } // namespace Internal
 316
 317 } // namespace Dali