Merge "Clean up the code to build successfully on macOS" into devel/master
[platform/core/uifw/dali-core.git] / dali / internal / event / rendering / renderer-impl.h
old mode 100644 (file)
new mode 100755 (executable)
index b43a582..6849bf3
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_RENDERER_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 // INTERNAL INCLUDES
 #include <dali/public-api/common/dali-common.h> // DALI_ASSERT_ALWAYS
 #include <dali/public-api/common/intrusive-ptr.h> // Dali::IntrusivePtr
-#include <dali/devel-api/rendering/renderer.h> // Dali::Renderer
+#include <dali/public-api/rendering/renderer.h> // Dali::Renderer
+#include <dali/devel-api/rendering/renderer-devel.h>
 #include <dali/internal/common/blending-options.h>
-#include <dali/internal/event/common/connectable.h> // Dali::Internal::Connectable
 #include <dali/internal/event/common/object-connector.h> // Dali::Internal::ObjectConnector
 #include <dali/internal/event/common/object-impl.h> // Dali::Internal::Object
 #include <dali/internal/event/rendering/texture-set-impl.h> // Dali::Internal::TextureSet
 #include <dali/internal/event/rendering/geometry-impl.h> // Dali::Internal::Geometry
+#include <dali/internal/render/renderers/render-renderer.h> // Dali::Render::Renderer::StencilParameters
 
 namespace Dali
 {
@@ -38,9 +39,8 @@ namespace SceneGraph
 class Renderer;
 }
 
-
 class Renderer;
-typedef IntrusivePtr<Renderer> RendererPtr;
+using RendererPtr = IntrusivePtr<Renderer>;
 
 /**
  * Renderer is an object that can be used to show content by combining a Geometry with a shader and textures.
@@ -63,7 +63,7 @@ public:
   /**
    * @copydoc Dali::Renderer::GetGeometry()
    */
-  Geometry* GetGeometry() const;
+  GeometryPtr GetGeometry() const;
 
   /**
    * @copydoc Dali::Renderer::SetTextures()
@@ -73,7 +73,7 @@ public:
   /**
    * @copydoc Dali::Renderer::GetTextures()
    */
-  TextureSet* GetTextures() const;
+  TextureSetPtr GetTextures() const;
 
   /**
    * @copydoc Dali::Renderer::SetShader()
@@ -83,243 +83,209 @@ public:
   /**
    * @copydoc Dali::Renderer::GetShader()
    */
-  Shader* GetShader() const;
+  ShaderPtr GetShader() const;
 
   /**
    * @copydoc Dali::Renderer::SetDepthIndex()
    */
-  void SetDepthIndex( int depthIndex );
+  void SetDepthIndex( int32_t depthIndex );
 
   /**
    * @copydoc Dali::Renderer::GetDepthIndex()
    */
