dali/devel-api/adaptor-framework/canvas-renderer.h

   1 #ifndef DALI_CANVAS_RENDERER_H
   2 #define DALI_CANVAS_RENDERER_H
   3
   4 /*
   5  * Copyright (c) 2021 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_adaptor_framework
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 namespace Adaptor
  38 {
  39 class CanvasRenderer;
  40 }
  41 } // namespace DALI_INTERNAL
  42
  43 /**
  44  * @brief Used for rendering a vector primitives
  45  */
  46 class DALI_ADAPTOR_API CanvasRenderer : public BaseHandle
  47 {
  48 public:
  49   /**
  50    * @brief Creates an initialized handle to a new CanvasRenderer.
  51    * @param[in] viewBox The viewBox of canvas.
  52    * @return A handle to a newly allocated CanvasRenderer
  53    */
  54   static CanvasRenderer New(const Vector2& viewBox);
  55
  56 public:
  57   /**
  58    * @brief Creates an empty handle.
  59    * Use CanvasRenderer::New() to create an initialized object.
  60    */
  61   CanvasRenderer();
  62
  63   /**
  64    * @brief Destructor.
  65    */
  66   ~CanvasRenderer();
  67
  68 public:
  69   /**
  70    * @brief This copy constructor is required for (smart) pointer semantics.
  71    *
  72    * @param[in] handle A reference to the copied handle
  73    */
  74   CanvasRenderer(const CanvasRenderer& handle) = default;
  75
  76   /**
  77    * @brief This assignment operator is required for (smart) pointer semantics.
  78    *
  79    * @param[in] rhs A reference to the copied handle
  80    * @return A reference to this
  81    */
  82   CanvasRenderer& operator=(const CanvasRenderer& rhs) = default;
  83
  84 public:
  85   class Drawable;
  86   class Shape;
  87   class DrawableGroup;
  88   class Picture;
  89
  90   class Gradient;
  91   class LinearGradient;
  92   class RadialGradient;
  93
  94 public:
  95   /**
  96    * @brief Prepare for drawing drawables added to CanvasRenderer on inner canvas.
  97    * @return Returns True when it's successful. False otherwise.
  98    */
  99   bool Commit();
 100
 101   /**
 102    * @brief Add drawable object to the Canvas. This method is similar to registration.
 103    * The added drawable object(shape) is drawn on the inner canvas using @ref Commit().
 104    * @param[in] drawable The drawable object.
 105    * @return Returns True when it's successful. False otherwise.
 106    */
 107   bool AddDrawable(Drawable& drawable);
 108
 109   /**
 110    * @brief Remove drawable object to the CanvasView.
 111    * This method is similar to deregistration. Freeing memory is not concerned for drawables being removed.
 112    * @param[in] drawable the drawable object.
 113    * @return Returns True when it's successful. False otherwise.
 114    */
 115   bool RemoveDrawable(Drawable& drawable);
 116
 117   /**
 118    * @brief Remove all drawable objects added to the CanvasRenderer.
 119    * @return Returns True when it's successful. False otherwise.
 120    */
 121   bool RemoveAllDrawables();
 122
 123   /**
 124    * @brief Returns the PixelBuffer, which is the Render buffer of Canvas.
 125    *
 126    * @return Returns the pixel buffer.
 127    */
 128   Devel::PixelBuffer GetPixelBuffer();
 129
 130   /**
 131    * @brief Draw drawables added to CanvasRenderer to inner buffer.
 132    * @return Returns True when it's successful. False otherwise.
 133    */
 134   bool Rasterize();
 135
 136   /**
 137    * @brief Returns whether the drawables added to the Canvas are changed.
 138    * @return Returns True when drawables added to the Canvas are changed, False otherwise.
 139    */
 140   bool IsCanvasChanged() const;
 141
 142   /**
 143    * @brief This is the size of the buffer in the Canvas.
 144    * @param[in] size The size of canvas buffer.
 145    * @return Returns True when it's successful. False otherwise.
 146    */
 147   bool SetSize(const Vector2& size);
 148
 149   /**
 150    * @brief This is the size of the Buffer in the Canvas.
 151    * @return Returns The size of canvas buffer.
 152    */
 153   const Vector2& GetSize();
 154
 155   /**
 156    * @brief This is the viewbox of the Canvas.
 157    * @param[in] viewBox The size of viewbox.
 158    * @return Returns True when it's successful. False otherwise.
 159    */
 160   bool SetViewBox(const Vector2& viewBox);
 161
 162   /**
 163    * @brief This is the viewbox of the Canvas.
 164    * @return Returns The size of viewbox.
 165    */
 166   const Vector2& GetViewBox();
 167
 168 public: // Not intended for application developers
 169   /// @cond internal
 170   /**
 171    * @brief The constructor.
 172    * @note  Not intended for application developers.
 173    *
 174    * @param[in] pointer A pointer to a newly allocated CanvasRenderer
 175    */
 176   explicit DALI_INTERNAL CanvasRenderer(Internal::Adaptor::CanvasRenderer* internal);
 177   /// @endcond
 178 };
 179
 180 /**
 181  * @}
 182  */
 183 } // namespace Dali
 184
 185 #endif // DALI_CANVAS_RENDERER_H