optional/dali-toolkit/internal/controls/gaussian-blur-view/gaussian-blur-view-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_GAUSSIAN_BLUR_EFFECT_H__
   2 #define __DALI_TOOLKIT_INTERNAL_GAUSSIAN_BLUR_EFFECT_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 <sstream>
  23 #include <cmath>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/dali.h>
  27 #include <dali-toolkit/public-api/controls/control-impl.h>
  28 #include <dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 class GaussianBlurView;
  37
  38 namespace Internal
  39 {
  40
  41 /**
  42  * GaussianBlurView implementation class
  43  */
  44 class GaussianBlurView : public Control
  45 {
  46 public:
  47
  48   /**
  49    * @copydoc Dali::Toolkit::GaussianBlurView::GaussianBlurView
  50    */
  51   GaussianBlurView();
  52
  53   /**
  54    * @copydoc Dali::Toolkit::GaussianBlurView::GaussianBlurView
  55    */
  56   GaussianBlurView(const unsigned int numSamples, const float blurBellCurveWidth, const Pixel::Format renderTargetPixelFormat,
  57                    const float downsampleWidthScale, const float downsampleHeightScale,
  58                    bool blurUserImage);
  59
  60   /**
  61    * @copydoc Dali::Toolkit::GaussianBlurView::~GaussianBlurView
  62    */
  63   virtual ~GaussianBlurView();
  64
  65   /**
  66    * @copydoc Dali::Toolkit::GaussianBlurView::New
  67    */
  68   static Dali::Toolkit::GaussianBlurView New();
  69   static Dali::Toolkit::GaussianBlurView New( const unsigned int numSamples, const float blurBellCurveWidth, const Pixel::Format renderTargetPixelFormat,
  70                                               const float downsampleWidthScale, const float downsampleHeightScale,
  71                                               bool blurUserImage);
  72
  73   void Add(Actor child);
  74   void Remove(Actor child);
  75
  76   void Activate();
  77   void ActivateOnce();
  78   void Deactivate();
  79
  80   void SetUserImageAndOutputRenderTarget(Image inputImage, FrameBufferImage outputRenderTarget);
  81
  82   Property::Index GetBlurStrengthPropertyIndex() const {return mBlurStrengthPropertyIndex;}
  83   FrameBufferImage GetBlurredRenderTarget() const;
  84
  85   /// @copydoc Dali::Toolkit::GaussianBlurView::SetBackgroundColor(const Vector4&)
  86   void SetBackgroundColor( const Vector4& color );
  87
  88   /// @copydoc Dali::Toolkit::GaussianBlurView::GetBackgroundColor
  89   Vector4 GetBackgroundColor() const;
  90
  91   void AllocateResources();
  92   void CreateRenderTasks();
  93   void RemoveRenderTasks();
  94   Dali::Toolkit::GaussianBlurView::GaussianBlurViewSignal& FinishedSignal();
  95
  96 private:
  97
  98   virtual void OnInitialize();
  99   virtual void OnControlSizeSet(const Vector3& targetSize);
 100   virtual void OnStageDisconnection();
 101
 102   virtual void OnControlStageConnection();
 103
 104   void SetBlurBellCurveWidth(float blurBellCurveWidth);
 105   float CalcGaussianWeight(float x);
 106   void SetShaderConstants();
 107   std::string GetSampleOffsetsPropertyName( unsigned int index ) const;
 108   std::string GetSampleWeightsPropertyName( unsigned int index ) const;
 109
 110   void OnRenderTaskFinished(Dali::RenderTask& renderTask);
 111
 112   /////////////////////////////////////////////////////////////
 113   unsigned int mNumSamples;       // number of blur samples in each of horiz/vert directions
 114   float mBlurBellCurveWidth;      // constant used when calculating the gaussian weights
 115   Pixel::Format mPixelFormat;     // pixel format used by render targets
 116
 117   /////////////////////////////////////////////////////////////
 118   // downsampling is used for the separated blur passes to get increased blur with the same number of samples and also to make rendering quicker
 119   float mDownsampleWidthScale;
 120   float mDownsampleHeightScale;
 121   float mDownsampledWidth;
 122   float mDownsampledHeight;
 123
 124   /////////////////////////////////////////////////////////////
 125   // if this is set to true, we blur a user supplied image rather than rendering and blurring children
 126   bool mBlurUserImage:1;
 127
 128   /////////////////////////////////////////////////////////////
 129   // if this is set to true, set the render tasks to refresh once
 130   bool mRenderOnce:1;
 131
 132   /////////////////////////////////////////////////////////////
 133   // background fill color
 134   Vector4 mBackgroundColor;
 135
 136   /////////////////////////////////////////////////////////////
 137   // for checking if we need to reallocate render targets
 138   Vector2 mTargetSize;
 139   Vector2 mLastSize;
 140
 141   /////////////////////////////////////////////////////////////
 142   // for creating a subtree for all user added child actors, so that we can have them exclusive to the mRenderChildrenTask and our other actors exclusive to our other tasks
 143   Actor mChildrenRoot;
 144
 145   /////////////////////////////////////////////////////////////
 146   // for mapping offscreen renders to render target sizes
 147   CameraActor mRenderFullSizeCamera;
 148   CameraActor mRenderDownsampledCamera;
 149
 150   /////////////////////////////////////////////////////////////
 151   // for rendering all user added children to offscreen target
 152   FrameBufferImage mRenderTargetForRenderingChildren;
 153   RenderTask mRenderChildrenTask;
 154
 155   /////////////////////////////////////////////////////////////
 156   // for rendering separated blur passes to offscreen targets
 157   FrameBufferImage mRenderTarget1;
 158   FrameBufferImage mRenderTarget2;
 159
 160   ShaderEffect mHorizBlurShader;
 161   ShaderEffect mVertBlurShader;
 162
 163   ImageActor mImageActorHorizBlur;
 164   ImageActor mImageActorVertBlur;
 165
 166   RenderTask mHorizBlurTask;
 167   RenderTask mVertBlurTask;
 168
 169   /////////////////////////////////////////////////////////////
 170   // for compositing blur and children renders to offscreen target
 171   ImageActor mImageActorComposite;
 172   RenderTask mCompositeTask;
 173
 174   /////////////////////////////////////////////////////////////
 175   // for holding blurred result
 176   ImageActor mTargetActor;
 177
 178   /////////////////////////////////////////////////////////////
 179   // for animating fade in / out of blur, hiding internal implementation but allowing user to set via GaussianBlurView interface
 180   Property::Index mBlurStrengthPropertyIndex;
 181
 182   /////////////////////////////////////////////////////////////
 183   // User can specify image to blur and output target, so we can use GaussianBlurView for arbitrary blur processes
 184   Image mUserInputImage;
 185   FrameBufferImage mUserOutputRenderTarget;
 186
 187   Dali::Toolkit::GaussianBlurView::GaussianBlurViewSignal mFinishedSignal; ///< Signal emitted when blur has completed.
 188 private:
 189
 190   // Undefined copy constructor.
 191   GaussianBlurView( const GaussianBlurView& );
 192
 193   // Undefined assignment operator.
 194   GaussianBlurView& operator=( const GaussianBlurView& );
 195 };
 196
 197 } // namespace Internal
 198
 199
 200 // Helpers for public-api forwarding methods
 201 inline Toolkit::Internal::GaussianBlurView& GetImpl( Toolkit::GaussianBlurView& obj )
 202 {
 203   DALI_ASSERT_ALWAYS(obj);
 204   Dali::RefObject& handle = obj.GetImplementation();
 205   return static_cast<Toolkit::Internal::GaussianBlurView&>(handle);
 206 }
 207
 208 inline const Toolkit::Internal::GaussianBlurView& GetImpl( const Toolkit::GaussianBlurView& obj )
 209 {
 210   DALI_ASSERT_ALWAYS(obj);
 211   const Dali::RefObject& handle = obj.GetImplementation();
 212   return static_cast<const Toolkit::Internal::GaussianBlurView&>(handle);
 213 }
 214
 215
 216 } // namespace Toolkit
 217
 218 } // namespace Dali
 219
 220 #endif // __DALI_TOOLKIT_INTERNAL_GAUSSIAN_BLUR_EFFECT_H__