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

   1 #ifndef DALI_INTERNAL_RENDERER_H
   2 #define DALI_INTERNAL_RENDERER_H
   3
   4 /*
   5  * Copyright (c) 2018 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::SetIndexedDrawFirstElement
 141     */
 142    void SetIndexedDrawFirstElement( size_t firstElement );
 143
 144    /**
 145     * @copydoc Dali::Renderer::SetIndexedDrawElementsCount
 146     */
 147    void SetIndexedDrawElementsCount( size_t elementsCount );
 148
 149    /**
 150     * @brief Set whether the Pre-multiplied Alpha Blending is required
 151     *
 152     * @param[in] preMultipled whether alpha is pre-multiplied.
 153     */
 154    void EnablePreMultipliedAlpha( bool preMultipled );
 155
 156    /**
 157     * @brief Query whether alpha is pre-multiplied.
 158     *
 159     * @return True is alpha is pre-multiplied, false otherwise.
 160     */
 161    bool IsPreMultipliedAlphaEnabled() const;
 162
 163    /**
 164     * @brief Get the scene graph object
 165     *
 166     * @return the scene object
 167     */
 168    SceneGraph::Renderer* GetRendererSceneObject();
 169
 170 public: // Default property extensions from Object
 171
 172   /**
 173    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
 174    */
 175   virtual unsigned int GetDefaultPropertyCount() const;
 176
 177   /**
 178    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
 179    */
 180   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
 181
 182   /**
 183    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
 184    */
 185   virtual const char* GetDefaultPropertyName(Property::Index index) const;
 186
 187   /**
 188    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
 189    */
 190   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
 191
 192   /**
 193    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
 194    */
 195   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
 196
 197   /**
 198    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
 199    */
 200   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
 201
 202   /**
 203    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
 204    */
 205   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
 206
 207   /**
 208    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
 209    */
 210   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
 211
 212   /**
 213    * @copydoc Dali::Internal::Object::SetDefaultProperty()
 214    */
 215   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
 216
 217   /**
 218    * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
 219    */
 220   virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
 221
 222   /**
 223    * @copydoc Dali::Internal::Object::GetDefaultProperty()
 224    */
 225   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 226
 227   /**
 228    * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue()
 229    */
 230   virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const;
 231
 232    /**
 233     * @copydoc Dali::Internal::Object::OnNotifyDefaultPropertyAnimation()
 234     */
 235    virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType );
 236
 237   /**
 238    * @copydoc Dali::Internal::Object::GetPropertyOwner()
 239    */
 240   virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
 241
 242   /**
 243    * @copydoc Dali::Internal::Object::GetSceneObject()
 244    */
 245   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
 246
 247   /**
 248    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
 249    */
 250   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
 251
 252   /**
 253    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
 254    */
 255   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
 256
 257   /**
 258    * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
 259    */
 260   virtual int GetPropertyComponentIndex( Property::Index index ) const;
 261
 262 private: // implementation
 263
 264   /**
 265    * @brief Default constructor.
 266    */
 267   Renderer();
 268
 269   /**
 270    * @brief Initializes the Renderer.
 271    */
 272   void Initialize();
 273
 274   /**
 275    * @brief Sets the blend color.
 276    * @param[in] blendColor The blend color to set.
 277    */
 278   void SetBlendColor( const Vector4& blendColor );
 279
 280   /**
 281    * @brief Retrieves the blend-color.
 282    * @return A const reference to the blend-color
 283    */
 284   const Vector4& GetBlendColor() const;
 285
 286   /**
 287    * @brief Retrieves the cached event side value of a default property.
 288    * @param[in]  index  The index of the property
 289    * @param[out] value  Is set with the cached value of the property if found.
 290    * @return True if value set, false otherwise.
 291    */
 292   bool GetCachedPropertyValue( Property::Index index, Property::Value& value ) const;
 293
 294   /**
 295    * @brief Retrieves the current value of a default property from the scene-graph.
 296    * @param[in]  index  The index of the property
 297    * @param[out] value  Is set with the current scene-graph value of the property
 298    * @return True if value set, false otherwise.
 299    */
 300   bool GetCurrentPropertyValue( Property::Index index, Property::Value& value  ) const;
 301
 302 protected:
 303   /**
 304    * A reference counted object may only be deleted by calling Unreference()
 305    */
 306   virtual ~Renderer();
 307
 308 private: // unimplemented methods
 309   Renderer( const Renderer& );
 310   Renderer& operator=( const Renderer& );
 311
 312 private: // data
 313   SceneGraph::Renderer*               mSceneObject;
 314   GeometryPtr                         mGeometry;                     ///< Connector that holds the geometry used by this renderer
 315   TextureSetPtr                       mTextureSet;                   ///< Connector that holds the texture set used by this renderer
 316   ShaderPtr                           mShader;                       ///< Connector that holds the shader used by this renderer
 317
 318   int                                 mDepthIndex;
 319
 320   size_t                              mIndexedDrawFirstElement;      ///< Offset of first element to draw from bound index buffer
 321   size_t                              mIndexedDrawElementCount;      ///< Number of elements to draw
 322
 323   Render::Renderer::StencilParameters mStencilParameters;            ///< Struct containing all stencil related options
 324   BlendingOptions                     mBlendingOptions;              ///< Local copy of blending options bitmask
 325   float                               mOpacity;                      ///< Local copy of the opacity
 326   DepthFunction::Type                 mDepthFunction:4;              ///< Local copy of the depth function
 327   FaceCullingMode::Type               mFaceCullingMode:3;            ///< Local copy of the mode of face culling
 328   BlendMode::Type                     mBlendMode:3;                  ///< Local copy of the mode of blending
 329   DepthWriteMode::Type                mDepthWriteMode:3;             ///< Local copy of the depth write mode
 330   DepthTestMode::Type                 mDepthTestMode:3;              ///< Local copy of the depth test mode
 331   bool                                mPremultipledAlphaEnabled:1;   ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
 332 };
 333
 334 } // namespace Internal
 335
 336 // Helpers for public-api forwarding methods
 337 inline Internal::Renderer& GetImplementation( Dali::Renderer& handle )
 338 {
 339   DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
 340
 341   BaseObject& object = handle.GetBaseObject();
 342
 343   return static_cast<Internal::Renderer&>(object);
 344 }
 345
 346 inline const Internal::Renderer& GetImplementation( const Dali::Renderer& handle )
 347 {
 348   DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
 349
 350   const BaseObject& object = handle.GetBaseObject();
 351
 352   return static_cast<const Internal::Renderer&>(object);
 353 }
 354
 355 } // namespace Dali
 356
 357 #endif // DALI_INTERNAL_RENDERER_H