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/texture-set-image.h>
26 #include <dali/devel-api/adaptor-framework/bitmap-loader.h>
27 #include <dali/devel-api/scripting/enum-helper.h>
28 #include <dali/devel-api/scripting/scripting.h>
29 #include <dali/integration-api/debug.h>
32 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
33 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
35 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
37 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
38 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
39 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
52 const char HTTP_URL[] = "http://";
53 const char HTTPS_URL[] = "https://";
56 const char * const IMAGE_FITTING_MODE( "fittingMode" );
57 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
58 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
59 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
60 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
63 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
64 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
65 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
66 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
67 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
69 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
72 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
73 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
74 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
75 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
76 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
80 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
83 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
84 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
85 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
86 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
87 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
88 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
90 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
92 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
94 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
95 attribute mediump vec2 aPosition;\n
96 uniform mediump mat4 uMvpMatrix;\n
97 uniform mediump vec3 uSize;\n
98 uniform mediump vec4 pixelArea;
99 varying mediump vec2 vTexCoord;\n
102 //Visual size and offset
103 uniform mediump vec2 offset;\n
104 uniform mediump vec2 size;\n
105 uniform mediump vec4 offsetSizeMode;\n
106 uniform mediump vec2 origin;\n
107 uniform mediump vec2 anchorPoint;\n
109 vec4 ComputeVertexPosition()\n
111 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
112 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
113 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
118 mediump vec4 vertexPosition = uMvpMatrix * ComputeVertexPosition();\n
119 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
120 gl_Position = vertexPosition;\n
124 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
125 varying mediump vec2 vTexCoord;\n
126 uniform sampler2D sTexture;\n
127 uniform lowp vec4 uColor;\n
128 uniform lowp vec4 mixColor;\n
129 uniform lowp float preMultipliedAlpha;\n
131 lowp vec4 visualMixColor()\n
133 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
137 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
141 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
142 varying mediump vec2 vTexCoord;\n
143 uniform sampler2D sTexture;\n
144 uniform mediump vec4 uAtlasRect;\n
145 uniform lowp vec4 uColor;\n
146 uniform lowp vec4 mixColor;\n
147 uniform lowp float preMultipliedAlpha;\n
149 lowp vec4 visualMixColor()\n
151 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
156 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
157 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
161 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
162 varying mediump vec2 vTexCoord;\n
163 uniform sampler2D sTexture;\n
164 uniform mediump vec4 uAtlasRect;\n
165 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
166 uniform lowp vec2 wrapMode;\n
167 uniform lowp vec4 uColor;\n
168 uniform lowp vec4 mixColor;\n
169 uniform lowp float preMultipliedAlpha;\n
171 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
173 mediump float coord;\n
174 if( wrap > 1.5 )\n // REFLECT
175 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
176 else \n// warp == 0 or 1
177 coord = mix(coordinate, fract( coordinate ), wrap);\n
178 return clamp( mix(range.x, range.y, coord), range.x, range.y );
181 lowp vec4 visualMixColor()\n
183 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
188 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
189 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
190 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
194 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
198 if( gridSize == ImageDimensions( 1, 1 ) )
200 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
204 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
210 } // unnamed namespace
212 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
213 const std::string& imageUrl,
214 const Property::Map& properties,
215 ImageDimensions size,
216 FittingMode::Type fittingMode,
217 Dali::SamplingMode::Type samplingMode )
219 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
220 imageVisualPtr->SetProperties( properties );
221 return imageVisualPtr;
224 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
225 const std::string& imageUrl,
226 ImageDimensions size,
227 FittingMode::Type fittingMode,
228 Dali::SamplingMode::Type samplingMode )
230 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
233 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
235 return new ImageVisual( factoryCache, image );
238 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
239 const std::string& imageUrl,
240 ImageDimensions size,
241 FittingMode::Type fittingMode,
242 Dali::SamplingMode::Type samplingMode )
243 : Visual::Base( factoryCache ),
246 mPixelArea( FULL_TEXTURE_RECT ),
248 mImageUrl( imageUrl ),
249 mDesiredSize( size ),
250 mFittingMode( fittingMode ),
251 mSamplingMode( samplingMode ),
252 mWrapModeU( WrapMode::DEFAULT ),
253 mWrapModeV( WrapMode::DEFAULT )
257 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
258 : Visual::Base( factoryCache ),
261 mPixelArea( FULL_TEXTURE_RECT ),
265 mFittingMode( FittingMode::DEFAULT ),
266 mSamplingMode( SamplingMode::DEFAULT ),
267 mWrapModeU( WrapMode::DEFAULT ),
268 mWrapModeV( WrapMode::DEFAULT )
272 ImageVisual::~ImageVisual()
276 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
278 // Url is already received in constructor
279 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
281 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
282 if( keyValue.first.type == Property::Key::INDEX )
284 DoSetProperty( keyValue.first.indexKey, keyValue.second );
288 if( keyValue.first == IMAGE_FITTING_MODE )
290 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
292 else if( keyValue.first == IMAGE_SAMPLING_MODE )
294 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
296 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
298 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
300 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
302 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
304 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
306 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
308 else if( keyValue.first == IMAGE_WRAP_MODE_U )
310 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
312 else if( keyValue.first == IMAGE_WRAP_MODE_V )
314 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
316 else if( keyValue.first == SYNCHRONOUS_LOADING )
318 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
323 if( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING && mImageUrl.size() > 0u )
325 // if sync loading is required, the loading should start
326 // immediately when new image url is set or the actor is off stage
327 // ( for on-stage actor with image url unchanged, resource loading
328 // is already finished )
329 LoadResourceSynchronously();
333 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
337 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
340 if( value.Get( sync ) )
344 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
348 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
353 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
358 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
361 if( value.Get( desiredWidth ) )
363 mDesiredSize.SetWidth( desiredWidth );
367 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
372 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
375 if( value.Get( desiredHeight ) )
377 mDesiredSize.SetHeight( desiredHeight );
381 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
386 case Toolkit::ImageVisual::Property::FITTING_MODE:
389 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
390 mFittingMode = Dali::FittingMode::Type( fittingMode );
394 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
397 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
398 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
402 case Toolkit::ImageVisual::Property::PIXEL_AREA:
404 value.Get( mPixelArea );
408 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
411 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
412 mWrapModeU = Dali::WrapMode::Type( wrapMode );
416 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
419 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
420 mWrapModeV = Dali::WrapMode::Type( wrapMode );
426 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
430 naturalSize.x = mImage.GetWidth();
431 naturalSize.y = mImage.GetHeight();
434 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
436 naturalSize.x = mDesiredSize.GetWidth();
437 naturalSize.y = mDesiredSize.GetHeight();
440 else if( !mImageUrl.empty() )
442 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
443 naturalSize.x = dimentions.GetWidth();
444 naturalSize.y = dimentions.GetHeight();
448 naturalSize = Vector2::ZERO;
451 void ImageVisual::CreateRenderer( TextureSet& textures )
456 if( !mImpl->mCustomShader )
458 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
460 shader = GetImageShader( mFactoryCache,
461 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
462 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
466 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
467 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
469 shader = GetImageShader( mFactoryCache, false, true );
473 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
474 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
475 mImpl->mCustomShader->mHints );
476 if( mImpl->mCustomShader->mVertexShader.empty() )
478 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
483 mImpl->mRenderer = Renderer::New( geometry, shader );
484 DALI_ASSERT_DEBUG( textures );
485 mImpl->mRenderer.SetTextures( textures );
487 //Register transform properties
488 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
491 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
496 std::string fragmentShader;
497 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
498 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
501 fragmentShader = fragmentPreFix;
502 fragmentShader += "\n";
504 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
506 fragmentShader += mImpl->mCustomShader->mFragmentShader;
510 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
512 if( customSamplerTypename )
514 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
517 if( !mImpl->mCustomShader )
519 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
521 shader = Shader::New( VERTEX_SHADER, fragmentShader );
522 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
526 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
527 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
529 mImpl->mCustomShader->mHints );
530 if( mImpl->mCustomShader->mVertexShader.empty() )
532 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
536 mImpl->mRenderer = Renderer::New( geometry, shader );
538 //Register transform properties
539 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
543 bool ImageVisual::IsSynchronousResourceLoading() const
545 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
548 void ImageVisual::LoadResourceSynchronously()
550 if( !mImageUrl.empty() )
552 BitmapLoader loader = BitmapLoader::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
554 mPixels = loader.GetPixelData();
558 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing )
560 TextureSet textureSet;
561 textureRect = FULL_TEXTURE_RECT;
562 if( synchronousLoading )
567 textureSet = TextureSet::New();
568 TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
572 if( attemptAtlasing )
574 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
575 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
577 if( !textureSet ) // big image, no atlasing or atlasing failed
579 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
580 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
581 mPixels.GetWidth(), mPixels.GetHeight() );
582 texture.Upload( mPixels );
583 textureSet = TextureSet::New();
584 textureSet.SetTexture( 0u, texture );
590 if( attemptAtlasing )
592 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, url, mDesiredSize, mFittingMode, true, this );
593 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
595 if( !textureSet ) // big image, no atlasing or atlasing failed
597 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
598 ResourceImage resourceImage = Dali::ResourceImage::New( url, mDesiredSize, mFittingMode, mSamplingMode );
599 resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
600 textureSet = TextureSet::New();
601 TextureSetImage( textureSet, 0u, resourceImage );
605 if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
607 Sampler sampler = Sampler::New();
608 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
609 textureSet.SetSampler( 0u, sampler );
614 void ImageVisual::InitializeRenderer( const std::string& imageUrl )
616 mImageUrl = imageUrl;
617 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
619 if( !mImpl->mCustomShader &&
620 ( strncasecmp( imageUrl.c_str(), HTTP_URL, sizeof(HTTP_URL) -1 ) != 0 ) && // dont atlas remote images
621 ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
623 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
624 bool defaultTransform = mImpl->mTransform.mSize == Vector2::ONE &&
625 mImpl->mTransform.mOffset == Vector2::ZERO &&
626 mImpl->mTransform.mOffsetSizeMode == Vector4::ZERO &&
627 mImpl->mTransform.mOrigin == Toolkit::Align::CENTER &&
628 mImpl->mTransform.mAnchorPoint == Toolkit::Align::CENTER;
630 bool cacheable = defaultWrapMode && defaultTransform && mPixelArea == FULL_TEXTURE_RECT;
633 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
634 if( cacheable ) // fetch the renderer from cache if exist
636 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
637 mImpl->mFlags |= Impl::IS_FROM_CACHE;
640 if( !mImpl->mRenderer ) // new renderer is needed
643 // texture set has to be created first as we need to know if atlasing succeeded or not
644 // when selecting the shader
645 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), true );
646 CreateRenderer( textures );
648 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
650 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
651 if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
653 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
654 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
655 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
659 // save the renderer to cache only when default wrap mode and default pixel area is used
662 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
668 // for custom shader or remote image, renderer is not cached and atlas is not applied
669 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
670 Vector4 atlasRect; // ignored in this case
671 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), false );
672 CreateRenderer( textures );
676 void ImageVisual::InitializeRenderer( const Image& image )
678 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
680 // don't reuse CreateTextureSet
681 TextureSet textures = TextureSet::New();
682 // Renderer can't be shared if mImage is NativeImage
683 NativeImage nativeImage = NativeImage::DownCast( image );
686 CreateNativeImageRenderer( nativeImage );
687 DALI_ASSERT_DEBUG( textures );
688 mImpl->mRenderer.SetTextures( textures );
692 // reuse existing code for regular images
693 CreateRenderer( textures );
695 ApplyImageToSampler( image );
698 void ImageVisual::UploadCompleted()
700 // Resource image is loaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
701 Actor actor = mPlacementActor.GetHandle();
704 actor.AddRenderer( mImpl->mRenderer );
705 // reset the weak handle so that the renderer only get added to actor once
706 mPlacementActor.Reset();
710 void ImageVisual::DoSetOnStage( Actor& actor )
712 if( !mImageUrl.empty() )
714 InitializeRenderer( mImageUrl );
718 InitializeRenderer( mImage );
721 if ( !mImpl->mRenderer )
726 mPlacementActor = actor;
728 if( mPixelArea != FULL_TEXTURE_RECT )
730 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
733 if( IsSynchronousResourceLoading() || !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
735 actor.AddRenderer( mImpl->mRenderer );
736 mPlacementActor.Reset();
740 void ImageVisual::DoSetOffStage( Actor& actor )
742 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
744 //If we own the image then make sure we release it when we go off stage
745 actor.RemoveRenderer( mImpl->mRenderer);
746 if( !mImageUrl.empty() )
748 CleanCache(mImageUrl);
752 mImpl->mRenderer.Reset();
753 mPlacementActor.Reset();
756 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
759 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
761 bool sync = IsSynchronousResourceLoading();
762 map.Insert( SYNCHRONOUS_LOADING, sync );
763 if( !mImageUrl.empty() )
765 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
766 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
767 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
771 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
772 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
774 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
777 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
781 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
782 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
784 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
785 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
786 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
789 void ImageVisual::OnSetTransform()
791 if( mImpl->mRenderer )
793 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
797 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
802 if( defaultTextureWrapping )
804 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
807 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
808 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
809 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
814 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
817 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
818 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
819 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
825 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
828 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
829 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
830 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
837 void ImageVisual::ApplyImageToSampler( const Image& image )
841 TextureSet textureSet = mImpl->mRenderer.GetTextures();
842 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
844 TextureSetImage( textureSet, 0u, image );
845 Sampler sampler = Sampler::New();
846 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
847 textureSet.SetSampler( 0u, sampler );
851 void ImageVisual::OnImageLoaded( ResourceImage image )
853 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
855 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
856 if( mImpl->mRenderer )
858 ApplyImageToSampler( brokenImage );
863 void ImageVisual::CleanCache(const std::string& url)
867 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
868 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
869 if( index != Property::INVALID_INDEX )
871 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
872 atlasRectValue.Get( atlasRect );
875 TextureSet textureSet = mImpl->mRenderer.GetTextures();
876 mImpl->mRenderer.Reset();
877 if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
879 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
884 } // namespace Internal
886 } // namespace Toolkit