1 #ifndef __DALI_TOOLKIT_INTERNAL_GAUSSIAN_BLUR_EFFECT_H__
2 #define __DALI_TOOLKIT_INTERNAL_GAUSSIAN_BLUR_EFFECT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
26 #include <dali-toolkit/public-api/controls/control-impl.h>
27 #include <dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h>
28 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
36 class GaussianBlurView;
42 * GaussianBlurView implementation class
44 class GaussianBlurView : public Control
49 * @copydoc Dali::Toolkit::GaussianBlurView::GaussianBlurView
54 * @copydoc Dali::Toolkit::GaussianBlurView::GaussianBlurView
56 GaussianBlurView(const unsigned int numSamples, const float blurBellCurveWidth, const Pixel::Format renderTargetPixelFormat,
57 const float downsampleWidthScale, const float downsampleHeightScale,
61 * @copydoc Dali::Toolkit::GaussianBlurView::~GaussianBlurView
63 virtual ~GaussianBlurView();
66 * @copydoc Dali::Toolkit::GaussianBlurView::New
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,
73 void Add(Actor child);
74 void Remove(Actor child);
80 void SetUserImageAndOutputRenderTarget(Image inputImage, FrameBufferImage outputRenderTarget);
82 Property::Index GetBlurStrengthPropertyIndex() const {return mBlurStrengthPropertyIndex;}
83 FrameBufferImage GetBlurredRenderTarget() const;
85 /// @copydoc Dali::Toolkit::GaussianBlurView::SetBackgroundColor(const Vector4&)
86 void SetBackgroundColor( const Vector4& color );
88 /// @copydoc Dali::Toolkit::GaussianBlurView::GetBackgroundColor
89 Vector4 GetBackgroundColor() const;
91 void AllocateResources();
92 void CreateRenderTasks();
93 void RemoveRenderTasks();
94 Dali::Toolkit::GaussianBlurView::GaussianBlurViewSignal& FinishedSignal();
98 virtual void OnInitialize();
99 virtual void OnSizeSet(const Vector3& targetSize);
101 void SetBlurBellCurveWidth(float blurBellCurveWidth);
102 float CalcGaussianWeight(float x);
103 void SetShaderConstants();
104 std::string GetSampleOffsetsPropertyName( unsigned int index ) const;
105 std::string GetSampleWeightsPropertyName( unsigned int index ) const;
107 void OnRenderTaskFinished(Dali::RenderTask& renderTask);
109 /////////////////////////////////////////////////////////////
110 unsigned int mNumSamples; // number of blur samples in each of horiz/vert directions
111 float mBlurBellCurveWidth; // constant used when calculating the gaussian weights
112 Pixel::Format mPixelFormat; // pixel format used by render targets
114 /////////////////////////////////////////////////////////////
115 // downsampling is used for the separated blur passes to get increased blur with the same number of samples and also to make rendering quicker
116 float mDownsampleWidthScale;
117 float mDownsampleHeightScale;
118 float mDownsampledWidth;
119 float mDownsampledHeight;
121 /////////////////////////////////////////////////////////////
122 // if this is set to true, we blur a user supplied image rather than rendering and blurring children
123 bool mBlurUserImage:1;
125 /////////////////////////////////////////////////////////////
126 // if this is set to true, set the render tasks to refresh once
129 /////////////////////////////////////////////////////////////
130 // background fill color
131 Vector4 mBackgroundColor;
133 /////////////////////////////////////////////////////////////
134 // for checking if we need to reallocate render targets
138 /////////////////////////////////////////////////////////////
139 // 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
142 /////////////////////////////////////////////////////////////
143 // for mapping offscreen renders to render target sizes
144 CameraActor mRenderFullSizeCamera;
145 CameraActor mRenderDownsampledCamera;
147 /////////////////////////////////////////////////////////////
148 // for rendering all user added children to offscreen target
149 FrameBufferImage mRenderTargetForRenderingChildren;
150 RenderTask mRenderChildrenTask;
152 /////////////////////////////////////////////////////////////
153 // for rendering separated blur passes to offscreen targets
154 FrameBufferImage mRenderTarget1;
155 FrameBufferImage mRenderTarget2;
157 Toolkit::ImageView mImageActorHorizBlur;
158 Toolkit::ImageView mImageActorVertBlur;
160 RenderTask mHorizBlurTask;
161 RenderTask mVertBlurTask;
163 /////////////////////////////////////////////////////////////
164 // for compositing blur and children renders to offscreen target
165 Toolkit::ImageView mImageActorComposite;
166 RenderTask mCompositeTask;
168 /////////////////////////////////////////////////////////////
169 // for holding blurred result
170 Toolkit::ImageView mTargetActor;
172 /////////////////////////////////////////////////////////////
173 // for animating fade in / out of blur, hiding internal implementation but allowing user to set via GaussianBlurView interface
174 Property::Index mBlurStrengthPropertyIndex;
176 /////////////////////////////////////////////////////////////
177 // User can specify image to blur and output target, so we can use GaussianBlurView for arbitrary blur processes
178 Image mUserInputImage;
179 FrameBufferImage mUserOutputRenderTarget;
181 Dali::Toolkit::GaussianBlurView::GaussianBlurViewSignal mFinishedSignal; ///< Signal emitted when blur has completed.
186 // Undefined copy constructor.
187 GaussianBlurView( const GaussianBlurView& );
189 // Undefined assignment operator.
190 GaussianBlurView& operator=( const GaussianBlurView& );
193 } // namespace Internal
196 // Helpers for public-api forwarding methods
197 inline Toolkit::Internal::GaussianBlurView& GetImpl( Toolkit::GaussianBlurView& obj )
199 DALI_ASSERT_ALWAYS(obj);
200 Dali::RefObject& handle = obj.GetImplementation();
201 return static_cast<Toolkit::Internal::GaussianBlurView&>(handle);
204 inline const Toolkit::Internal::GaussianBlurView& GetImpl( const Toolkit::GaussianBlurView& obj )
206 DALI_ASSERT_ALWAYS(obj);
207 const Dali::RefObject& handle = obj.GetImplementation();
208 return static_cast<const Toolkit::Internal::GaussianBlurView&>(handle);
212 } // namespace Toolkit
216 #endif // __DALI_TOOLKIT_INTERNAL_GAUSSIAN_BLUR_EFFECT_H__