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);
102 * @copydoc Control::OnControlChildAdd()
104 virtual void OnControlChildAdd( Actor& child );
107 * @copydoc Control::OnControlChildRemove()
109 virtual void OnControlChildRemove( Actor& child );
111 void SetBlurBellCurveWidth(float blurBellCurveWidth);
112 float CalcGaussianWeight(float x);
113 void SetShaderConstants();
114 std::string GetSampleOffsetsPropertyName( unsigned int index ) const;
115 std::string GetSampleWeightsPropertyName( unsigned int index ) const;
117 void OnRenderTaskFinished(Dali::RenderTask& renderTask);
119 /////////////////////////////////////////////////////////////
120 unsigned int mNumSamples; // number of blur samples in each of horiz/vert directions
121 float mBlurBellCurveWidth; // constant used when calculating the gaussian weights
122 Pixel::Format mPixelFormat; // pixel format used by render targets
124 /////////////////////////////////////////////////////////////
125 // downsampling is used for the separated blur passes to get increased blur with the same number of samples and also to make rendering quicker
126 float mDownsampleWidthScale;
127 float mDownsampleHeightScale;
128 float mDownsampledWidth;
129 float mDownsampledHeight;
131 /////////////////////////////////////////////////////////////
132 // if this is set to true, we blur a user supplied image rather than rendering and blurring children
133 bool mBlurUserImage:1;
135 /////////////////////////////////////////////////////////////
136 // if this is set to true, set the render tasks to refresh once
139 /////////////////////////////////////////////////////////////
140 // background fill color
141 Vector4 mBackgroundColor;
143 /////////////////////////////////////////////////////////////
144 // for checking if we need to reallocate render targets
148 /////////////////////////////////////////////////////////////
149 // 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
151 // for creating a subtree for the internal actors
154 /////////////////////////////////////////////////////////////
155 // for mapping offscreen renders to render target sizes
156 CameraActor mRenderFullSizeCamera;
157 CameraActor mRenderDownsampledCamera;
159 /////////////////////////////////////////////////////////////
160 // for rendering all user added children to offscreen target
161 FrameBufferImage mRenderTargetForRenderingChildren;
162 RenderTask mRenderChildrenTask;
164 /////////////////////////////////////////////////////////////
165 // for rendering separated blur passes to offscreen targets
166 FrameBufferImage mRenderTarget1;
167 FrameBufferImage mRenderTarget2;
169 Toolkit::ImageView mImageActorHorizBlur;
170 Toolkit::ImageView mImageActorVertBlur;
172 RenderTask mHorizBlurTask;
173 RenderTask mVertBlurTask;
175 /////////////////////////////////////////////////////////////
176 // for compositing blur and children renders to offscreen target
177 Toolkit::ImageView mImageActorComposite;
178 RenderTask mCompositeTask;
180 /////////////////////////////////////////////////////////////
181 // for holding blurred result
182 Toolkit::ImageView mTargetActor;
184 /////////////////////////////////////////////////////////////
185 // for animating fade in / out of blur, hiding internal implementation but allowing user to set via GaussianBlurView interface
186 Property::Index mBlurStrengthPropertyIndex;
188 /////////////////////////////////////////////////////////////
189 // User can specify image to blur and output target, so we can use GaussianBlurView for arbitrary blur processes
190 Image mUserInputImage;
191 FrameBufferImage mUserOutputRenderTarget;
193 Dali::Toolkit::GaussianBlurView::GaussianBlurViewSignal mFinishedSignal; ///< Signal emitted when blur has completed.
198 // Undefined copy constructor.
199 GaussianBlurView( const GaussianBlurView& );
201 // Undefined assignment operator.
202 GaussianBlurView& operator=( const GaussianBlurView& );
205 } // namespace Internal
208 // Helpers for public-api forwarding methods
209 inline Toolkit::Internal::GaussianBlurView& GetImpl( Toolkit::GaussianBlurView& obj )
211 DALI_ASSERT_ALWAYS(obj);
212 Dali::RefObject& handle = obj.GetImplementation();
213 return static_cast<Toolkit::Internal::GaussianBlurView&>(handle);
216 inline const Toolkit::Internal::GaussianBlurView& GetImpl( const Toolkit::GaussianBlurView& obj )
218 DALI_ASSERT_ALWAYS(obj);
219 const Dali::RefObject& handle = obj.GetImplementation();
220 return static_cast<const Toolkit::Internal::GaussianBlurView&>(handle);
224 } // namespace Toolkit
228 #endif // __DALI_TOOLKIT_INTERNAL_GAUSSIAN_BLUR_EFFECT_H__