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/visuals/visual-properties-devel.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
135 uniform lowp vec4 mixColor;\n
136 uniform lowp float preMultipliedAlpha;\n
138 lowp vec4 visualMixColor()\n
140 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
144 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
148 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
149 varying mediump vec2 vTexCoord;\n
150 uniform sampler2D sTexture;\n
151 uniform mediump vec4 uAtlasRect;\n
152 uniform lowp vec4 uColor;\n
153 uniform lowp vec4 mixColor;\n
154 uniform lowp float preMultipliedAlpha;\n
156 lowp vec4 visualMixColor()\n
158 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
163 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
164 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
168 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
169 varying mediump vec2 vTexCoord;\n
170 uniform sampler2D sTexture;\n
171 uniform mediump vec4 uAtlasRect;\n
172 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
173 uniform lowp vec2 wrapMode;\n
174 uniform lowp vec4 uColor;\n
175 uniform lowp vec4 mixColor;\n
176 uniform lowp float preMultipliedAlpha;\n
178 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
180 mediump float coord;\n
181 if( wrap > 1.5 )\n // REFLECT
182 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
183 else \n// warp == 0 or 1
184 coord = mix(coordinate, fract( coordinate ), wrap);\n
185 return clamp( mix(range.x, range.y, coord), range.x, range.y );
188 lowp vec4 visualMixColor()\n
190 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
195 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
196 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
197 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
201 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
205 if( gridSize == ImageDimensions( 1, 1 ) )
207 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
211 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
217 } // unnamed namespace
219 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
220 const std::string& imageUrl,
221 const Property::Map& properties,
222 ImageDimensions size,
223 FittingMode::Type fittingMode,
224 Dali::SamplingMode::Type samplingMode )
226 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
227 imageVisualPtr->SetProperties( properties );
228 return imageVisualPtr;
231 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
232 const std::string& imageUrl,
233 ImageDimensions size,
234 FittingMode::Type fittingMode,
235 Dali::SamplingMode::Type samplingMode )
237 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
240 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
242 return new ImageVisual( factoryCache, image );
245 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
246 const std::string& imageUrl,
247 ImageDimensions size,
248 FittingMode::Type fittingMode,
249 Dali::SamplingMode::Type samplingMode )
250 : Visual::Base( factoryCache ),
253 mPixelArea( FULL_TEXTURE_RECT ),
255 mImageUrl( imageUrl ),
256 mDesiredSize( size ),
257 mFittingMode( fittingMode ),
258 mSamplingMode( samplingMode ),
259 mWrapModeU( WrapMode::DEFAULT ),
260 mWrapModeV( WrapMode::DEFAULT )
264 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
265 : Visual::Base( factoryCache ),
268 mPixelArea( FULL_TEXTURE_RECT ),
272 mFittingMode( FittingMode::DEFAULT ),
273 mSamplingMode( SamplingMode::DEFAULT ),
274 mWrapModeU( WrapMode::DEFAULT ),
275 mWrapModeV( WrapMode::DEFAULT )
279 ImageVisual::~ImageVisual()
283 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
285 // Url is already received in constructor
286 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
288 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
289 if( keyValue.first.type == Property::Key::INDEX )
291 DoSetProperty( keyValue.first.indexKey, keyValue.second );
295 if( keyValue.first == IMAGE_FITTING_MODE )
297 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
299 else if( keyValue.first == IMAGE_SAMPLING_MODE )
301 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
303 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
305 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
307 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
309 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
311 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
313 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
315 else if( keyValue.first == IMAGE_WRAP_MODE_U )
317 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
319 else if( keyValue.first == IMAGE_WRAP_MODE_V )
321 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
323 else if( keyValue.first == SYNCHRONOUS_LOADING )
325 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
330 if( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING && mImageUrl.size() > 0u )
332 // if sync loading is required, the loading should start
333 // immediately when new image url is set or the actor is off stage
334 // ( for on-stage actor with image url unchanged, resource loading
335 // is already finished )
336 LoadResourceSynchronously();
340 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
344 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
347 if( value.Get( sync ) )
351 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
355 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
360 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
365 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
368 if( value.Get( desiredWidth ) )
370 mDesiredSize.SetWidth( desiredWidth );
374 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
379 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
382 if( value.Get( desiredHeight ) )
384 mDesiredSize.SetHeight( desiredHeight );
388 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
393 case Toolkit::ImageVisual::Property::FITTING_MODE:
396 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
397 mFittingMode = Dali::FittingMode::Type( fittingMode );
401 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
404 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
405 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
409 case Toolkit::ImageVisual::Property::PIXEL_AREA:
411 value.Get( mPixelArea );
415 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
418 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
419 mWrapModeU = Dali::WrapMode::Type( wrapMode );
423 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
426 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
427 mWrapModeV = Dali::WrapMode::Type( wrapMode );
433 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
437 naturalSize.x = mImage.GetWidth();
438 naturalSize.y = mImage.GetHeight();
441 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
443 naturalSize.x = mDesiredSize.GetWidth();
444 naturalSize.y = mDesiredSize.GetHeight();
447 else if( !mImageUrl.empty() )
449 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
450 naturalSize.x = dimentions.GetWidth();
451 naturalSize.y = dimentions.GetHeight();
455 naturalSize = Vector2::ZERO;
458 void ImageVisual::CreateRenderer( TextureSet& textures )
463 if( !mImpl->mCustomShader )
465 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
467 shader = GetImageShader( mFactoryCache,
468 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
469 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
473 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
474 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
476 shader = GetImageShader( mFactoryCache, false, true );
480 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
481 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
482 mImpl->mCustomShader->mHints );
483 if( mImpl->mCustomShader->mVertexShader.empty() )
485 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
490 mImpl->mRenderer = Renderer::New( geometry, shader );
491 DALI_ASSERT_DEBUG( textures );
492 mImpl->mRenderer.SetTextures( textures );
494 //Register transform properties
495 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
498 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
503 std::string fragmentShader;
504 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
505 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
508 fragmentShader = fragmentPreFix;
509 fragmentShader += "\n";
511 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
513 fragmentShader += mImpl->mCustomShader->mFragmentShader;
517 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
519 if( customSamplerTypename )
521 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
524 if( !mImpl->mCustomShader )
526 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
528 shader = Shader::New( VERTEX_SHADER, fragmentShader );
529 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
533 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
534 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
536 mImpl->mCustomShader->mHints );
537 if( mImpl->mCustomShader->mVertexShader.empty() )
539 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
543 mImpl->mRenderer = Renderer::New( geometry, shader );
545 //Register transform properties
546 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
550 bool ImageVisual::IsSynchronousResourceLoading() const
552 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
555 void ImageVisual::LoadResourceSynchronously()
557 if( !mImageUrl.empty() )
559 BitmapLoader loader = BitmapLoader::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
561 mPixels = loader.GetPixelData();
565 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing )
567 TextureSet textureSet;
568 textureRect = FULL_TEXTURE_RECT;
569 if( synchronousLoading )
574 textureSet = TextureSet::New();
575 TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
579 if( attemptAtlasing )
581 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
582 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
584 if( !textureSet ) // big image, no atlasing or atlasing failed
586 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
587 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
588 mPixels.GetWidth(), mPixels.GetHeight() );
589 texture.Upload( mPixels );
590 textureSet = TextureSet::New();
591 textureSet.SetTexture( 0u, texture );
597 if( attemptAtlasing )
599 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, url, mDesiredSize, mFittingMode, true, this );
600 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
602 if( !textureSet ) // big image, no atlasing or atlasing failed
604 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
605 ResourceImage resourceImage = Dali::ResourceImage::New( url, mDesiredSize, mFittingMode, mSamplingMode );
606 resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
607 textureSet = TextureSet::New();
608 TextureSetImage( textureSet, 0u, resourceImage );
612 if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
614 Sampler sampler = Sampler::New();
615 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
616 textureSet.SetSampler( 0u, sampler );
621 void ImageVisual::InitializeRenderer( const std::string& imageUrl )
623 mImageUrl = imageUrl;
624 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
626 if( !mImpl->mCustomShader &&
627 ( strncasecmp( imageUrl.c_str(), HTTP_URL, sizeof(HTTP_URL) -1 ) != 0 ) && // dont atlas remote images
628 ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
630 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
631 bool defaultTransform = mImpl->mTransform.mSize == Vector2::ONE &&
632 mImpl->mTransform.mOffset == Vector2::ZERO &&
633 mImpl->mTransform.mOffsetSizeMode == Vector4::ZERO &&
634 mImpl->mTransform.mOrigin == Toolkit::Align::CENTER &&
635 mImpl->mTransform.mAnchorPoint == Toolkit::Align::CENTER;
637 bool cacheable = defaultWrapMode && defaultTransform && mPixelArea == FULL_TEXTURE_RECT;
640 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
641 if( cacheable ) // fetch the renderer from cache if exist
643 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
644 mImpl->mFlags |= Impl::IS_FROM_CACHE;
647 if( !mImpl->mRenderer ) // new renderer is needed
650 // texture set has to be created first as we need to know if atlasing succeeded or not
651 // when selecting the shader
652 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), true );
653 CreateRenderer( textures );
655 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
657 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
658 if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
660 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
661 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
662 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
666 // save the renderer to cache only when default wrap mode and default pixel area is used
669 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
675 // for custom shader or remote image, renderer is not cached and atlas is not applied
676 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
677 Vector4 atlasRect; // ignored in this case
678 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), false );
679 CreateRenderer( textures );
683 void ImageVisual::InitializeRenderer( const Image& image )
685 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
687 // don't reuse CreateTextureSet
688 TextureSet textures = TextureSet::New();
689 // Renderer can't be shared if mImage is NativeImage
690 NativeImage nativeImage = NativeImage::DownCast( image );
693 CreateNativeImageRenderer( nativeImage );
694 DALI_ASSERT_DEBUG( textures );
695 mImpl->mRenderer.SetTextures( textures );
699 // reuse existing code for regular images
700 CreateRenderer( textures );
702 ApplyImageToSampler( image );
705 void ImageVisual::UploadCompleted()
707 // Resource image is loaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
708 Actor actor = mPlacementActor.GetHandle();
711 actor.AddRenderer( mImpl->mRenderer );
712 // reset the weak handle so that the renderer only get added to actor once
713 mPlacementActor.Reset();
717 void ImageVisual::DoSetOnStage( Actor& actor )
719 if( !mImageUrl.empty() )
721 InitializeRenderer( mImageUrl );
725 InitializeRenderer( mImage );
728 if ( !mImpl->mRenderer )
733 mPlacementActor = actor;
735 if( mPixelArea != FULL_TEXTURE_RECT )
737 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
740 if( IsSynchronousResourceLoading() || !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
742 actor.AddRenderer( mImpl->mRenderer );
743 mPlacementActor.Reset();
747 void ImageVisual::DoSetOffStage( Actor& actor )
749 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
751 //If we own the image then make sure we release it when we go off stage
752 actor.RemoveRenderer( mImpl->mRenderer);
753 if( !mImageUrl.empty() )
755 CleanCache(mImageUrl);
759 mImpl->mRenderer.Reset();
760 mPlacementActor.Reset();
763 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
766 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
768 bool sync = IsSynchronousResourceLoading();
769 map.Insert( SYNCHRONOUS_LOADING, sync );
770 if( !mImageUrl.empty() )
772 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
773 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
774 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
778 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
779 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
781 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
784 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
788 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
789 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
791 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
792 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
793 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
796 void ImageVisual::OnSetTransform()
798 if( mImpl->mRenderer )
800 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
804 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
809 if( defaultTextureWrapping )
811 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
814 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
815 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
816 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
821 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
824 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
825 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
826 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
832 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
835 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
836 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
837 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
844 void ImageVisual::ApplyImageToSampler( const Image& image )
848 TextureSet textureSet = mImpl->mRenderer.GetTextures();
849 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
851 TextureSetImage( textureSet, 0u, image );
852 Sampler sampler = Sampler::New();
853 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
854 textureSet.SetSampler( 0u, sampler );
858 void ImageVisual::OnImageLoaded( ResourceImage image )
860 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
862 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
863 if( mImpl->mRenderer )
865 ApplyImageToSampler( brokenImage );
870 void ImageVisual::CleanCache(const std::string& url)
874 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
875 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
876 if( index != Property::INVALID_INDEX )
878 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
879 atlasRectValue.Get( atlasRect );
882 TextureSet textureSet = mImpl->mRenderer.GetTextures();
883 mImpl->mRenderer.Reset();
884 if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
886 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
891 } // namespace Internal
893 } // namespace Toolkit