1 #ifndef __DALI_TOOLKIT_INTERNAL_BLOOM_VIEW_H__
2 #define __DALI_TOOLKIT_INTERNAL_BLOOM_VIEW_H__
5 * Copyright (c) 2016 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/render-tasks/render-task.h>
28 #include <dali-toolkit/public-api/controls/control-impl.h>
29 #include <dali-toolkit/devel-api/controls/gaussian-blur-view/gaussian-blur-view.h>
30 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
31 #include <dali-toolkit/devel-api/controls/bloom-view/bloom-view.h>
45 * BloomEffect implementation class
47 class BloomView : public Control
51 * @copydoc Dali::Toolkit::BloomView::BloomView
56 * @copydoc Dali::Toolkit::BloomView::BloomView
58 BloomView(const unsigned int numSamples, const float blurBellCurveWidth, const Pixel::Format renderTargetPixelFormat,
59 const float downsampleWidthScale, const float downsampleHeightScale);
62 * @copydoc Dali::Toolkit::BloomView::~BloomView
67 * @copydoc Dali::Toolkit::BloomView::New
69 static Dali::Toolkit::BloomView New();
70 static Dali::Toolkit::BloomView New( const unsigned int numSamples, const float blurBellCurveWidth, const Pixel::Format renderTargetPixelFormat,
71 const float downsampleWidthScale, const float downsampleHeightScale);
75 Property::Index GetBloomThresholdPropertyIndex() const {return mBloomThresholdPropertyIndex;}
76 Property::Index GetBlurStrengthPropertyIndex() const {return mBlurStrengthPropertyIndex;}
77 Property::Index GetBloomIntensityPropertyIndex() const {return mBloomIntensityPropertyIndex;}
78 Property::Index GetBloomSaturationPropertyIndex() const {return mBloomSaturationPropertyIndex;}
79 Property::Index GetImageIntensityPropertyIndex() const {return mImageIntensityPropertyIndex;}
80 Property::Index GetImageSaturationPropertyIndex() const {return mImageSaturationPropertyIndex;}
84 virtual void OnInitialize();
85 virtual void OnSizeSet(const Vector3& targetSize);
88 * @copydoc Control::OnChildAdd()
90 virtual void OnChildAdd( Actor& child );
93 * @copydoc Control::OnChildRemove()
95 virtual void OnChildRemove( Actor& child );
97 void AllocateResources();
98 void CreateRenderTasks();
99 void RemoveRenderTasks();
101 void SetupProperties();
104 /////////////////////////////////////////////////////////////
105 unsigned int mBlurNumSamples; // number of blur samples in each of horiz/vert directions
106 float mBlurBellCurveWidth; // constant used when calculating the gaussian weights
107 Pixel::Format mPixelFormat; // pixel format used by render targets
109 /////////////////////////////////////////////////////////////
110 // downsampling is used for the separated blur passes to get increased blur with the same number of samples and also to make rendering quicker
111 float mDownsampleWidthScale;
112 float mDownsampleHeightScale;
113 float mDownsampledWidth;
114 float mDownsampledHeight;
117 /////////////////////////////////////////////////////////////
118 // for checking if we need to reallocate render targets
122 /////////////////////////////////////////////////////////////
123 // 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
125 // for creating a subtree for the internal actors
128 /////////////////////////////////////////////////////////////
129 // for mapping offscreen renders to render target sizes
130 CameraActor mRenderFullSizeCamera;
131 CameraActor mRenderDownsampledCamera;
133 /////////////////////////////////////////////////////////////
134 // for rendering all user added children to offscreen target
135 FrameBufferImage mRenderTargetForRenderingChildren;
136 RenderTask mRenderChildrenTask;
138 /////////////////////////////////////////////////////////////
139 // for extracting bright parts of image to an offscreen target
140 FrameBufferImage mBloomExtractTarget; // for rendering bright parts of image into separate texture, also used as target for gaussian blur
141 RenderTask mBloomExtractTask;
142 Toolkit::ImageView mBloomExtractImageView;
144 /////////////////////////////////////////////////////////////
145 // for blurring extracted bloom
146 Dali::Toolkit::GaussianBlurView mGaussianBlurView;
148 /////////////////////////////////////////////////////////////
149 // for compositing bloom and children renders to offscreen target
150 RenderTask mCompositeTask;
152 Toolkit::ImageView mCompositeImageView;
154 /////////////////////////////////////////////////////////////
155 // for holding blurred result
156 FrameBufferImage mOutputRenderTarget;
157 Toolkit::ImageView mTargetImageView;
159 /////////////////////////////////////////////////////////////
160 // Properties for setting by user, e.g. by animations
161 Property::Index mBloomThresholdPropertyIndex;
162 Property::Index mBlurStrengthPropertyIndex;
163 Property::Index mBloomIntensityPropertyIndex;
164 Property::Index mBloomSaturationPropertyIndex;
165 Property::Index mImageIntensityPropertyIndex;
166 Property::Index mImageSaturationPropertyIndex;
172 // Undefined copy constructor.
173 BloomView( const BloomView& );
175 // Undefined assignment operator.
176 BloomView& operator=( const BloomView& );
179 } // namespace Internal
181 // Helpers for public-api forwarding methods
182 inline Toolkit::Internal::BloomView& GetImpl( Toolkit::BloomView& obj )
184 DALI_ASSERT_ALWAYS(obj);
185 Dali::RefObject& handle = obj.GetImplementation();
186 return static_cast<Toolkit::Internal::BloomView&>(handle);
189 inline const Toolkit::Internal::BloomView& GetImpl( const Toolkit::BloomView& obj )
191 DALI_ASSERT_ALWAYS(obj);
192 const Dali::RefObject& handle = obj.GetImplementation();
193 return static_cast<const Toolkit::Internal::BloomView&>(handle);
196 } // namespace Toolkit
200 #endif // __DALI_TOOLKIT_INTERNAL_BLOOM_VIEW_H__