-  int GetDepthIndex() const;
+  int32_t GetDepthIndex() const;
 
   /**
-    * @copydoc Dali::Renderer::SetFaceCullingMode()
-    */
-   void SetFaceCullingMode( FaceCullingMode::Type cullingMode );
-
-   /**
-    * @copydoc Dali::Renderer::GetFaceCullingMode()
-    */
-   FaceCullingMode::Type GetFaceCullingMode();
-
-   /**
-    * @copydoc Dali::Renderer::SetBlendMode()
-    */
-   void SetBlendMode( BlendMode::Type mode );
-
-   /**
-    * @copydoc Dali::Renderer::GetBlendMode()
-    */
-   BlendMode::Type GetBlendMode() const;
-
-   /**
-    * @copydoc Dali::Renderer::SetBlendFunc()
-    */
-   void SetBlendFunc( BlendFactor::Type srcFactorRgba, BlendFactor::Type destFactorRgba );
-
-   /**
-    * @copydoc Dali::Renderer::SetBlendFunc()
-    */
-   void SetBlendFunc( BlendFactor::Type srcFactorRgb,   BlendFactor::Type destFactorRgb,
-                      BlendFactor::Type srcFactorAlpha, BlendFactor::Type destFactorAlpha );
-
-   /**
-    * @copydoc Dali::Renderer::GetBlendFunc()
-    */
-   void GetBlendFunc( BlendFactor::Type& srcFactorRgb,   BlendFactor::Type& destFactorRgb,
-                      BlendFactor::Type& srcFactorAlpha, BlendFactor::Type& destFactorAlpha ) const;
-
-   /**
-    * @copydoc Dali::Renderer::SetBlendEquation()
-    */
-   void SetBlendEquation( BlendEquation::Type equationRgba );
-
-   /**
-    * @copydoc Dali::Renderer::SetBlendEquation()
-    */
-   void SetBlendEquation( BlendEquation::Type equationRgb, BlendEquation::Type equationAlpha );
-
-   /**
-    * @copydoc Dali::Renderer::GetBlendEquation()
-    */
-   void GetBlendEquation( BlendEquation::Type& equationRgb, BlendEquation::Type& equationAlpha ) const;
-
-   /**
-    * @copydoc Dali::Renderer::SetBlendColor()
-    */
-   void SetBlendColor( const Vector4& color );
-
-   /**
-    * @copydoc Dali::Renderer::GetBlendColor()
-    */
-   Vector4 GetBlendColor() const;
-
-   /**
-    * @copydoc Dali::Renderer::SetIndexedDrawFirstElement
-    */
-   void SetIndexedDrawFirstElement( size_t firstElement );
-
-   /**
-    * @copydoc Dali::Renderer::SetIndexedDrawElementsCount
-    */
-   void SetIndexedDrawElementsCount( size_t elementsCount );
-
-   /**
-    * @brief Set whether the Pre-multiplied Alpha Blending is required
-    *
-    * @param[in] preMultipled whether alpha is pre-multiplied.
-    */
-   void EnablePreMultipliedAlpha( bool preMultipled );
+   * @copydoc Dali::Renderer::SetBlendMode()
+   */
+  void SetBlendMode( BlendMode::Type mode );
 
-   /**
-    * @brief Query whether alpha is pre-multiplied.
-    *
-    * @return True is alpha is pre-multiplied, false otherwise.
-    */
-   bool IsPreMultipliedAlphaEnabled() const;
+  /**
+   * @copydoc Dali::Renderer::GetBlendMode()
+   */
+  BlendMode::Type GetBlendMode() const;
 
   /**
-   * @brief Get the scene graph object
-   *
-   * @return the scene object
+   * @copydoc Dali::Renderer::SetBlendFunc()
    */
-  SceneGraph::Renderer* GetRendererSceneObject();
+  void SetBlendFunc( BlendFactor::Type srcFactorRgba, BlendFactor::Type destFactorRgba );
 
-public: // Default property extensions from Object
+  /**
+   * @copydoc Dali::Renderer::SetBlendFunc()
+   */
+  void SetBlendFunc( BlendFactor::Type srcFactorRgb,   BlendFactor::Type destFactorRgb,
+                     BlendFactor::Type srcFactorAlpha, BlendFactor::Type destFactorAlpha );
 
   /**
-   * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
+   * @copydoc Dali::Renderer::GetBlendFunc()
    */
-  virtual unsigned int GetDefaultPropertyCount() const;
+  void GetBlendFunc( BlendFactor::Type& srcFactorRgb,   BlendFactor::Type& destFactorRgb,
+                    BlendFactor::Type& srcFactorAlpha, BlendFactor::Type& destFactorAlpha ) const;
 
   /**
-   * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
+   * @brief Set same Blend Equation for the RGB and alpha
    */
-  virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
+  void SetBlendEquation( DevelBlendEquation::Type equationRgba );
 
   /**
-   * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
+   * @brief Set Blend Equation separately for the RGB and alpha
    */
