1 #ifndef __DALI_TOOLKIT_INTERNAL_BLOOM_VIEW_H__
2 #define __DALI_TOOLKIT_INTERNAL_BLOOM_VIEW_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.
24 #include <dali/public-api/actors/camera-actor.h>
25 #include <dali/public-api/actors/image-actor.h>
26 #include <dali/public-api/render-tasks/render-task.h>
29 #include <dali-toolkit/public-api/controls/control-impl.h>
30 #include <dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h>
31 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
32 #include <dali-toolkit/devel-api/controls/bloom-view/bloom-view.h>
46 * BloomEffect implementation class
48 class BloomView : public Control
52 * @copydoc Dali::Toolkit::BloomView::BloomView
57 * @copydoc Dali::Toolkit::BloomView::BloomView
59 BloomView(const unsigned int numSamples, const float blurBellCurveWidth, const Pixel::Format renderTargetPixelFormat,
60 const float downsampleWidthScale, const float downsampleHeightScale);
63 * @copydoc Dali::Toolkit::BloomView::~BloomView
68 * @copydoc Dali::Toolkit::BloomView::New
70 static Dali::Toolkit::BloomView New();
71 static Dali::Toolkit::BloomView New( const unsigned int numSamples, const float blurBellCurveWidth, const Pixel::Format renderTargetPixelFormat,
72 const float downsampleWidthScale, const float downsampleHeightScale);
76 Property::Index GetBloomThresholdPropertyIndex() const {return mBloomThresholdPropertyIndex;}
77 Property::Index GetBlurStrengthPropertyIndex() const {return mBlurStrengthPropertyIndex;}
78 Property::Index GetBloomIntensityPropertyIndex() const {return mBloomIntensityPropertyIndex;}
79 Property::Index GetBloomSaturationPropertyIndex() const {return mBloomSaturationPropertyIndex;}
80 Property::Index GetImageIntensityPropertyIndex() const {return mImageIntensityPropertyIndex;}
81 Property::Index GetImageSaturationPropertyIndex() const {return mImageSaturationPropertyIndex;}
85 virtual void OnInitialize();
86 virtual void OnSizeSet(const Vector3& targetSize);
89 * @copydoc Control::OnControlChildAdd()
91 virtual void OnControlChildAdd( Actor& child );
94 * @copydoc Control::OnControlChildRemove()
96 virtual void OnControlChildRemove( Actor& child );
98 void AllocateResources();
99 void CreateRenderTasks();
100 void RemoveRenderTasks();
102 void SetupProperties();
105 /////////////////////////////////////////////////////////////
106 unsigned int mBlurNumSamples; // number of blur samples in each of horiz/vert directions
107 float mBlurBellCurveWidth; // constant used when calculating the gaussian weights
108 Pixel::Format mPixelFormat; // pixel format used by render targets
110 /////////////////////////////////////////////////////////////
111 // downsampling is used for the separated blur passes to get increased blur with the same number of samples and also to make rendering quicker
112 float mDownsampleWidthScale;
113 float mDownsampleHeightScale;
114 float mDownsampledWidth;
115 float mDownsampledHeight;
118 /////////////////////////////////////////////////////////////
119 // for checking if we need to reallocate render targets
123 /////////////////////////////////////////////////////////////
124 // 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
126 // for creating a subtree for the internal actors
129 /////////////////////////////////////////////////////////////
130 // for mapping offscreen renders to render target sizes
131 CameraActor mRenderFullSizeCamera;
132 CameraActor mRenderDownsampledCamera;
134 /////////////////////////////////////////////////////////////
135 // for rendering all user added children to offscreen target
136 FrameBufferImage mRenderTargetForRenderingChildren;
137 RenderTask mRenderChildrenTask;
139 /////////////////////////////////////////////////////////////
140 // for extracting bright parts of image to an offscreen target
141 FrameBufferImage mBloomExtractTarget; // for rendering bright parts of image into separate texture, also used as target for gaussian blur
142 RenderTask mBloomExtractTask;
143 Toolkit::ImageView mBloomExtractImageActor;
145 /////////////////////////////////////////////////////////////
146 // for blurring extracted bloom
147 Dali::Toolkit::GaussianBlurView mGaussianBlurView;
149 /////////////////////////////////////////////////////////////
150 // for compositing bloom and children renders to offscreen target
151 RenderTask mCompositeTask;
153 Toolkit::ImageView mCompositeImageActor;
155 /////////////////////////////////////////////////////////////
156 // for holding blurred result
157 FrameBufferImage mOutputRenderTarget;
158 Toolkit::ImageView mTargetImageActor;
160 /////////////////////////////////////////////////////////////
161 // Properties for setting by user, e.g. by animations
162 Property::Index mBloomThresholdPropertyIndex;
163 Property::Index mBlurStrengthPropertyIndex;
164 Property::Index mBloomIntensityPropertyIndex;
165 Property::Index mBloomSaturationPropertyIndex;
166 Property::Index mImageIntensityPropertyIndex;
167 Property::Index mImageSaturationPropertyIndex;
173 // Undefined copy constructor.
174 BloomView( const BloomView& );
176 // Undefined assignment operator.
177 BloomView& operator=( const BloomView& );
180 } // namespace Internal
182 // Helpers for public-api forwarding methods
183 inline Toolkit::Internal::BloomView& GetImpl( Toolkit::BloomView& obj )
185 DALI_ASSERT_ALWAYS(obj);
186 Dali::RefObject& handle = obj.GetImplementation();
187 return static_cast<Toolkit::Internal::BloomView&>(handle);
190 inline const Toolkit::Internal::BloomView& GetImpl( const Toolkit::BloomView& obj )
192 DALI_ASSERT_ALWAYS(obj);
193 const Dali::RefObject& handle = obj.GetImplementation();
194 return static_cast<const Toolkit::Internal::BloomView&>(handle);
197 } // namespace Toolkit
201 #endif // __DALI_TOOLKIT_INTERNAL_BLOOM_VIEW_H__