dali/internal/event/rendering/renderer-impl.h

   1 #ifndef DALI_INTERNAL_RENDERER_H
   2 #define DALI_INTERNAL_RENDERER_H
   3
   4 /*
   5  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h> // DALI_ASSERT_ALWAYS
  23 #include <dali/public-api/common/intrusive-ptr.h> // Dali::IntrusivePtr
  24 #include <dali/public-api/rendering/renderer.h> // Dali::Renderer
  25 #include <dali/internal/common/blending-options.h>
  26 #include <dali/internal/event/common/object-connector.h> // Dali::Internal::ObjectConnector
  27 #include <dali/internal/event/common/object-impl.h> // Dali::Internal::Object
  28 #include <dali/internal/event/rendering/texture-set-impl.h> // Dali::Internal::TextureSet
  29 #include <dali/internal/event/rendering/geometry-impl.h> // Dali::Internal::Geometry
  30 #include <dali/internal/render/renderers/render-renderer.h> // Dali::Render::Renderer::StencilParameters
  31
  32 namespace Dali
  33 {
  34 namespace Internal
  35 {
  36 namespace SceneGraph
  37 {
  38 class Renderer;
  39 }
  40
  41 class Renderer;
  42 typedef IntrusivePtr<Renderer> RendererPtr;
  43
  44 /**
  45  * Renderer is an object that can be used to show content by combining a Geometry with a shader and textures.
  46  */
  47 class Renderer : public Object
  48 {
  49 public:
  50
  51   /**
  52    * Create a new Renderer.
  53    * @return A smart-pointer to the newly allocated Renderer.
  54    */
  55   static RendererPtr New();
  56
  57   /**
  58    * @copydoc Dali::Renderer::SetGeometry()
  59    */
  60   void SetGeometry( Geometry& geometry );
  61
  62   /**
  63    * @copydoc Dali::Renderer::GetGeometry()
  64    */
  65   Geometry* GetGeometry() const;
  66
  67   /**
  68    * @copydoc Dali::Renderer::SetTextures()
  69    */
  70   void SetTextures( TextureSet& textureSet );
  71
  72   /**
  73    * @copydoc Dali::Renderer::GetTextures()
  74    */
  75   TextureSet* GetTextures() const;
  76
  77   /**
  78    * @copydoc Dali::Renderer::SetShader()
  79    */
  80   void SetShader( Shader& shader );
  81
  82   /**
  83    * @copydoc Dali::Renderer::GetShader()
  84    */
  85   Shader* GetShader() const;
  86
  87   /**
  88    * @copydoc Dali::Renderer::SetDepthIndex()
  89    */
  90   void SetDepthIndex( int depthIndex );
  91
  92   /**
  93    * @copydoc Dali::Renderer::GetDepthIndex()
  94    */
  95   int GetDepthIndex() const;
  96
  97    /**
  98     * @copydoc Dali::Renderer::SetBlendMode()
  99     */
 100    void SetBlendMode( BlendMode::Type mode );
 101
 102    /**
 103     * @copydoc Dali::Renderer::GetBlendMode()
 104     */
 105    BlendMode::Type GetBlendMode() const;
 106
 107    /**
 108     * @copydoc Dali::Renderer::SetBlendFunc()
 109     */
 110    void SetBlendFunc( BlendFactor::Type srcFactorRgba, BlendFactor::Type destFactorRgba );
 111
 112    /**
 113     * @copydoc Dali::Renderer::SetBlendFunc()
 114     */
 115    void SetBlendFunc( BlendFactor::Type srcFactorRgb,   BlendFactor::Type destFactorRgb,
 116                       BlendFactor::Type srcFactorAlpha, BlendFactor::Type destFactorAlpha );
 117
 118    /**
 119     * @copydoc Dali::Renderer::GetBlendFunc()
 120     */
 121    void GetBlendFunc( BlendFactor::Type& srcFactorRgb,   BlendFactor::Type& destFactorRgb,
 122                       BlendFactor::Type& srcFactorAlpha, BlendFactor::Type& destFactorAlpha ) const;
 123
 124    /**
 125     * @copydoc Dali::Renderer::SetBlendEquation()
 126     */
 127    void SetBlendEquation( BlendEquation::Type equationRgba );
 128
 129    /**
 130     * @copydoc Dali::Renderer::SetBlendEquation()
 131     */
 132    void SetBlendEquation( BlendEquation::Type equationRgb, BlendEquation::Type equationAlpha );
 133
 134    /**
 135     * @copydoc Dali::Renderer::GetBlendEquation()
 136     */
 137    void GetBlendEquation( BlendEquation::Type& equationRgb, BlendEquation::Type& equationAlpha ) const;
 138
 139    /**
 140     * @copydoc Dali::Renderer::SetBlendColor()
 141     */
 142    void SetBlendColor( const Vector4& color );
 143
 144    /**
 145     * @copydoc Dali::Renderer::GetBlendColor()
 146     */
 147    Vector4 GetBlendColor() const;
 148
 149    /**
 150     * @copydoc Dali::Renderer::SetIndexedDrawFirstElement
 151     */
 152    void SetIndexedDrawFirstElement( size_t firstElement );
 153
 154    /**
 155     * @copydoc Dali::Renderer::SetIndexedDrawElementsCount
 156     */
 157    void SetIndexedDrawElementsCount( size_t elementsCount );
 158
 159    /**
 160     * @brief Set whether the Pre-multiplied Alpha Blending is required
 161     *
 162     * @param[in] preMultipled whether alpha is pre-multiplied.
 163     */
 164    void EnablePreMultipliedAlpha( bool preMultipled );
 165
 166    /**
 167     * @brief Query whether alpha is pre-multiplied.
 168     *
 169     * @return True is alpha is pre-multiplied, false otherwise.
 170     */
 171    bool IsPreMultipliedAlphaEnabled() const;
 172
 173    /**
 174     * Returns state of batching mode
 175     * @return batching mode state ( true if enabled )
 176     */
 177    bool IsBatchingEnabled() const;
 178
 179    /**
 180     * @brief Get the scene graph object
 181     *
 182     * @return the scene object
 183     */
 184    SceneGraph::Renderer* GetRendererSceneObject();
 185
 186 public: // Default property extensions from Object
 187
 188   /**
 189    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
 190    */
 191   virtual unsigned int GetDefaultPropertyCount() const;
 192
 193   /**
 194    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
 195    */
 196   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
 197
 198   /**
 199    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
 200    */
 201   virtual const char* GetDefaultPropertyName(Property::Index index) const;
 202
 203   /**
 204    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
 205    */
 206   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
 207
 208   /**
 209    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
 210    */
 211   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
 212
 213   /**
 214    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
 215    */
 216   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
 217
 218   /**
 219    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
 220    */
 221   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
 222
 223   /**
 224    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
 225    */
 226   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
 227
 228   /**
 229    * @copydoc Dali::Internal::Object::SetDefaultProperty()
 230    */
 231   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
 232
 233   /**
 234    * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
 235    */
 236   virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
 237
 238   /**
 239    * @copydoc Dali::Internal::Object::GetDefaultProperty()
 240    */
 241   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 242
 243   /**
 244    * @copydoc Dali::Internal::Object::GetPropertyOwner()
 245    */
 246   virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
 247
 248   /**
 249    * @copydoc Dali::Internal::Object::GetSceneObject()
 250    */
 251   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
 252
 253   /**
 254    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
 255    */
 256   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
 257
 258   /**
 259    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
 260    */
 261   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
 262
 263   /**
 264    * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
 265    */
 266   virtual int GetPropertyComponentIndex( Property::Index index ) const;
 267
 268 private: // implementation
 269   Renderer();
 270
 271   void Initialize();
 272
 273 protected:
 274   /**
 275    * A reference counted object may only be deleted by calling Unreference()
 276    */
 277   virtual ~Renderer();
 278
 279 private: // unimplemented methods
 280   Renderer( const Renderer& );
 281   Renderer& operator=( const Renderer& );
 282
 283 private: // data
 284   SceneGraph::Renderer* mSceneObject;
 285   Vector4* mBlendColor;               ///< Local copy of blend color, pointer only as its rarely used
 286   GeometryPtr mGeometry;              ///< Connector that holds the geometry used by this renderer
 287   TextureSetPtr mTextureSet;          ///< Connector that holds the texture set used by this renderer
 288   ShaderPtr mShader;                  ///< Connector that holds the shader used by this renderer
 289
 290   int mDepthIndex;
 291
 292   size_t mIndexedDrawFirstElement;                            ///< Offset of first element to draw from bound index buffer
 293   size_t mIndexedDrawElementCount;                            ///< Number of elements to draw
 294
 295   Render::Renderer::StencilParameters mStencilParameters;     ///< Struct containing all stencil related options
 296   BlendingOptions              mBlendingOptions;              ///< Local copy of blending options bitmask
 297
 298   DepthFunction::Type          mDepthFunction:3;              ///< Local copy of the depth function
 299   FaceCullingMode::Type        mFaceCullingMode:2;            ///< Local copy of the mode of face culling
 300   BlendMode::Type              mBlendMode:2;                  ///< Local copy of the mode of blending
 301   DepthWriteMode::Type         mDepthWriteMode:2;             ///< Local copy of the depth write mode
 302   DepthTestMode::Type          mDepthTestMode:2;              ///< Local copy of the depth test mode
 303   bool                         mPremultipledAlphaEnabled:1;   ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
 304   bool                         mBatchingEnabled : 1;          ///< Flag indicating whether render is batchable or not
 305 };
 306
 307 } // namespace Internal
 308
 309 // Helpers for public-api forwarding methods
 310 inline Internal::Renderer& GetImplementation( Dali::Renderer& handle )
 311 {
 312   DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
 313
 314   BaseObject& object = handle.GetBaseObject();
 315
 316   return static_cast<Internal::Renderer&>(object);
 317 }
 318
 319 inline const Internal::Renderer& GetImplementation( const Dali::Renderer& handle )
 320 {
 321   DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
 322
 323   const BaseObject& object = handle.GetBaseObject();
 324
 325   return static_cast<const Internal::Renderer&>(object);
 326 }
 327
 328 } // namespace Dali
 329
 330 #endif // DALI_INTERNAL_RENDERER_H