2 * Copyright (c) 2014 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-map.h>
26 #include <dali/public-api/object/type-registry.h>
27 #include <dali/public-api/object/type-registry-helper.h>
28 #include <dali/public-api/render-tasks/render-task-list.h>
29 #include <dali/devel-api/rendering/renderer.h>
32 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
33 #include <dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h>
34 #include <dali-toolkit/internal/filters/blur-two-pass-filter.h>
35 #include <dali-toolkit/internal/filters/emboss-filter.h>
36 #include <dali-toolkit/internal/filters/spread-filter.h>
50 Dali::BaseHandle Create()
52 return EffectsView::New();
55 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::EffectsView, Toolkit::Control, Create )
56 DALI_PROPERTY_REGISTRATION( Toolkit, EffectsView, "effectSize", INTEGER, EFFECT_SIZE )
57 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, EffectsView, "effectOffset", VECTOR3, EFFECT_OFFSET )
58 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, EffectsView, "effectColor", Color::WHITE, EFFECT_COLOR )
59 DALI_TYPE_REGISTRATION_END()
61 const Pixel::Format EFFECTS_VIEW_DEFAULT_PIXEL_FORMAT = Pixel::RGBA8888;
62 const float ARBITRARY_FIELD_OF_VIEW = Math::PI / 4.0f;
63 const Vector4 EFFECTS_VIEW_DEFAULT_BACKGROUND_COLOR( 1.0f, 1.0f, 1.0f, 0.0 );
64 const bool EFFECTS_VIEW_REFRESH_ON_DEMAND(false);
66 #define DALI_COMPOSE_SHADER(STR) #STR
68 const char* EFFECTS_VIEW_VERTEX_SOURCE = DALI_COMPOSE_SHADER(
69 attribute mediump vec2 aPosition;\n
70 varying mediump vec2 vTexCoord;\n
71 uniform mediump mat4 uMvpMatrix;\n
72 uniform mediump vec3 uSize;\n
73 uniform mediump vec3 effectOffset;\n
77 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
78 vertexPosition.xyz *= uSize;\n
79 vertexPosition.xyz += effectOffset;\n
80 vertexPosition = uMvpMatrix * vertexPosition;\n
82 vTexCoord = aPosition + vec2(0.5);\n
83 gl_Position = vertexPosition;\n
87 const char* EFFECTS_VIEW_FRAGMENT_SOURCE = DALI_COMPOSE_SHADER(
88 varying mediump vec2 vTexCoord;\n
89 uniform sampler2D sTexture;\n
90 uniform lowp vec4 effectColor;\n
94 gl_FragColor = effectColor;\n
95 gl_FragColor.a *= texture2D( sTexture, vTexCoord).a;\n
99 const float BLUR_KERNEL0[] = { 12.0f/16.0f,
100 2.0f/16.0f, 2.0f/16.0f };
102 const float BLUR_KERNEL1[] = { 8.0f/16.0f,
103 4.0f/16.0f, 4.0f/16.0f };
105 const float BLUR_KERNEL2[] = { 6.0f/16.0f,
106 2.5f/16.0f, 2.5f/16.0f,
107 1.5f/16.0f, 1.5f/16.0f,
108 1.0f/16.0f, 1.0f/16.0f };
110 const float BLUR_KERNEL3[] = { 4.0f/16.0f,
111 3.0f/16.0f, 2.0f/16.0f,
112 2.0f/16.0f, 2.0f/16.0f,
113 1.0f/16.0f, 1.0f/16.0f };
115 const float BLUR_KERNEL4[] = { 3.0f/16.0f,
116 2.5f/16.0f, 2.5f/16.0f,
117 1.75f/16.0f, 1.75f/16.0f,
118 1.25f/16.0f, 1.25f/16.0f,
119 1.0f/16.0f, 1.0f/16.0f };
123 Toolkit::EffectsView EffectsView::New()
125 EffectsView* effectsView = new EffectsView;
127 Toolkit::EffectsView handle = Toolkit::EffectsView( *effectsView );
129 // Second-phase init of the implementation
130 // This can only be done after the CustomActor connection has been made...
131 effectsView->Initialize();
136 EffectsView::EffectsView()
137 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_NONE ) ),
138 mChildrenRoot(Actor::New()),
139 mBackgroundColor( EFFECTS_VIEW_DEFAULT_BACKGROUND_COLOR ),
140 mTargetSize( Vector2::ZERO ),
141 mLastSize( Vector2::ZERO ),
143 mEffectType( Toolkit::EffectsView::INVALID_TYPE ),
144 mPixelFormat( EFFECTS_VIEW_DEFAULT_PIXEL_FORMAT ),
146 mRefreshOnDemand(EFFECTS_VIEW_REFRESH_ON_DEMAND)
150 EffectsView::~EffectsView()
155 void EffectsView::SetType( Toolkit::EffectsView::EffectType type )
157 if( mEffectType != type )
162 Property::Map rendererMap;
163 rendererMap.Insert( "rendererType", "image" );
167 case Toolkit::EffectsView::DROP_SHADOW:
169 mFilters.PushBack( new SpreadFilter );
170 mFilters.PushBack( new BlurTwoPassFilter );
173 case Toolkit::EffectsView::EMBOSS:
175 mFilters.PushBack( new SpreadFilter );
176 mFilters.PushBack( new EmbossFilter );
177 mFilters.PushBack( new BlurTwoPassFilter );
186 Property::Map customShader;
187 customShader[ "vertexShader" ] = EFFECTS_VIEW_VERTEX_SOURCE;
188 customShader[ "fragmentShader" ] = EFFECTS_VIEW_FRAGMENT_SOURCE;
189 rendererMap[ "shader" ] = customShader;
190 InitializeControlRenderer( self, mRendererPostFilter, rendererMap );
196 Toolkit::EffectsView::EffectType EffectsView::GetType() const
201 void EffectsView::Enable()
203 // make sure resources are allocated and start the render tasks processing
209 void EffectsView::Disable()
211 // stop render tasks processing
212 // Note: render target resources are automatically freed since we set the Image::Unused flag
217 void EffectsView::Refresh()
219 RefreshRenderTasks();
222 void EffectsView::SetRefreshOnDemand( bool onDemand )
224 mRefreshOnDemand = onDemand;
226 RefreshRenderTasks();
229 void EffectsView::SetPixelFormat( Pixel::Format pixelFormat )
231 mPixelFormat = pixelFormat;
234 void EffectsView::SetBackgroundColor( const Vector4& color )
236 mBackgroundColor = color;
239 Vector4 EffectsView::GetBackgroundColor() const
241 return mBackgroundColor;
244 void EffectsView::SetEffectSize( int effectSize )
246 mEffectSize = effectSize;
250 const size_t numFilters( mFilters.Size() );
251 for( size_t i = 0; i < numFilters; ++i )
253 mFilters[i]->Disable();
258 for( size_t i = 0; i < numFilters; ++i )
260 mFilters[i]->Enable();
265 int EffectsView::GetEffectSize()
271 void EffectsView::OnInitialize()
273 CustomActor self = Self();
274 mChildrenRoot.SetParentOrigin( ParentOrigin::CENTER );
275 self.Add( mChildrenRoot );
278 void EffectsView::OnSizeSet(const Vector3& targetSize)
280 Control::OnSizeSet( targetSize );
282 mTargetSize = Vector2(targetSize);
284 // if we are already on stage, need to update render target sizes now to reflect the new size of this actor
287 if( mLastSize != Vector2::ZERO )
294 mChildrenRoot.SetSize( targetSize );
297 void EffectsView::OnStageConnection( int depth )
299 Control::OnStageConnection( depth );
304 if( mRendererPostFilter )
306 mRendererPostFilter.SetOnStage( self );
308 if( mRendererForChildren )
310 mRendererForChildren.SetOnStage( self );
314 void EffectsView::OnStageDisconnection()
318 const size_t numFilters( mFilters.Size() );
319 for( size_t i = 0; i < numFilters; ++i )
321 mFilters[i]->Disable();
325 if( mRendererPostFilter )
327 mRendererPostFilter.SetOffStage( self );
329 if( mRendererForChildren )
331 mRendererForChildren.SetOffStage( self );
334 Control::OnStageDisconnection();
337 void EffectsView::OnChildAdd( Actor& child )
339 Control::OnChildAdd( child );
341 if( child != mChildrenRoot && child != mCameraForChildren )
343 mChildrenRoot.Add( child );
347 void EffectsView::OnChildRemove( Actor& child )
349 mChildrenRoot.Remove( child );
351 Control::OnChildRemove( child );
354 void EffectsView::SetupFilters()
356 switch( mEffectType )
358 case Toolkit::EffectsView::DROP_SHADOW:
360 SpreadFilter* spreadFilter = static_cast< SpreadFilter* >( mFilters[0] );
361 spreadFilter->SetInputImage( mImageForChildren );
362 spreadFilter->SetOutputImage( mImagePostFilter );
363 spreadFilter->SetRootActor( mChildrenRoot );
364 spreadFilter->SetBackgroundColor( mBackgroundColor );
365 spreadFilter->SetPixelFormat( mPixelFormat );
366 spreadFilter->SetSize( mTargetSize );
367 spreadFilter->SetSpread( mEffectSize );
369 BlurTwoPassFilter* blurFilter = static_cast< BlurTwoPassFilter* >( mFilters[1] );
370 blurFilter->SetInputImage( mImagePostFilter );
371 blurFilter->SetOutputImage( mImagePostFilter );
372 blurFilter->SetRootActor( mChildrenRoot );
373 blurFilter->SetBackgroundColor( mBackgroundColor );
374 blurFilter->SetPixelFormat( mPixelFormat );
375 blurFilter->SetSize( mTargetSize );
377 const float* kernel(NULL);
378 size_t kernelSize(0);
379 switch( mEffectSize )
381 case 4: { kernel = BLUR_KERNEL4; kernelSize = sizeof(BLUR_KERNEL4)/sizeof(BLUR_KERNEL4[0]); break; }
382 case 3: { kernel = BLUR_KERNEL3; kernelSize = sizeof(BLUR_KERNEL3)/sizeof(BLUR_KERNEL3[0]); break; }
383 case 2: { kernel = BLUR_KERNEL2; kernelSize = sizeof(BLUR_KERNEL2)/sizeof(BLUR_KERNEL2[0]); break; }
384 case 1: { kernel = BLUR_KERNEL1; kernelSize = sizeof(BLUR_KERNEL1)/sizeof(BLUR_KERNEL1[0]); break; }
386 default: { kernel = BLUR_KERNEL0; kernelSize = sizeof(BLUR_KERNEL0)/sizeof(BLUR_KERNEL0[0]); break; }
388 blurFilter->CreateKernel( kernel, kernelSize );
391 case Toolkit::EffectsView::EMBOSS:
393 SpreadFilter* spreadFilter = static_cast< SpreadFilter* >( mFilters[0] );
394 spreadFilter->SetInputImage( mImageForChildren );
395 spreadFilter->SetOutputImage( mImagePostFilter );
396 spreadFilter->SetRootActor( mChildrenRoot );
397 spreadFilter->SetBackgroundColor( mBackgroundColor );
398 spreadFilter->SetPixelFormat( Pixel::RGBA8888 );
399 spreadFilter->SetSize( mTargetSize );
400 spreadFilter->SetSpread( mEffectSize );
402 EmbossFilter* embossFilter = static_cast< EmbossFilter* >( mFilters[1] );
403 embossFilter->SetInputImage( mImagePostFilter );
404 embossFilter->SetOutputImage( mImagePostFilter );
405 embossFilter->SetRootActor( mChildrenRoot );
406 embossFilter->SetBackgroundColor( mBackgroundColor );
407 embossFilter->SetPixelFormat( Pixel::RGBA8888 );
408 embossFilter->SetSize( mTargetSize );
410 BlurTwoPassFilter* blurFilter = static_cast< BlurTwoPassFilter* >( mFilters[2] );
411 blurFilter->SetInputImage( mImagePostFilter );
412 blurFilter->SetOutputImage( mImagePostFilter );
413 blurFilter->SetRootActor( mChildrenRoot );
414 blurFilter->SetBackgroundColor( Vector4( 0.5f, 0.5f, 0.5f, 0.0 ) );
415 blurFilter->SetPixelFormat( Pixel::RGBA8888 );
416 blurFilter->SetSize( mTargetSize );
417 blurFilter->CreateKernel( BLUR_KERNEL0, sizeof(BLUR_KERNEL0)/sizeof(BLUR_KERNEL0[0]) );
427 void EffectsView::AllocateResources()
429 if(mTargetSize != mLastSize)
431 mLastSize = mTargetSize;
434 Actor self( Self() );
436 mImageForChildren = FrameBufferImage::New( mTargetSize.width, mTargetSize.height, mPixelFormat, Dali::Image::UNUSED );
437 InitializeControlRenderer( self, mRendererForChildren, mImageForChildren );
438 mRendererForChildren.SetDepthIndex( DepthIndex::CONTENT+1 );
440 mImagePostFilter = FrameBufferImage::New( mTargetSize.width, mTargetSize.height, mPixelFormat, Dali::Image::UNUSED );
441 TextureSet textureSet = TextureSet::New();
442 textureSet.SetImage( 0u, mImagePostFilter);
443 self.GetRendererAt( 0 ).SetTextures( textureSet );
444 mRendererPostFilter.SetDepthIndex( DepthIndex::CONTENT );
450 void EffectsView::SetupCameras()
452 if( !mCameraForChildren )
454 // Create a camera for the children render, corresponding to its render target size
455 mCameraForChildren = CameraActor::New(mTargetSize);
456 mCameraForChildren.SetParentOrigin(ParentOrigin::CENTER);
457 mCameraForChildren.SetInvertYAxis( true );
458 Self().Add( mCameraForChildren );
462 // place the camera for the children render, corresponding to its render target size
463 const float cameraPosScale( 0.5f / tanf(ARBITRARY_FIELD_OF_VIEW * 0.5f) );
464 mCameraForChildren.SetFieldOfView(ARBITRARY_FIELD_OF_VIEW);
465 mCameraForChildren.SetNearClippingPlane(1.0f);
466 mCameraForChildren.SetAspectRatio(mTargetSize.width / mTargetSize.height);
467 mCameraForChildren.SetType(Dali::Camera::FREE_LOOK); // camera orientation based solely on actor
468 mCameraForChildren.SetPosition(0.0f, 0.0f, mTargetSize.height * cameraPosScale);
469 mCameraForChildren.SetZ( mTargetSize.height * cameraPosScale );
473 void EffectsView::CreateRenderTasks()
475 if( mTargetSize == Vector2::ZERO )
479 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
481 // create render task to render our child actors to offscreen buffer
482 mRenderTaskForChildren = taskList.CreateTask();
483 mRenderTaskForChildren.SetRefreshRate( mRefreshOnDemand ? RenderTask::REFRESH_ONCE : RenderTask::REFRESH_ALWAYS );
484 mRenderTaskForChildren.SetSourceActor( mChildrenRoot );
485 mRenderTaskForChildren.SetExclusive(true);
486 mRenderTaskForChildren.SetInputEnabled( false );
487 mRenderTaskForChildren.SetClearColor( mBackgroundColor );
488 mRenderTaskForChildren.SetClearEnabled( true );
489 mRenderTaskForChildren.SetTargetFrameBuffer( mImageForChildren );
490 mRenderTaskForChildren.SetCameraActor(mCameraForChildren); // use camera that covers render target exactly
492 // Enable image filters
493 const size_t numFilters( mFilters.Size() );
494 for( size_t i = 0; i < numFilters; ++i )
496 mFilters[i]->Enable();
500 void EffectsView::RemoveRenderTasks()
502 if( mTargetSize == Vector2::ZERO )
507 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
509 taskList.RemoveTask(mRenderTaskForChildren);
511 const size_t numFilters( mFilters.Size() );
512 for( size_t i = 0; i < numFilters; ++i )
514 mFilters[i]->Disable();
518 void EffectsView::RefreshRenderTasks()
520 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
522 if( mRenderTaskForChildren )
524 mRenderTaskForChildren.SetRefreshRate( mRefreshOnDemand ? RenderTask::REFRESH_ONCE : RenderTask::REFRESH_ALWAYS );
527 const size_t numFilters( mFilters.Size() );
528 for( size_t i = 0; i < numFilters; ++i )
530 mFilters[i]->Refresh();
534 void EffectsView::RemoveFilters()
536 const size_t numFilters( mFilters.Size() );
537 for( size_t i = 0; i < numFilters; ++i )
544 void EffectsView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
546 Toolkit::EffectsView effectsView = Toolkit::EffectsView::DownCast( Dali::BaseHandle( object ) );
552 case Toolkit::EffectsView::Property::EFFECT_SIZE:
555 if( value.Get( effectSize ) )
557 GetImpl( effectsView ).SetEffectSize( effectSize );
569 Property::Value EffectsView::GetProperty( BaseObject* object, Property::Index propertyIndex )
571 Property::Value value;
573 Toolkit::EffectsView imageview = Toolkit::EffectsView::DownCast( Dali::BaseHandle( object ) );
577 EffectsView& impl = GetImpl( imageview );
578 switch ( propertyIndex )
580 case Toolkit::EffectsView::Property::EFFECT_SIZE:
582 value = impl.GetEffectSize();
595 } // namespace Internal
597 } // namespace Toolkit