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>
31 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
32 #include <dali-toolkit/internal/filters/blur-two-pass-filter.h>
33 #include <dali-toolkit/internal/filters/emboss-filter.h>
34 #include <dali-toolkit/internal/filters/spread-filter.h>
48 Dali::BaseHandle Create()
50 return EffectsView::New();
53 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::EffectsView, Toolkit::Control, Create )
54 DALI_PROPERTY_REGISTRATION( Toolkit, EffectsView, "effectSize", INTEGER, EFFECT_SIZE )
55 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, EffectsView, "effectOffset", VECTOR3, EFFECT_OFFSET )
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, EffectsView, "effectColor", Color::WHITE, EFFECT_COLOR )
57 DALI_TYPE_REGISTRATION_END()
59 const Pixel::Format EFFECTS_VIEW_DEFAULT_PIXEL_FORMAT = Pixel::RGBA8888;
60 const float ARBITRARY_FIELD_OF_VIEW = Math::PI / 4.0f;
61 const Vector4 EFFECTS_VIEW_DEFAULT_BACKGROUND_COLOR( 1.0f, 1.0f, 1.0f, 0.0 );
62 const bool EFFECTS_VIEW_REFRESH_ON_DEMAND(false);
64 #define DALI_COMPOSE_SHADER(STR) #STR
66 const char* EFFECTS_VIEW_VERTEX_SOURCE = DALI_COMPOSE_SHADER(
67 attribute mediump vec2 aPosition;\n
68 varying mediump vec2 vTexCoord;\n
69 uniform mediump mat4 uMvpMatrix;\n
70 uniform mediump vec3 uSize;\n
71 uniform mediump vec3 effectOffset;\n
75 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
76 vertexPosition.xyz *= uSize;\n
77 vertexPosition.xyz += effectOffset;\n
78 vertexPosition = uMvpMatrix * vertexPosition;\n
80 vTexCoord = aPosition + vec2(0.5);\n
81 gl_Position = vertexPosition;\n
85 const char* EFFECTS_VIEW_FRAGMENT_SOURCE = DALI_COMPOSE_SHADER(
86 varying mediump vec2 vTexCoord;\n
87 uniform sampler2D sTexture;\n
88 uniform lowp vec4 effectColor;\n
92 gl_FragColor = effectColor;\n
93 gl_FragColor.a *= texture2D( sTexture, vTexCoord).a;\n
97 const float BLUR_KERNEL0[] = { 12.0f/16.0f,
98 2.0f/16.0f, 2.0f/16.0f };
100 const float BLUR_KERNEL1[] = { 8.0f/16.0f,
101 4.0f/16.0f, 4.0f/16.0f };
103 const float BLUR_KERNEL2[] = { 6.0f/16.0f,
104 2.5f/16.0f, 2.5f/16.0f,
105 1.5f/16.0f, 1.5f/16.0f,
106 1.0f/16.0f, 1.0f/16.0f };
108 const float BLUR_KERNEL3[] = { 4.0f/16.0f,
109 3.0f/16.0f, 2.0f/16.0f,
110 2.0f/16.0f, 2.0f/16.0f,
111 1.0f/16.0f, 1.0f/16.0f };
113 const float BLUR_KERNEL4[] = { 3.0f/16.0f,
114 2.5f/16.0f, 2.5f/16.0f,
115 1.75f/16.0f, 1.75f/16.0f,
116 1.25f/16.0f, 1.25f/16.0f,
117 1.0f/16.0f, 1.0f/16.0f };
121 Toolkit::EffectsView EffectsView::New()
123 EffectsView* effectsView = new EffectsView;
125 Toolkit::EffectsView handle = Toolkit::EffectsView( *effectsView );
127 // Second-phase init of the implementation
128 // This can only be done after the CustomActor connection has been made...
129 effectsView->Initialize();
134 EffectsView::EffectsView()
135 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_NONE ) ),
136 mChildrenRoot(Actor::New()),
137 mBackgroundColor( EFFECTS_VIEW_DEFAULT_BACKGROUND_COLOR ),
138 mTargetSize( Vector2::ZERO ),
139 mLastSize( Vector2::ZERO ),
141 mEffectType( Toolkit::EffectsView::INVALID_TYPE ),
142 mPixelFormat( EFFECTS_VIEW_DEFAULT_PIXEL_FORMAT ),
144 mRefreshOnDemand(EFFECTS_VIEW_REFRESH_ON_DEMAND)
148 EffectsView::~EffectsView()
153 void EffectsView::SetType( Toolkit::EffectsView::EffectType type )
155 if( mEffectType != type )
160 Property::Map rendererMap;
161 rendererMap.Insert( "rendererType", "image" );
165 case Toolkit::EffectsView::DROP_SHADOW:
167 mFilters.PushBack( new SpreadFilter );
168 mFilters.PushBack( new BlurTwoPassFilter );
171 case Toolkit::EffectsView::EMBOSS:
173 mFilters.PushBack( new SpreadFilter );
174 mFilters.PushBack( new EmbossFilter );
175 mFilters.PushBack( new BlurTwoPassFilter );
184 Property::Map customShader;
185 customShader[ "vertexShader" ] = EFFECTS_VIEW_VERTEX_SOURCE;
186 customShader[ "fragmentShader" ] = EFFECTS_VIEW_FRAGMENT_SOURCE;
187 rendererMap[ "shader" ] = customShader;
188 Toolkit::RendererFactory::Get().ResetRenderer( mRendererPostFilter, self, rendererMap );
194 Toolkit::EffectsView::EffectType EffectsView::GetType() const
199 void EffectsView::Enable()
201 // make sure resources are allocated and start the render tasks processing
207 void EffectsView::Disable()
209 // stop render tasks processing
210 // Note: render target resources are automatically freed since we set the Image::Unused flag
215 void EffectsView::Refresh()
217 RefreshRenderTasks();
220 void EffectsView::SetRefreshOnDemand( bool onDemand )
222 mRefreshOnDemand = onDemand;
224 RefreshRenderTasks();
227 void EffectsView::SetPixelFormat( Pixel::Format pixelFormat )
229 mPixelFormat = pixelFormat;
232 void EffectsView::SetBackgroundColor( const Vector4& color )
234 mBackgroundColor = color;
237 Vector4 EffectsView::GetBackgroundColor() const
239 return mBackgroundColor;
242 void EffectsView::SetEffectSize( int effectSize )
244 mEffectSize = effectSize;
248 const size_t numFilters( mFilters.Size() );
249 for( size_t i = 0; i < numFilters; ++i )
251 mFilters[i]->Disable();
256 for( size_t i = 0; i < numFilters; ++i )
258 mFilters[i]->Enable();
263 int EffectsView::GetEffectSize()
269 void EffectsView::OnInitialize()
271 CustomActor self = Self();
272 mChildrenRoot.SetParentOrigin( ParentOrigin::CENTER );
273 self.Add( mChildrenRoot );
276 void EffectsView::OnSizeSet(const Vector3& targetSize)
278 Control::OnSizeSet( targetSize );
280 mTargetSize = Vector2(targetSize);
282 // if we are already on stage, need to update render target sizes now to reflect the new size of this actor
285 if( mLastSize != Vector2::ZERO )
292 mChildrenRoot.SetSize( targetSize );
295 void EffectsView::OnStageConnection( int depth )
297 Control::OnStageConnection( depth );
302 if( mRendererPostFilter )
304 mRendererPostFilter.SetOnStage( self );
306 if( mRendererForChildren )
308 mRendererForChildren.SetOnStage( self );
312 void EffectsView::OnStageDisconnection()
316 const size_t numFilters( mFilters.Size() );
317 for( size_t i = 0; i < numFilters; ++i )
319 mFilters[i]->Disable();
323 if( mRendererPostFilter )
325 mRendererPostFilter.SetOffStage( self );
327 if( mRendererForChildren )
329 mRendererForChildren.SetOffStage( self );
332 Control::OnStageDisconnection();
335 void EffectsView::OnChildAdd( Actor& child )
337 Control::OnChildAdd( child );
339 if( child != mChildrenRoot && child != mCameraForChildren )
341 mChildrenRoot.Add( child );
345 void EffectsView::OnChildRemove( Actor& child )
347 mChildrenRoot.Remove( child );
349 Control::OnChildRemove( child );
352 void EffectsView::SetupFilters()
354 switch( mEffectType )
356 case Toolkit::EffectsView::DROP_SHADOW:
358 SpreadFilter* spreadFilter = static_cast< SpreadFilter* >( mFilters[0] );
359 spreadFilter->SetInputImage( mImageForChildren );
360 spreadFilter->SetOutputImage( mImagePostFilter );
361 spreadFilter->SetRootActor( mChildrenRoot );
362 spreadFilter->SetBackgroundColor( mBackgroundColor );
363 spreadFilter->SetPixelFormat( mPixelFormat );
364 spreadFilter->SetSize( mTargetSize );
365 spreadFilter->SetSpread( mEffectSize );
367 BlurTwoPassFilter* blurFilter = static_cast< BlurTwoPassFilter* >( mFilters[1] );
368 blurFilter->SetInputImage( mImagePostFilter );
369 blurFilter->SetOutputImage( mImagePostFilter );
370 blurFilter->SetRootActor( mChildrenRoot );
371 blurFilter->SetBackgroundColor( mBackgroundColor );
372 blurFilter->SetPixelFormat( mPixelFormat );
373 blurFilter->SetSize( mTargetSize );
375 const float* kernel(NULL);
376 size_t kernelSize(0);
377 switch( mEffectSize )
379 case 4: { kernel = BLUR_KERNEL4; kernelSize = sizeof(BLUR_KERNEL4)/sizeof(BLUR_KERNEL4[0]); break; }
380 case 3: { kernel = BLUR_KERNEL3; kernelSize = sizeof(BLUR_KERNEL3)/sizeof(BLUR_KERNEL3[0]); break; }
381 case 2: { kernel = BLUR_KERNEL2; kernelSize = sizeof(BLUR_KERNEL2)/sizeof(BLUR_KERNEL2[0]); break; }
382 case 1: { kernel = BLUR_KERNEL1; kernelSize = sizeof(BLUR_KERNEL1)/sizeof(BLUR_KERNEL1[0]); break; }
384 default: { kernel = BLUR_KERNEL0; kernelSize = sizeof(BLUR_KERNEL0)/sizeof(BLUR_KERNEL0[0]); break; }
386 blurFilter->CreateKernel( kernel, kernelSize );
389 case Toolkit::EffectsView::EMBOSS:
391 SpreadFilter* spreadFilter = static_cast< SpreadFilter* >( mFilters[0] );
392 spreadFilter->SetInputImage( mImageForChildren );
393 spreadFilter->SetOutputImage( mImagePostFilter );
394 spreadFilter->SetRootActor( mChildrenRoot );
395 spreadFilter->SetBackgroundColor( mBackgroundColor );
396 spreadFilter->SetPixelFormat( Pixel::RGBA8888 );
397 spreadFilter->SetSize( mTargetSize );
398 spreadFilter->SetSpread( mEffectSize );
400 EmbossFilter* embossFilter = static_cast< EmbossFilter* >( mFilters[1] );
401 embossFilter->SetInputImage( mImagePostFilter );
402 embossFilter->SetOutputImage( mImagePostFilter );
403 embossFilter->SetRootActor( mChildrenRoot );
404 embossFilter->SetBackgroundColor( mBackgroundColor );
405 embossFilter->SetPixelFormat( Pixel::RGBA8888 );
406 embossFilter->SetSize( mTargetSize );
408 BlurTwoPassFilter* blurFilter = static_cast< BlurTwoPassFilter* >( mFilters[2] );
409 blurFilter->SetInputImage( mImagePostFilter );
410 blurFilter->SetOutputImage( mImagePostFilter );
411 blurFilter->SetRootActor( mChildrenRoot );
412 blurFilter->SetBackgroundColor( Vector4( 0.5f, 0.5f, 0.5f, 0.0 ) );
413 blurFilter->SetPixelFormat( Pixel::RGBA8888 );
414 blurFilter->SetSize( mTargetSize );
415 blurFilter->CreateKernel( BLUR_KERNEL0, sizeof(BLUR_KERNEL0)/sizeof(BLUR_KERNEL0[0]) );
425 void EffectsView::AllocateResources()
427 if(mTargetSize != mLastSize)
429 mLastSize = mTargetSize;
432 Toolkit::RendererFactory rendererFactory = Toolkit::RendererFactory::Get();
435 mImageForChildren = FrameBufferImage::New( mTargetSize.width, mTargetSize.height, mPixelFormat, Dali::Image::UNUSED );
436 rendererFactory.ResetRenderer(mRendererForChildren, self, mImageForChildren);
437 mRendererForChildren.SetDepthIndex( DepthIndex::CONTENT+1 );
439 mImagePostFilter = FrameBufferImage::New( mTargetSize.width, mTargetSize.height, mPixelFormat, Dali::Image::UNUSED );
440 rendererFactory.ResetRenderer(mRendererPostFilter, self, mImagePostFilter);
441 mRendererPostFilter.SetDepthIndex( DepthIndex::CONTENT );
447 void EffectsView::SetupCameras()
449 if( !mCameraForChildren )
451 // Create a camera for the children render, corresponding to its render target size
452 mCameraForChildren = CameraActor::New(mTargetSize);
453 mCameraForChildren.SetParentOrigin(ParentOrigin::CENTER);
454 mCameraForChildren.SetInvertYAxis( true );
455 Self().Add( mCameraForChildren );
459 // place the camera for the children render, corresponding to its render target size
460 const float cameraPosScale( 0.5f / tanf(ARBITRARY_FIELD_OF_VIEW * 0.5f) );
461 mCameraForChildren.SetFieldOfView(ARBITRARY_FIELD_OF_VIEW);
462 mCameraForChildren.SetNearClippingPlane(1.0f);
463 mCameraForChildren.SetAspectRatio(mTargetSize.width / mTargetSize.height);
464 mCameraForChildren.SetType(Dali::Camera::FREE_LOOK); // camera orientation based solely on actor
465 mCameraForChildren.SetPosition(0.0f, 0.0f, mTargetSize.height * cameraPosScale);
466 mCameraForChildren.SetZ( mTargetSize.height * cameraPosScale );
470 void EffectsView::CreateRenderTasks()
472 if( mTargetSize == Vector2::ZERO )
476 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
478 // create render task to render our child actors to offscreen buffer
479 mRenderTaskForChildren = taskList.CreateTask();
480 mRenderTaskForChildren.SetRefreshRate( mRefreshOnDemand ? RenderTask::REFRESH_ONCE : RenderTask::REFRESH_ALWAYS );
481 mRenderTaskForChildren.SetSourceActor( mChildrenRoot );
482 mRenderTaskForChildren.SetExclusive(true);
483 mRenderTaskForChildren.SetInputEnabled( false );
484 mRenderTaskForChildren.SetClearColor( mBackgroundColor );
485 mRenderTaskForChildren.SetClearEnabled( true );
486 mRenderTaskForChildren.SetTargetFrameBuffer( mImageForChildren );
487 mRenderTaskForChildren.SetCameraActor(mCameraForChildren); // use camera that covers render target exactly
489 // Enable image filters
490 const size_t numFilters( mFilters.Size() );
491 for( size_t i = 0; i < numFilters; ++i )
493 mFilters[i]->Enable();
497 void EffectsView::RemoveRenderTasks()
499 if( mTargetSize == Vector2::ZERO )
504 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
506 taskList.RemoveTask(mRenderTaskForChildren);
508 const size_t numFilters( mFilters.Size() );
509 for( size_t i = 0; i < numFilters; ++i )
511 mFilters[i]->Disable();
515 void EffectsView::RefreshRenderTasks()
517 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
519 if( mRenderTaskForChildren )
521 mRenderTaskForChildren.SetRefreshRate( mRefreshOnDemand ? RenderTask::REFRESH_ONCE : RenderTask::REFRESH_ALWAYS );
524 const size_t numFilters( mFilters.Size() );
525 for( size_t i = 0; i < numFilters; ++i )
527 mFilters[i]->Refresh();
531 void EffectsView::RemoveFilters()
533 const size_t numFilters( mFilters.Size() );
534 for( size_t i = 0; i < numFilters; ++i )
541 void EffectsView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
543 Toolkit::EffectsView effectsView = Toolkit::EffectsView::DownCast( Dali::BaseHandle( object ) );
549 case Toolkit::EffectsView::Property::EFFECT_SIZE:
552 if( value.Get( effectSize ) )
554 GetImpl( effectsView ).SetEffectSize( effectSize );
566 Property::Value EffectsView::GetProperty( BaseObject* object, Property::Index propertyIndex )
568 Property::Value value;
570 Toolkit::EffectsView imageview = Toolkit::EffectsView::DownCast( Dali::BaseHandle( object ) );
574 EffectsView& impl = GetImpl( imageview );
575 switch ( propertyIndex )
577 case Toolkit::EffectsView::Property::EFFECT_SIZE:
579 value = impl.GetEffectSize();
592 } // namespace Internal
594 } // namespace Toolkit