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