[3.0] Combine StencilMode and WriteToColorBuffer to RenderMode
[platform/core/uifw/dali-core.git] / dali / internal / render / renderers / render-renderer.h
index 2faf69b..0f17f26 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_INTERNAL_RENDER_RENDERER_H__
-#define __DALI_INTERNAL_RENDER_RENDERER_H__
+#ifndef DALI_INTERNAL_RENDER_RENDERER_H
+#define DALI_INTERNAL_RENDER_RENDERER_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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/math/matrix.h>
 #include <dali/public-api/math/vector4.h>
-#include <dali/devel-api/rendering/texture-set.h>
+#include <dali/public-api/rendering/texture-set.h>
 #include <dali/internal/common/blending-options.h>
 #include <dali/internal/common/message.h>
+#include <dali/internal/common/type-abstraction-enums.h>
 #include <dali/internal/event/common/property-input-impl.h>
 #include <dali/internal/event/effects/shader-declarations.h>
-#include <dali/internal/render/gl-resources/gl-resource-owner.h>
-#include <dali/integration-api/debug.h>
-#include <dali/internal/common/type-abstraction-enums.h>
-#include <dali/internal/update/manager/prepare-render-instructions.h>
 #include <dali/internal/render/data-providers/render-data-provider.h>
+#include <dali/internal/render/gl-resources/gl-resource-owner.h>
 #include <dali/internal/render/renderers/render-geometry.h>
+#include <dali/internal/update/manager/prepare-render-instructions.h>
+#include <dali/integration-api/debug.h>
 
 namespace Dali
 {
@@ -53,7 +53,6 @@ class NodeDataProvider;
 
 namespace Render
 {
-class UniformNameCache;
 
 /**
  * Renderers are used to render meshes
@@ -65,6 +64,35 @@ class Renderer : public GlResourceOwner
 public:
 
   /**
+   * @brief Struct to encapsulate stencil parameters required for control of the stencil buffer.
+   */
+  struct StencilParameters
+  {
+    StencilParameters( RenderMode::Type renderMode, StencilFunction::Type stencilFunction, int stencilFunctionMask,
+                       int stencilFunctionReference, int stencilMask, StencilOperation::Type stencilOperationOnFail,
+                       StencilOperation::Type stencilOperationOnZFail, StencilOperation::Type stencilOperationOnZPass )
+    : stencilFunctionMask      ( stencilFunctionMask      ),
+      stencilFunctionReference ( stencilFunctionReference ),
+      stencilMask              ( stencilMask              ),
+      renderMode               ( renderMode               ),
+      stencilFunction          ( stencilFunction          ),
+      stencilOperationOnFail   ( stencilOperationOnFail   ),
+      stencilOperationOnZFail  ( stencilOperationOnZFail  ),
+      stencilOperationOnZPass  ( stencilOperationOnZPass  )
+    {
+    }
+
+    int stencilFunctionMask;                          ///< The stencil function mask
+    int stencilFunctionReference;                     ///< The stencil function reference
+    int stencilMask;                                  ///< The stencil mask
+    RenderMode::Type       renderMode:3;              ///< The render mode
+    StencilFunction::Type  stencilFunction:3;         ///< The stencil function
+    StencilOperation::Type stencilOperationOnFail:3;  ///< The stencil operation for stencil test fail
+    StencilOperation::Type stencilOperationOnZFail:3; ///< The stencil operation for depth test fail
+    StencilOperation::Type stencilOperationOnZPass:3; ///< The stencil operation for depth test pass
+  };
+
+  /**
    * @copydoc Dali::Internal::GlResourceOwner::GlContextDestroyed()
    */
   void GlContextDestroyed();
@@ -85,6 +113,7 @@ public:
    * @param[in] depthWriteMode Depth buffer write mode
    * @param[in] depthTestMode Depth buffer test mode
    * @param[in] depthFunction Depth function
+   * @param[in] stencilParameters Struct containing all stencil related options
    */
   static Renderer* New( SceneGraph::RenderDataProvider* dataProviders,
                         Render::Geometry* geometry,
@@ -94,7 +123,8 @@ public:
                         bool preMultipliedAlphaEnabled,
                         DepthWriteMode::Type depthWriteMode,
                         DepthTestMode::Type depthTestMode,
-                        DepthFunction::Type depthFunction );
+                        DepthFunction::Type depthFunction,
+                        StencilParameters& stencilParameters );
 
   /**
    * Constructor.
@@ -107,6 +137,7 @@ public:
    * @param[in] depthWriteMode Depth buffer write mode
    * @param[in] depthTestMode Depth buffer test mode
    * @param[in] depthFunction Depth function
+   * @param[in] stencilParameters Struct containing all stencil related options
    */
   Renderer( SceneGraph::RenderDataProvider* dataProviders,
             Render::Geometry* geometry,
@@ -116,7 +147,8 @@ public:
             bool preMultipliedAlphaEnabled,
             DepthWriteMode::Type depthWriteMode,
             DepthTestMode::Type depthTestMode,
-            DepthFunction::Type depthFunction );
+            DepthFunction::Type depthFunction,
+            StencilParameters& stencilParameters );
 
   /**
    * Change the data providers of the renderer
@@ -132,11 +164,10 @@ public:
   /**
    * Second-phase construction.
    * This is called when the renderer is inside render thread
-   * @param[in] context to use
-   * @param[in] textureCache to use
-   * @param[in] uniformNameCache to use
+   * @param[in] context Context used by the renderer
+   * @param[in] textureCache The texture cache to use
    */