-  virtual const char* GetDefaultPropertyName(Property::Index index) const;
+  void SetBlendEquation( DevelBlendEquation::Type equationRgb, DevelBlendEquation::Type equationAlpha );
 
   /**
-   * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
+   * @brief Get Blend Equation of rgb and alpha
    */
-  virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
+  void GetBlendEquation( DevelBlendEquation::Type& equationRgb, DevelBlendEquation::Type& equationAlpha ) const;
 
   /**
-   * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
+   * @copydoc Dali::Renderer::SetIndexedDrawFirstElement
    */
-  virtual bool IsDefaultPropertyWritable(Property::Index index) const;
+  void SetIndexedDrawFirstElement( uint32_t firstElement );
 
   /**
-   * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
+   * @copydoc Dali::Renderer::SetIndexedDrawElementsCount
    */
-  virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
+  void SetIndexedDrawElementsCount( uint32_t elementsCount );
 
   /**
-   * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
+   * @brief Set whether the Pre-multiplied Alpha Blending is required
+   *
+   * @param[in] preMultipled whether alpha is pre-multiplied.
    */
-  virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
+  void EnablePreMultipliedAlpha( bool preMultipled );
 
   /**
-   * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
+   * @brief Query whether alpha is pre-multiplied.
+   *
+   * @return True is alpha is pre-multiplied, false otherwise.
    */
-  virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
+  bool IsPreMultipliedAlphaEnabled() const;
 
   /**
-   * @copydoc Dali::Internal::Object::SetDefaultProperty()
+   * @brief Query whether Blend Equation Advanced is used in this renderer
+   *
+   * @return True is Blend Equation Advanced is used, false otherwise.
    */
-  virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
+  bool IsAdvancedBlendEquationApplied() const;
 
   /**
-   * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
+   * @brief Get the scene graph object
+   *
+   * @return the scene object
    */
-  virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
+  const SceneGraph::Renderer& GetRendererSceneObject() const;
+
+public: // Default property extensions from Object
 
   /**
-   * @copydoc Dali::Internal::Object::GetDefaultProperty()
+   * @copydoc Dali::Internal::Object::SetDefaultProperty()
    */
-  virtual Property::Value GetDefaultProperty( Property::Index index ) const;
+  void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue) override;
 
   /**
-   * @copydoc Dali::Internal::Object::GetPropertyOwner()
+   * @copydoc Dali::Internal::Object::GetDefaultProperty()
    */
-  virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
+  Property::Value GetDefaultProperty( Property::Index index ) const override;
 
   /**
-   * @copydoc Dali::Internal::Object::GetSceneObject()
+   * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue()
    */
-  virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
+  Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const override;
+
+   /**
+    * @copydoc Dali::Internal::Object::OnNotifyDefaultPropertyAnimation()
+    */
+   void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType ) override;
 
   /**
    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
    */
-  virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
+  const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const override;
 
   /**
    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
    */
-  virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
+  const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const override;
 
   /**
-   * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
+   * @brief Adds a draw command to the Renderer.
+   * DrawCommands override Renderer's default behaviour.
+   *
+   * @param[in] command Valid reference to a DrawCommand objects
    */
-  virtual int GetPropertyComponentIndex( Property::Index index ) const;
+  void AddDrawCommand( const Dali::DevelRenderer::DrawCommand& command );
+
+private: // implementation
 
-public: // Functions from Connectable
   /**
-   * @copydoc Dali::Internal::Connectable::OnStage()
+   * @brief Constructor.
+   *
+   * @param sceneObject the scene graph renderer
    */
-  virtual bool OnStage() const;
+  Renderer( const SceneGraph::Renderer* sceneObject );
 
   /**
-   * @copydoc Dali::Internal::Connectable::Connect()
+   * @brief Sets the blend color.
+   * @param[in] blendColor The blend color to set.
    */
-  virtual void Connect();
+  void SetBlendColor( const Vector4& blendColor );
 
   /**
-   * @copydoc Dali::Internal::Connectable::Disconnect()
+   * @brief Retrieves the blend-color.
+   * @return A const reference to the blend-color
    */
