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>
27 #include <dali/public-api/shader-effects/shader-effect.h>
30 #include <dali-toolkit/public-api/controls/control-impl.h>
31 #include <dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-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);
74 void Add(Actor child);
75 void Remove(Actor child);
80 Property::Index GetBloomThresholdPropertyIndex() const {return mBloomThresholdPropertyIndex;}
81 Property::Index GetBlurStrengthPropertyIndex() const {return mBlurStrengthPropertyIndex;}
82 Property::Index GetBloomIntensityPropertyIndex() const {return mBloomIntensityPropertyIndex;}
83 Property::Index GetBloomSaturationPropertyIndex() const {return mBloomSaturationPropertyIndex;}
84 Property::Index GetImageIntensityPropertyIndex() const {return mImageIntensityPropertyIndex;}
85 Property::Index GetImageSaturationPropertyIndex() const {return mImageSaturationPropertyIndex;}
89 virtual void OnInitialize();
90 virtual void OnSizeSet(const Vector3& targetSize);
92 void AllocateResources();
93 void CreateRenderTasks();
94 void RemoveRenderTasks();
96 void SetupProperties();
99 /////////////////////////////////////////////////////////////
100 unsigned int mBlurNumSamples; // number of blur samples in each of horiz/vert directions
101 float mBlurBellCurveWidth; // constant used when calculating the gaussian weights
102 Pixel::Format mPixelFormat; // pixel format used by render targets
104 /////////////////////////////////////////////////////////////
105 // downsampling is used for the separated blur passes to get increased blur with the same number of samples and also to make rendering quicker
106 float mDownsampleWidthScale;
107 float mDownsampleHeightScale;
108 float mDownsampledWidth;
109 float mDownsampledHeight;
112 /////////////////////////////////////////////////////////////
113 // for checking if we need to reallocate render targets
117 /////////////////////////////////////////////////////////////
118 // 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
121 /////////////////////////////////////////////////////////////
122 // for mapping offscreen renders to render target sizes
123 CameraActor mRenderFullSizeCamera;
124 CameraActor mRenderDownsampledCamera;
126 /////////////////////////////////////////////////////////////
127 // for rendering all user added children to offscreen target
128 FrameBufferImage mRenderTargetForRenderingChildren;
129 RenderTask mRenderChildrenTask;
131 /////////////////////////////////////////////////////////////
132 // for extracting bright parts of image to an offscreen target
133 FrameBufferImage mBloomExtractTarget; // for rendering bright parts of image into separate texture, also used as target for gaussian blur
134 RenderTask mBloomExtractTask;
135 ShaderEffect mBloomExtractShader;
136 ImageActor mBloomExtractImageActor;
138 /////////////////////////////////////////////////////////////
139 // for blurring extracted bloom
140 Dali::Toolkit::GaussianBlurView mGaussianBlurView;
142 /////////////////////////////////////////////////////////////
143 // for compositing bloom and children renders to offscreen target
144 RenderTask mCompositeTask;
145 ShaderEffect mCompositeShader;
146 ImageActor mCompositeImageActor;
148 /////////////////////////////////////////////////////////////
149 // for holding blurred result
150 FrameBufferImage mOutputRenderTarget;
151 ImageActor mTargetImageActor;
153 /////////////////////////////////////////////////////////////
154 // Properties for setting by user, e.g. by animations
155 Property::Index mBloomThresholdPropertyIndex;
156 Property::Index mBlurStrengthPropertyIndex;
157 Property::Index mBloomIntensityPropertyIndex;
158 Property::Index mBloomSaturationPropertyIndex;
159 Property::Index mImageIntensityPropertyIndex;
160 Property::Index mImageSaturationPropertyIndex;
164 // Undefined copy constructor.
165 BloomView( const BloomView& );
167 // Undefined assignment operator.
168 BloomView& operator=( const BloomView& );
171 } // namespace Internal
173 // Helpers for public-api forwarding methods
174 inline Toolkit::Internal::BloomView& GetImpl( Toolkit::BloomView& obj )
176 DALI_ASSERT_ALWAYS(obj);
177 Dali::RefObject& handle = obj.GetImplementation();
178 return static_cast<Toolkit::Internal::BloomView&>(handle);
181 inline const Toolkit::Internal::BloomView& GetImpl( const Toolkit::BloomView& obj )
183 DALI_ASSERT_ALWAYS(obj);
184 const Dali::RefObject& handle = obj.GetImplementation();
185 return static_cast<const Toolkit::Internal::BloomView&>(handle);
188 } // namespace Toolkit
192 #endif // __DALI_TOOLKIT_INTERNAL_BLOOM_VIEW_H__