-  void Initialize( Context& context, SceneGraph::TextureCache& textureCache, Render::UniformNameCache& uniformNameCache );
+  void Initialize( Context& context, SceneGraph::TextureCache& textureCache );
 
   /**
    * Destructor
@@ -217,6 +248,102 @@ public:
   DepthFunction::Type GetDepthFunction() const;
 
   /**
+   * Sets the render mode
+   * @param[in] renderMode The render mode
+   */
+  void SetRenderMode( RenderMode::Type mode );
+
+  /**
+   * Gets the render mode
+   * @return The render mode
+   */
+  RenderMode::Type GetRenderMode() const;
+
+  /**
+   * Sets the stencil function
+   * @param[in] stencilFunction The stencil function
+   */
+  void SetStencilFunction( StencilFunction::Type stencilFunction );
+
+  /**
+   * Gets the stencil function
+   * @return The stencil function
+   */
+  StencilFunction::Type GetStencilFunction() const;
+
+  /**
+   * Sets the stencil function mask
+   * @param[in] stencilFunctionMask The stencil function mask
+   */
+  void SetStencilFunctionMask( int stencilFunctionMask );
+
+  /**
+   * Gets the stencil function mask
+   * @return The stencil function mask
+   */
+  int GetStencilFunctionMask() const;
+
+  /**
+   * Sets the stencil function reference
+   * @param[in] stencilFunctionReference The stencil function reference
+   */
+  void SetStencilFunctionReference( int stencilFunctionReference );
+
+  /**
+   * Gets the stencil function reference
+   * @return The stencil function reference
+   */
+  int GetStencilFunctionReference() const;
+
+  /**
+   * Sets the stencil mask
+   * @param[in] stencilMask The stencil mask
+   */
+  void SetStencilMask( int stencilMask );
+
+  /**
+   * Gets the stencil mask
+   * @return The stencil mask
+   */
+  int GetStencilMask() const;
+
+  /**
+   * Sets the stencil operation for when the stencil test fails
+   * @param[in] stencilOperationOnFail The stencil operation
+   */
+  void SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail );
+
+  /**
+   * Gets the stencil operation for when the stencil test fails
+   * @return The stencil operation
+   */
+  StencilOperation::Type GetStencilOperationOnFail() const;
+
+  /**
+   * Sets the stencil operation for when the depth test fails
+   * @param[in] stencilOperationOnZFail The stencil operation
+   */
+  void SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail );
+
+  /**
+   * Gets the stencil operation for when the depth test fails
+   * @return The stencil operation
+   */
+  StencilOperation::Type GetStencilOperationOnZFail() const;
+
+  /**
+   * Sets the stencil operation for when the depth test passes
+   * @param[in] stencilOperationOnZPass The stencil operation
+   */
+  void SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass );
+
+  /**
+   * Gets the stencil operation for when the depth test passes
+   * @return The stencil operation
+   */
+  StencilOperation::Type GetStencilOperationOnZPass() const;
+
+  /**
    * Called to render during RenderManager::Render().
    * @param[in] context The context used for rendering
    * @param[in] textureCache The texture cache used to get textures
@@ -294,34 +421,33 @@ private:
 
   OwnerPointer< SceneGraph::RenderDataProvider > mRenderDataProvider;
 
-  Context* mContext;
-  SceneGraph::TextureCache* mTextureCache;
-  Render::UniformNameCache* mUniformNameCache;
-  Render::Geometry* mGeometry;
+  Context*                     mContext;
+  SceneGraph::TextureCache*    mTextureCache;
+  Render::Geometry*            mGeometry;
 
   struct UniformIndexMap
   {
-    unsigned int uniformIndex; // The index of the cached location in the Program
-    const PropertyInputImpl* propertyValue;
+    unsigned int               uniformIndex;  ///< The index of the cached location in the Program
+    const PropertyInputImpl*   propertyValue;
   };
 
   typedef Dali::Vector< UniformIndexMap > UniformIndexMappings;
-  UniformIndexMappings mUniformIndexMap;
-
-  Vector<GLint> mAttributesLocation;
-
-  BlendingOptions       mBlendingOptions; /// Blending options including blend color, blend func and blend equation
-  FaceCullingMode::Type mFaceCullingMode; /// Mode of face culling
-  DepthFunction::Type   mDepthFunction;   /// Depth function
-
-  size_t mIndexedDrawFirstElement;        /// Offset of first element to draw
-  size_t mIndexedDrawElementsCount;       /// Number of elements to draw
-
-  DepthWriteMode::Type mDepthWriteMode:2; /// Depth write mode
-  DepthTestMode::Type mDepthTestMode:2;   /// Depth test mode
-
-  bool mUpdateAttributesLocation:1;       ///< Indicates attribute locations have changed
-  bool mPremultipledAlphaEnabled:1;       ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
+  UniformIndexMappings         mUniformIndexMap;
+  Vector<GLint>                mAttributesLocation;
+
+  StencilParameters            mStencilParameters;          ///< Struct containing all stencil related options
+  BlendingOptions              mBlendingOptions;            ///< Blending options including blend color, blend func and blend equation
+
+  size_t                       mIndexedDrawFirstElement;    ///< Offset of first element to draw
+  size_t                       mIndexedDrawElementsCount;   ///< Number of elements to draw
+
+  DepthFunction::Type          mDepthFunction:3;            ///< The depth function
+  FaceCullingMode::Type        mFaceCullingMode:2;          ///< The mode of face culling
+  BlendMode::Type              mBlendMode:2;                ///< The mode of blending
+  DepthWriteMode::Type         mDepthWriteMode:2;           ///< The depth write mode
+  DepthTestMode::Type          mDepthTestMode:2;            ///< The depth test mode
+  bool                         mUpdateAttributesLocation:1; ///< Indicates attribute locations have changed
+  bool                         mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
 };
 
 } // namespace SceneGraph
@@ -330,4 +456,4 @@ private:
 
 } // namespace Dali
 
-#endif // __DALI_INTERNAL_RENDER_RENDERER_H__
+#endif // DALI_INTERNAL_RENDER_RENDERER_H