2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "effects-view-impl.h"
22 #include <dali/public-api/animation/constraint.h>
23 #include <dali/public-api/animation/constraints.h>
24 #include <dali/public-api/common/stage.h>
25 #include <dali/public-api/object/property.h>
26 #include <dali/public-api/object/property-map.h>
27 #include <dali/public-api/object/type-registry.h>
28 #include <dali/public-api/object/type-registry-helper.h>
29 #include <dali/public-api/render-tasks/render-task-list.h>
30 #include <dali/public-api/rendering/renderer.h>
31 #include <dali/devel-api/images/texture-set-image.h>
34 #include <dali-toolkit/public-api/visuals/visual-properties.h>
35 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
36 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
37 #include <dali-toolkit/internal/filters/blur-two-pass-filter.h>
38 #include <dali-toolkit/internal/filters/emboss-filter.h>
39 #include <dali-toolkit/internal/filters/spread-filter.h>
40 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
41 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
55 Dali::BaseHandle Create()
57 return EffectsView::New();
60 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::EffectsView, Toolkit::Control, Create )
61 DALI_PROPERTY_REGISTRATION( Toolkit, EffectsView, "effectSize", INTEGER, EFFECT_SIZE )
62 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, EffectsView, "effectOffset", VECTOR3, EFFECT_OFFSET )
63 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, EffectsView, "effectColor", Color::WHITE, EFFECT_COLOR )
64 DALI_TYPE_REGISTRATION_END()
66 const Pixel::Format EFFECTS_VIEW_DEFAULT_PIXEL_FORMAT = Pixel::RGBA8888;
67 const float ARBITRARY_FIELD_OF_VIEW = Math::PI / 4.0f;
68 const Vector4 EFFECTS_VIEW_DEFAULT_BACKGROUND_COLOR( 1.0f, 1.0f, 1.0f, 0.0 );
69 const bool EFFECTS_VIEW_REFRESH_ON_DEMAND(false);
71 // Visuals are not stylable or public
72 const Property::Index CHILD_VISUAL( Toolkit::EffectsView::ANIMATABLE_PROPERTY_START_INDEX - 1);
73 const Property::Index POST_FILTER_VISUAL( CHILD_VISUAL-1 );
75 #define DALI_COMPOSE_SHADER(STR) #STR
77 const char* EFFECTS_VIEW_VERTEX_SOURCE = DALI_COMPOSE_SHADER(
78 attribute mediump vec2 aPosition;\n
79 varying mediump vec2 vTexCoord;\n
80 uniform mediump mat4 uMvpMatrix;\n
81 uniform mediump vec3 uSize;\n
82 uniform mediump vec3 effectOffset;\n
86 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
87 vertexPosition.xyz *= uSize;\n
88 vertexPosition.xyz += effectOffset;\n
89 vertexPosition = uMvpMatrix * vertexPosition;\n
91 vTexCoord = aPosition + vec2(0.5);\n
92 gl_Position = vertexPosition;\n
96 const char* EFFECTS_VIEW_FRAGMENT_SOURCE = DALI_COMPOSE_SHADER(
97 varying mediump vec2 vTexCoord;\n
98 uniform sampler2D sTexture;\n
99 uniform lowp vec4 effectColor;\n
103 gl_FragColor = effectColor;\n
104 gl_FragColor.a *= texture2D( sTexture, vTexCoord).a;\n
108 const float BLUR_KERNEL0[] = { 12.0f/16.0f,
109 2.0f/16.0f, 2.0f/16.0f };
111 const float BLUR_KERNEL1[] = { 8.0f/16.0f,
112 4.0f/16.0f, 4.0f/16.0f };
114 const float BLUR_KERNEL2[] = { 6.0f/16.0f,
115 2.5f/16.0f, 2.5f/16.0f,
116 1.5f/16.0f, 1.5f/16.0f,
117 1.0f/16.0f, 1.0f/16.0f };
119 const float BLUR_KERNEL3[] = { 4.0f/16.0f,
120 3.0f/16.0f, 2.0f/16.0f,
121 2.0f/16.0f, 2.0f/16.0f,
122 1.0f/16.0f, 1.0f/16.0f };
124 const float BLUR_KERNEL4[] = { 3.0f/16.0f,
125 2.5f/16.0f, 2.5f/16.0f,
126 1.75f/16.0f, 1.75f/16.0f,
127 1.25f/16.0f, 1.25f/16.0f,
128 1.0f/16.0f, 1.0f/16.0f };
132 Toolkit::EffectsView EffectsView::New()
134 EffectsView* effectsView = new EffectsView;
136 Toolkit::EffectsView handle = Toolkit::EffectsView( *effectsView );
138 // Second-phase init of the implementation
139 // This can only be done after the CustomActor connection has been made...
140 effectsView->Initialize();
145 EffectsView::EffectsView()
146 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
147 mChildrenRoot(Actor::New()),
148 mBackgroundColor( EFFECTS_VIEW_DEFAULT_BACKGROUND_COLOR ),
149 mTargetSize( Vector2::ZERO ),
150 mLastSize( Vector2::ZERO ),
152 mEffectType( Toolkit::EffectsView::INVALID_TYPE ),
153 mPixelFormat( EFFECTS_VIEW_DEFAULT_PIXEL_FORMAT ),
155 mRefreshOnDemand(EFFECTS_VIEW_REFRESH_ON_DEMAND)
159 EffectsView::~EffectsView()
164 void EffectsView::SetType( Toolkit::EffectsView::EffectType type )
166 if( mEffectType != type )
174 case Toolkit::EffectsView::DROP_SHADOW:
176 mFilters.PushBack( new SpreadFilter );
177 mFilters.PushBack( new BlurTwoPassFilter );
180 case Toolkit::EffectsView::EMBOSS:
182 mFilters.PushBack( new SpreadFilter );
183 mFilters.PushBack( new EmbossFilter );
184 mFilters.PushBack( new BlurTwoPassFilter );
193 FrameBufferImage dummyImage = FrameBufferImage::New( mTargetSize.width, mTargetSize.height, mPixelFormat );
195 Internal::InitializeVisual( self, mVisualPostFilter, dummyImage );
196 RegisterVisual( POST_FILTER_VISUAL, mVisualPostFilter );
198 Property::Map customShader;
199 customShader[ Toolkit::Visual::Shader::Property::VERTEX_SHADER ] = EFFECTS_VIEW_VERTEX_SOURCE;
200 customShader[ Toolkit::Visual::Shader::Property::FRAGMENT_SHADER ] = EFFECTS_VIEW_FRAGMENT_SOURCE;
201 Toolkit::GetImplementation( mVisualPostFilter ).SetCustomShader( customShader );
207 Toolkit::EffectsView::EffectType EffectsView::GetType() const
212 void EffectsView::Enable()
214 // make sure resources are allocated and start the render tasks processing
220 void EffectsView::Disable()
222 // stop render tasks processing
223 // Note: render target resources are automatically freed since we set the Image::Unused flag
225 mLastSize = Vector2::ZERO; // Ensure resources are reallocated on subsequent enable
229 void EffectsView::Refresh()
231 RefreshRenderTasks();
234 void EffectsView::SetRefreshOnDemand( bool onDemand )
236 mRefreshOnDemand = onDemand;
238 RefreshRenderTasks();
241 void EffectsView::SetPixelFormat( Pixel::Format pixelFormat )
243 mPixelFormat = pixelFormat;
246 void EffectsView::SetBackgroundColor( const Vector4& color )
248 mBackgroundColor = color;
251 Vector4 EffectsView::GetBackgroundColor() const
253 return mBackgroundColor;
256 void EffectsView::SetEffectSize( int effectSize )
258 mEffectSize = effectSize;
262 const size_t numFilters( mFilters.Size() );
263 for( size_t i = 0; i < numFilters; ++i )
265 mFilters[i]->Disable();
270 for( size_t i = 0; i < numFilters; ++i )
272 mFilters[i]->Enable();
277 int EffectsView::GetEffectSize()
283 void EffectsView::OnInitialize()
285 CustomActor self = Self();
286 mChildrenRoot.SetParentOrigin( ParentOrigin::CENTER );
287 self.Add( mChildrenRoot );
290 void EffectsView::OnSizeSet(const Vector3& targetSize)
292 mTargetSize = Vector2(targetSize);
294 // if we are already on stage, need to update render target sizes now to reflect the new size of this actor
297 if( mLastSize != Vector2::ZERO )
304 mChildrenRoot.SetSize( targetSize );
306 Control::OnSizeSet( targetSize );
309 void EffectsView::OnStageConnection( int depth )
313 Control::OnStageConnection( depth );
316 void EffectsView::OnStageDisconnection()
320 const size_t numFilters( mFilters.Size() );
321 for( size_t i = 0; i < numFilters; ++i )
323 mFilters[i]->Disable();
326 Control::OnStageDisconnection();
329 void EffectsView::OnChildAdd( Actor& child )
331 if( child != mChildrenRoot && child != mCameraForChildren )
333 mChildrenRoot.Add( child );
336 Control::OnChildAdd( child );
339 void EffectsView::OnChildRemove( Actor& child )
341 mChildrenRoot.Remove( child );
343 Control::OnChildRemove( child );
346 void EffectsView::SetupFilters()
348 switch( mEffectType )
350 case Toolkit::EffectsView::DROP_SHADOW:
352 SpreadFilter* spreadFilter = static_cast< SpreadFilter* >( mFilters[0] );
353 spreadFilter->SetInputImage( mImageForChildren );
354 spreadFilter->SetOutputImage( mImagePostFilter );
355 spreadFilter->SetRootActor( mChildrenRoot );
356 spreadFilter->SetBackgroundColor( mBackgroundColor );
357 spreadFilter->SetPixelFormat( mPixelFormat );
358 spreadFilter->SetSize( mTargetSize );
359 spreadFilter->SetSpread( mEffectSize );
361 BlurTwoPassFilter* blurFilter = static_cast< BlurTwoPassFilter* >( mFilters[1] );
362 blurFilter->SetInputImage( mImagePostFilter );
363 blurFilter->SetOutputImage( mImagePostFilter );
364 blurFilter->SetRootActor( mChildrenRoot );
365 blurFilter->SetBackgroundColor( mBackgroundColor );
366 blurFilter->SetPixelFormat( mPixelFormat );
367 blurFilter->SetSize( mTargetSize );
369 const float* kernel(NULL);
370 size_t kernelSize(0);
371 switch( mEffectSize )
373 case 4: { kernel = BLUR_KERNEL4; kernelSize = sizeof(BLUR_KERNEL4)/sizeof(BLUR_KERNEL4[0]); break; }
374 case 3: { kernel = BLUR_KERNEL3; kernelSize = sizeof(BLUR_KERNEL3)/sizeof(BLUR_KERNEL3[0]); break; }
375 case 2: { kernel = BLUR_KERNEL2; kernelSize = sizeof(BLUR_KERNEL2)/sizeof(BLUR_KERNEL2[0]); break; }
376 case 1: { kernel = BLUR_KERNEL1; kernelSize = sizeof(BLUR_KERNEL1)/sizeof(BLUR_KERNEL1[0]); break; }
378 default: { kernel = BLUR_KERNEL0; kernelSize = sizeof(BLUR_KERNEL0)/sizeof(BLUR_KERNEL0[0]); break; }
380 blurFilter->CreateKernel( kernel, kernelSize );
383 case Toolkit::EffectsView::EMBOSS:
385 SpreadFilter* spreadFilter = static_cast< SpreadFilter* >( mFilters[0] );
386 spreadFilter->SetInputImage( mImageForChildren );
387 spreadFilter->SetOutputImage( mImagePostFilter );
388 spreadFilter->SetRootActor( mChildrenRoot );
389 spreadFilter->SetBackgroundColor( mBackgroundColor );
390 spreadFilter->SetPixelFormat( Pixel::RGBA8888 );
391 spreadFilter->SetSize( mTargetSize );
392 spreadFilter->SetSpread( mEffectSize );
394 EmbossFilter* embossFilter = static_cast< EmbossFilter* >( mFilters[1] );
395 embossFilter->SetInputImage( mImagePostFilter );
396 embossFilter->SetOutputImage( mImagePostFilter );
397 embossFilter->SetRootActor( mChildrenRoot );
398 embossFilter->SetBackgroundColor( mBackgroundColor );
399 embossFilter->SetPixelFormat( Pixel::RGBA8888 );
400 embossFilter->SetSize( mTargetSize );
402 BlurTwoPassFilter* blurFilter = static_cast< BlurTwoPassFilter* >( mFilters[2] );
403 blurFilter->SetInputImage( mImagePostFilter );
404 blurFilter->SetOutputImage( mImagePostFilter );
405 blurFilter->SetRootActor( mChildrenRoot );
406 blurFilter->SetBackgroundColor( Vector4( 0.5f, 0.5f, 0.5f, 0.0 ) );
407 blurFilter->SetPixelFormat( Pixel::RGBA8888 );
408 blurFilter->SetSize( mTargetSize );
409 blurFilter->CreateKernel( BLUR_KERNEL0, sizeof(BLUR_KERNEL0)/sizeof(BLUR_KERNEL0[0]) );
419 void EffectsView::AllocateResources()
421 if(mTargetSize != mLastSize)
423 mLastSize = mTargetSize;
426 Actor self( Self() );
428 mImageForChildren = FrameBufferImage::New( mTargetSize.width, mTargetSize.height, mPixelFormat );
429 Internal::InitializeVisual( self, mVisualForChildren, mImageForChildren );
430 RegisterVisual( CHILD_VISUAL, mVisualForChildren );
431 mVisualForChildren.SetDepthIndex( DepthIndex::CONTENT+1 );
433 mImagePostFilter = FrameBufferImage::New( mTargetSize.width, mTargetSize.height, mPixelFormat );
434 TextureSet textureSet = TextureSet::New();
435 TextureSetImage( textureSet, 0u, mImagePostFilter );
436 self.GetRendererAt( 0 ).SetTextures( textureSet );
437 mVisualPostFilter.SetDepthIndex( DepthIndex::CONTENT );
443 void EffectsView::SetupCameras()
445 if( !mCameraForChildren )
447 // Create a camera for the children render, corresponding to its render target size
448 mCameraForChildren = CameraActor::New(mTargetSize);
449 mCameraForChildren.SetParentOrigin(ParentOrigin::CENTER);
450 mCameraForChildren.SetInvertYAxis( true );
451 Self().Add( mCameraForChildren );
455 // place the camera for the children render, corresponding to its render target size
456 const float cameraPosScale( 0.5f / tanf(ARBITRARY_FIELD_OF_VIEW * 0.5f) );
457 mCameraForChildren.SetFieldOfView(ARBITRARY_FIELD_OF_VIEW);
458 mCameraForChildren.SetNearClippingPlane(1.0f);
459 mCameraForChildren.SetAspectRatio(mTargetSize.width / mTargetSize.height);
460 mCameraForChildren.SetType(Dali::Camera::FREE_LOOK); // camera orientation based solely on actor
461 mCameraForChildren.SetPosition(0.0f, 0.0f, mTargetSize.height * cameraPosScale);
462 mCameraForChildren.SetZ( mTargetSize.height * cameraPosScale );
466 void EffectsView::CreateRenderTasks()
468 if( mTargetSize == Vector2::ZERO )
472 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
474 // create render task to render our child actors to offscreen buffer
475 mRenderTaskForChildren = taskList.CreateTask();
476 mRenderTaskForChildren.SetRefreshRate( mRefreshOnDemand ? RenderTask::REFRESH_ONCE : RenderTask::REFRESH_ALWAYS );
477 mRenderTaskForChildren.SetSourceActor( mChildrenRoot );
478 mRenderTaskForChildren.SetExclusive(true);
479 mRenderTaskForChildren.SetInputEnabled( false );
480 mRenderTaskForChildren.SetClearColor( mBackgroundColor );
481 mRenderTaskForChildren.SetClearEnabled( true );
482 mRenderTaskForChildren.SetTargetFrameBuffer( mImageForChildren );
483 mRenderTaskForChildren.SetCameraActor(mCameraForChildren); // use camera that covers render target exactly
485 // Enable image filters
486 const size_t numFilters( mFilters.Size() );
487 for( size_t i = 0; i < numFilters; ++i )
489 mFilters[i]->Enable();
493 void EffectsView::RemoveRenderTasks()
495 if( mTargetSize == Vector2::ZERO )
500 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
502 taskList.RemoveTask(mRenderTaskForChildren);
504 const size_t numFilters( mFilters.Size() );
505 for( size_t i = 0; i < numFilters; ++i )
507 mFilters[i]->Disable();
511 void EffectsView::RefreshRenderTasks()
513 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
515 if( mRenderTaskForChildren )
517 mRenderTaskForChildren.SetRefreshRate( mRefreshOnDemand ? RenderTask::REFRESH_ONCE : RenderTask::REFRESH_ALWAYS );
520 const size_t numFilters( mFilters.Size() );
521 for( size_t i = 0; i < numFilters; ++i )
523 mFilters[i]->Refresh();
527 void EffectsView::RemoveFilters()
529 const size_t numFilters( mFilters.Size() );
530 for( size_t i = 0; i < numFilters; ++i )
537 void EffectsView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
539 Toolkit::EffectsView effectsView = Toolkit::EffectsView::DownCast( Dali::BaseHandle( object ) );
545 case Toolkit::EffectsView::Property::EFFECT_SIZE:
548 if( value.Get( effectSize ) )
550 GetImpl( effectsView ).SetEffectSize( effectSize );
562 Property::Value EffectsView::GetProperty( BaseObject* object, Property::Index propertyIndex )
564 Property::Value value;
566 Toolkit::EffectsView imageview = Toolkit::EffectsView::DownCast( Dali::BaseHandle( object ) );
570 EffectsView& impl = GetImpl( imageview );
571 switch ( propertyIndex )
573 case Toolkit::EffectsView::Property::EFFECT_SIZE:
575 value = impl.GetEffectSize();
588 } // namespace Internal
590 } // namespace Toolkit