2 * Copyright (c) 2016 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 <dali-toolkit/internal/visuals/image/image-visual.h>
22 #include <cstring> // for strncasecmp
23 #include <dali/public-api/images/resource-image.h>
24 #include <dali/public-api/images/native-image.h>
25 #include <dali/devel-api/images/atlas.h>
26 #include <dali/devel-api/images/texture-set-image.h>
27 #include <dali/devel-api/adaptor-framework/bitmap-loader.h>
28 #include <dali/devel-api/scripting/enum-helper.h>
29 #include <dali/devel-api/scripting/scripting.h>
30 #include <dali/integration-api/debug.h>
33 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
34 #include <dali-toolkit/devel-api/visual-factory/devel-visual-properties.h>
35 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
37 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
38 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
39 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
40 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
53 const char HTTP_URL[] = "http://";
54 const char HTTPS_URL[] = "https://";
57 const char * const IMAGE_FITTING_MODE( "fittingMode" );
58 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
59 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
60 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
61 const char * const IMAGE_WRAP_MODE_U("wrapModeU");
62 const char * const IMAGE_WRAP_MODE_V("wrapModeV");
63 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
64 const char * const BATCHING_ENABLED( "batchingEnabled" );
67 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
73 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
76 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
83 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
84 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
87 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
90 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
91 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
92 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
94 const std::string PIXEL_AREA_UNIFORM_NAME = "pixelArea";
95 const std::string WRAP_MODE_UNIFORM_NAME = "wrapMode";
97 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
99 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
101 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
102 attribute mediump vec2 aPosition;\n
103 uniform mediump mat4 uMvpMatrix;\n
104 uniform mediump vec3 uSize;\n
105 uniform mediump vec4 pixelArea;
106 varying mediump vec2 vTexCoord;\n
109 //Visual size and offset
110 uniform mediump vec2 offset;\n
111 uniform mediump vec2 size;\n
112 uniform mediump vec4 offsetSizeMode;\n
113 uniform mediump vec2 origin;\n
114 uniform mediump vec2 anchorPoint;\n
116 vec4 ComputeVertexPosition()\n
118 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
119 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
120 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
125 mediump vec4 vertexPosition = uMvpMatrix *ComputeVertexPosition();\n
126 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
127 gl_Position = vertexPosition;\n
131 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
132 varying mediump vec2 vTexCoord;\n
133 uniform sampler2D sTexture;\n
134 uniform lowp vec4 uColor;\n
138 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
142 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
143 varying mediump vec2 vTexCoord;\n
144 uniform sampler2D sTexture;\n
145 uniform mediump vec4 uAtlasRect;\n
146 uniform lowp vec4 uColor;\n
150 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
151 gl_FragColor = texture2D( sTexture, texCoord ) * uColor;\n
155 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
156 varying mediump vec2 vTexCoord;\n
157 uniform sampler2D sTexture;\n
158 uniform mediump vec4 uAtlasRect;\n
159 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
160 uniform lowp vec2 wrapMode;\n
161 uniform lowp vec4 uColor;\n
163 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
165 mediump float coord;\n
166 if( wrap > 1.5 )\n // REFLECT
167 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
168 else \n// warp == 0 or 1
169 coord = mix(coordinate, fract( coordinate ), wrap);\n
170 return clamp( mix(range.x, range.y, coord), range.x, range.y );
175 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
176 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
177 gl_FragColor = texture2D( sTexture, texCoord ) * uColor;\n
181 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
185 if( gridSize == ImageDimensions( 1, 1 ) )
187 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
190 geometry = VisualFactoryCache::CreateQuadGeometry();
191 factoryCache.SaveGeometry( VisualFactoryCache::QUAD_GEOMETRY, geometry );
196 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
202 } // unnamed namespace
204 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
205 const std::string& imageUrl,
206 ImageDimensions size,
207 FittingMode::Type fittingMode,
208 Dali::SamplingMode::Type samplingMode )
210 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
213 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
215 return new ImageVisual( factoryCache, image );
218 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
219 const std::string& imageUrl,
220 ImageDimensions size,
221 FittingMode::Type fittingMode,
222 Dali::SamplingMode::Type samplingMode )
223 : Visual::Base( factoryCache ),
226 mPixelArea( FULL_TEXTURE_RECT ),
228 mImageUrl( imageUrl ),
229 mDesiredSize( size ),
230 mFittingMode( fittingMode ),
231 mSamplingMode( samplingMode ),
232 mWrapModeU( WrapMode::DEFAULT ),
233 mWrapModeV( WrapMode::DEFAULT )
237 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
238 : Visual::Base( factoryCache ),
241 mPixelArea( FULL_TEXTURE_RECT ),
245 mFittingMode( FittingMode::DEFAULT ),
246 mSamplingMode( SamplingMode::DEFAULT ),
247 mWrapModeU( WrapMode::DEFAULT ),
248 mWrapModeV( WrapMode::DEFAULT )
252 ImageVisual::~ImageVisual()
256 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
258 // Url is already received in constructor
259 Property::Value* fittingValue = propertyMap.Find( Toolkit::ImageVisual::Property::FITTING_MODE, IMAGE_FITTING_MODE );
263 Scripting::GetEnumerationProperty( *fittingValue, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, value );
264 mFittingMode = Dali::FittingMode::Type( value );
267 Property::Value* samplingValue = propertyMap.Find( Toolkit::ImageVisual::Property::SAMPLING_MODE, IMAGE_SAMPLING_MODE );
271 Scripting::GetEnumerationProperty( *samplingValue, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, value );
272 mSamplingMode = Dali::SamplingMode::Type( value );
275 int desiredWidth = 0;
276 Property::Value* desiredWidthValue = propertyMap.Find( Toolkit::ImageVisual::Property::DESIRED_WIDTH, IMAGE_DESIRED_WIDTH );
277 if( desiredWidthValue )
279 desiredWidthValue->Get( desiredWidth );
282 int desiredHeight = 0;
283 Property::Value* desiredHeightValue = propertyMap.Find( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, IMAGE_DESIRED_HEIGHT );
284 if( desiredHeightValue )
286 desiredHeightValue->Get( desiredHeight );
289 Property::Value* pixelAreaValue = propertyMap.Find( Toolkit::ImageVisual::Property::PIXEL_AREA, PIXEL_AREA_UNIFORM_NAME );
292 pixelAreaValue->Get( mPixelArea );
295 Property::Value* wrapModeValueU = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_U, IMAGE_WRAP_MODE_U );
299 Scripting::GetEnumerationProperty( *wrapModeValueU, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, value );
300 mWrapModeU = Dali::WrapMode::Type( value );
303 Property::Value* wrapModeValueV = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_V, IMAGE_WRAP_MODE_V );
307 Scripting::GetEnumerationProperty( *wrapModeValueV, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, value );
308 mWrapModeV = Dali::WrapMode::Type( value );
311 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
313 Property::Value* syncLoading = propertyMap.Find( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, SYNCHRONOUS_LOADING );
317 syncLoading->Get( sync );
320 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
321 // if sync loading is required, the loading should start immediately when new image url is set or the actor is off stage
322 // ( for on-stage actor with image url unchanged, resource loading is already finished)
323 if( mImageUrl.size() > 0u )
325 LoadResourceSynchronously();
330 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
335 void ImageVisual::GetNaturalSize( Vector2& naturalSize ) const
339 naturalSize.x = mImage.GetWidth();
340 naturalSize.y = mImage.GetHeight();
343 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
345 naturalSize.x = mDesiredSize.GetWidth();
346 naturalSize.y = mDesiredSize.GetHeight();
349 else if( !mImageUrl.empty() )
351 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
352 naturalSize.x = dimentions.GetWidth();
353 naturalSize.y = dimentions.GetHeight();
357 naturalSize = Vector2::ZERO;
360 void ImageVisual::CreateRenderer( TextureSet& textures )
365 if( !mImpl->mCustomShader )
367 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
369 shader = GetImageShader( mFactoryCache,
370 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
371 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
375 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
376 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
378 shader = GetImageShader( mFactoryCache, false, true );
382 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
383 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
384 mImpl->mCustomShader->mHints );
385 if( mImpl->mCustomShader->mVertexShader.empty() )
387 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
392 mImpl->mRenderer = Renderer::New( geometry, shader );
393 DALI_ASSERT_DEBUG( textures );
394 mImpl->mRenderer.SetTextures( textures );
396 //Register transform properties
397 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
400 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
405 std::string fragmentShader;
406 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
407 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
410 fragmentShader = fragmentPreFix;
411 fragmentShader += "\n";
413 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
415 fragmentShader += mImpl->mCustomShader->mFragmentShader;
419 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
421 if( customSamplerTypename )
423 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
426 if( !mImpl->mCustomShader )
428 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
430 shader = Shader::New( VERTEX_SHADER, fragmentShader );
431 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
435 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
436 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
438 mImpl->mCustomShader->mHints );
439 if( mImpl->mCustomShader->mVertexShader.empty() )
441 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
445 mImpl->mRenderer = Renderer::New( geometry, shader );
447 //Register transform properties
448 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
452 bool ImageVisual::IsSynchronousResourceLoading() const
454 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
457 void ImageVisual::LoadResourceSynchronously()
459 if( !mImageUrl.empty() )
461 BitmapLoader loader = BitmapLoader::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
463 mPixels = loader.GetPixelData();
467 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing )
469 TextureSet textureSet;
470 textureRect = FULL_TEXTURE_RECT;
471 if( synchronousLoading )
476 textureSet = TextureSet::New();
477 TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
481 if( attemptAtlasing )
483 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
484 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
486 if( !textureSet ) // big image, no atlasing or atlasing failed
488 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
489 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
490 mPixels.GetWidth(), mPixels.GetHeight() );
491 texture.Upload( mPixels );
492 textureSet = TextureSet::New();
493 textureSet.SetTexture( 0u, texture );
499 if( attemptAtlasing )
501 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, url, mDesiredSize, mFittingMode, true, this );
502 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
504 if( !textureSet ) // big image, no atlasing or atlasing failed
506 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
507 ResourceImage resourceImage = Dali::ResourceImage::New( url, mDesiredSize, mFittingMode, mSamplingMode );
508 resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
509 textureSet = TextureSet::New();
510 TextureSetImage( textureSet, 0u, resourceImage );
514 if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
516 Sampler sampler = Sampler::New();
517 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
518 textureSet.SetSampler( 0u, sampler );
523 void ImageVisual::InitializeRenderer( const std::string& imageUrl )
525 mImpl->mRenderer.Reset();
527 mImageUrl = imageUrl;
528 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
530 if( !mImpl->mCustomShader &&
531 ( strncasecmp( imageUrl.c_str(), HTTP_URL, sizeof(HTTP_URL) -1 ) != 0 ) && // ignore remote images
532 ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
534 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
535 bool defaultTransform = mImpl->mTransform.mSize == Vector2::ONE &&
536 mImpl->mTransform.mOffset == Vector2::ZERO &&
537 mImpl->mTransform.mOffsetSizeMode == Vector4::ZERO &&
538 mImpl->mTransform.mOrigin == Toolkit::Align::CENTER &&
539 mImpl->mTransform.mAnchorPoint == Toolkit::Align::CENTER;
541 bool cacheable = defaultWrapMode && defaultTransform && mPixelArea == FULL_TEXTURE_RECT;
544 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
545 if( cacheable ) // fetch the renderer from cache if exist
547 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
548 mImpl->mFlags |= Impl::IS_FROM_CACHE;
551 if( !mImpl->mRenderer ) // new renderer is needed
554 // texture set has to be created first as we need to know if atlasing succeeded or not
555 // when selecting the shader
556 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), true );
557 CreateRenderer( textures );
559 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
561 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
562 if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
564 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
565 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
566 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
570 // save the renderer to cache only when default wrap mode and default pixel area is used
573 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
579 // for custom shader or remote image, renderer is not cached and atlas is not applied
580 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
581 Vector4 atlasRect; // ignored in this case
582 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), false );
583 CreateRenderer( textures );
587 void ImageVisual::InitializeRenderer( const Image& image )
589 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
590 mImpl->mRenderer.Reset();
592 // don't reuse CreateTextureSet
593 TextureSet textures = TextureSet::New();
594 // Renderer can't be shared if mImage is NativeImage
595 NativeImage nativeImage = NativeImage::DownCast( image );
598 CreateNativeImageRenderer( nativeImage );
599 DALI_ASSERT_DEBUG( textures );
600 mImpl->mRenderer.SetTextures( textures );
604 // reuse existing code for regular images
605 CreateRenderer( textures );
607 ApplyImageToSampler( image );
610 void ImageVisual::UploadCompleted()
612 // Resource image is loaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
613 Actor actor = mPlacementActor.GetHandle();
616 actor.AddRenderer( mImpl->mRenderer );
617 // reset the weak handle so that the renderer only get added to actor once
618 mPlacementActor.Reset();
622 void ImageVisual::DoSetOnStage( Actor& actor )
624 if( !mImageUrl.empty() )
626 InitializeRenderer( mImageUrl );
630 InitializeRenderer( mImage );
633 if ( !mImpl->mRenderer)
638 mPlacementActor = actor;
640 if( mPixelArea != FULL_TEXTURE_RECT )
642 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
645 if( IsSynchronousResourceLoading() || !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
647 actor.AddRenderer( mImpl->mRenderer );
648 mPlacementActor.Reset();
652 void ImageVisual::DoSetOffStage( Actor& actor )
654 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
656 //If we own the image then make sure we release it when we go off stage
657 actor.RemoveRenderer( mImpl->mRenderer);
658 if( !mImageUrl.empty() )
660 CleanCache(mImageUrl);
664 mImpl->mRenderer.Reset();
665 mPlacementActor.Reset();
668 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
671 map.Insert( Toolkit::VisualProperty::TYPE, Toolkit::Visual::IMAGE );
673 bool sync = IsSynchronousResourceLoading();
674 map.Insert( SYNCHRONOUS_LOADING, sync );
675 if( !mImageUrl.empty() )
677 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
678 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
679 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
683 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
684 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
686 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
689 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
693 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
694 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
696 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
697 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
698 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
701 void ImageVisual::DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
703 // This is where specific Properties can be set.
706 Dali::Property::Value ImageVisual::DoGetProperty( Dali::Property::Index index )
708 Dali::Property::Value value;
712 case Toolkit::ImageVisual::Property::URL:
726 void ImageVisual::OnSetTransform()
728 if( mImpl->mRenderer )
730 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
734 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
739 if( defaultTextureWrapping )
741 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
744 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
745 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
750 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
753 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
754 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
760 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
763 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
764 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
767 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
771 void ImageVisual::ApplyImageToSampler( const Image& image )
775 TextureSet textureSet = mImpl->mRenderer.GetTextures();
776 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
778 TextureSetImage( textureSet, 0u, image );
779 Sampler sampler = Sampler::New();
780 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
781 textureSet.SetSampler( 0u, sampler );
785 void ImageVisual::OnImageLoaded( ResourceImage image )
787 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
789 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
790 if( mImpl->mRenderer )
792 ApplyImageToSampler( brokenImage );
797 void ImageVisual::CleanCache(const std::string& url)
801 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
802 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
803 if( index != Property::INVALID_INDEX )
805 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
806 atlasRectValue.Get( atlasRect );
809 TextureSet textureSet = mImpl->mRenderer.GetTextures();
810 mImpl->mRenderer.Reset();
811 if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
813 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
818 } // namespace Internal
820 } // namespace Toolkit