-  virtual void Disconnect();
+  const Vector4& GetBlendColor() const;
 
-private: // implementation
-  Renderer();
+  /**
+   * @brief Retrieves the cached event side value of a default property.
+   * @param[in]  index  The index of the property
+   * @param[out] value  Is set with the cached value of the property if found.
+   * @return True if value set, false otherwise.
+   */
+  bool GetCachedPropertyValue( Property::Index index, Property::Value& value ) const;
 
-  void Initialize();
+  /**
+   * @brief Retrieves the current value of a default property from the scene-graph.
+   * @param[in]  index  The index of the property
+   * @param[out] value  Is set with the current scene-graph value of the property
+   * @return True if value set, false otherwise.
+   */
+  bool GetCurrentPropertyValue( Property::Index index, Property::Value& value  ) const;
 
 protected:
   /**
    * A reference counted object may only be deleted by calling Unreference()
    */
-  virtual ~Renderer();
+  ~Renderer() override;
 
 private: // unimplemented methods
   Renderer( const Renderer& );
   Renderer& operator=( const Renderer& );
 
 private: // data
-  SceneGraph::Renderer* mSceneObject;
-  Vector4* mBlendColor;                             ///< Local copy of blend color, pointer only as its rarely used
-  GeometryPtr mGeometry;                            ///< Connector that holds the geometry used by this renderer
-  ObjectConnector<TextureSet> mTextureSetConnector; ///< Connector that holds the texture set used by this renderer
-  IntrusivePtr<Shader> mShader;                     ///< Connector that holds the shader used by this renderer
 
-  int mDepthIndex;
-  int mOnStageCount;
+  GeometryPtr                         mGeometry;                   ///< Intrusive pointer to the geometry used by this renderer
+  TextureSetPtr                       mTextureSet;                 ///< Intrusive pointer to the texture set used by this renderer
+  ShaderPtr                           mShader;                     ///< Intrusive pointer to the shader used by this renderer
+
+  int32_t                             mDepthIndex;
+
+  uint32_t                            mIndexedDrawFirstElement;    ///< Offset of first element to draw from bound index buffer
+  uint32_t                            mIndexedDrawElementCount;    ///< Number of elements to draw
 
-  size_t mIndexedDrawFirstElement;                  ///< Offset of first element to draw from bound index buffer
-  size_t mIndexedDrawElementCount;                  ///< Number of elements to draw
+  Render::Renderer::StencilParameters mStencilParameters;          ///< Struct containing all stencil related options
+  BlendingOptions                     mBlendingOptions;            ///< Local copy of blending options bitmask
 
-  Dali::FaceCullingMode::Type mFaceCullingMode;     ///< Local copy of face culling mode
-  BlendMode::Type mBlendMode;                       ///< Local copy of blending mode
-  BlendingOptions mBlendingOptions;                 ///< Local copy of blending options bitmask
-  Dali::DepthWriteMode::Type mDepthWriteMode;       ///< Local copy of depth write mode
+  float                               mOpacity;                    ///< Local copy of the opacity
+  DepthFunction::Type                 mDepthFunction:4;            ///< Local copy of the depth function
+  FaceCullingMode::Type               mFaceCullingMode:3;          ///< Local copy of the mode of face culling
+  BlendMode::Type                     mBlendMode:3;                ///< Local copy of the mode of blending
+  DepthWriteMode::Type                mDepthWriteMode:3;           ///< Local copy of the depth write mode
+  DepthTestMode::Type                 mDepthTestMode:3;            ///< Local copy of the depth test mode
+  DevelRenderer::Rendering::Type      mRenderingBehavior:2;        ///< The rendering behavior
+  bool                                mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
 
-  bool mPremultipledAlphaEnabled : 1;               ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
+  std::vector<Dali::DevelRenderer::DrawCommand> mDrawCommands;     ///< list of draw commands
 };
 
 } // namespace Internal