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 SYNCHRONOUS_LOADING( "synchronousLoading" );
62 const char * const BATCHING_ENABLED( "batchingEnabled" );
65 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
66 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
67 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
71 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
74 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
75 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
76 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
82 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
85 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
86 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
87 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
90 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
92 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
94 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
96 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
97 attribute mediump vec2 aPosition;\n
98 uniform mediump mat4 uMvpMatrix;\n
99 uniform mediump vec3 uSize;\n
100 uniform mediump vec4 pixelArea;
101 varying mediump vec2 vTexCoord;\n
104 //Visual size and offset
105 uniform mediump vec2 offset;\n
106 uniform mediump vec2 size;\n
107 uniform mediump vec4 offsetSizeMode;\n
108 uniform mediump vec2 origin;\n
109 uniform mediump vec2 anchorPoint;\n
111 vec4 ComputeVertexPosition()\n
113 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
114 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
115 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
120 mediump vec4 vertexPosition = uMvpMatrix * ComputeVertexPosition();\n
121 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
122 gl_Position = vertexPosition;\n
126 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
127 varying mediump vec2 vTexCoord;\n
128 uniform sampler2D sTexture;\n
129 uniform lowp vec4 uColor;\n
130 uniform lowp vec4 mixColor;\n
131 uniform lowp float preMultipliedAlpha;\n
133 lowp vec4 visualMixColor()\n
135 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
139 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
143 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
144 varying mediump vec2 vTexCoord;\n
145 uniform sampler2D sTexture;\n
146 uniform mediump vec4 uAtlasRect;\n
147 uniform lowp vec4 uColor;\n
148 uniform lowp vec4 mixColor;\n
149 uniform lowp float preMultipliedAlpha;\n
151 lowp vec4 visualMixColor()\n
153 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
158 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
159 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
163 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
164 varying mediump vec2 vTexCoord;\n
165 uniform sampler2D sTexture;\n
166 uniform mediump vec4 uAtlasRect;\n
167 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
168 uniform lowp vec2 wrapMode;\n
169 uniform lowp vec4 uColor;\n
170 uniform lowp vec4 mixColor;\n
171 uniform lowp float preMultipliedAlpha;\n
173 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
175 mediump float coord;\n
176 if( wrap > 1.5 )\n // REFLECT
177 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
178 else \n// warp == 0 or 1
179 coord = mix(coordinate, fract( coordinate ), wrap);\n
180 return clamp( mix(range.x, range.y, coord), range.x, range.y );
183 lowp vec4 visualMixColor()\n
185 return vec4( mixColor.rgb * mix( 1.0, mixColor.a, preMultipliedAlpha ), mixColor.a );\n
190 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
191 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
192 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
196 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
200 if( gridSize == ImageDimensions( 1, 1 ) )
202 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
206 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
212 } // unnamed namespace
214 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
215 const std::string& imageUrl,
216 const Property::Map& properties,
217 ImageDimensions size,
218 FittingMode::Type fittingMode,
219 Dali::SamplingMode::Type samplingMode )
221 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
222 imageVisualPtr->SetProperties( properties );
223 return imageVisualPtr;
226 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
227 const std::string& imageUrl,
228 ImageDimensions size,
229 FittingMode::Type fittingMode,
230 Dali::SamplingMode::Type samplingMode )
232 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
235 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
237 return new ImageVisual( factoryCache, image );
240 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
241 const std::string& imageUrl,
242 ImageDimensions size,
243 FittingMode::Type fittingMode,
244 Dali::SamplingMode::Type samplingMode )
245 : Visual::Base( factoryCache ),
248 mPixelArea( FULL_TEXTURE_RECT ),
250 mImageUrl( imageUrl ),
251 mDesiredSize( size ),
252 mFittingMode( fittingMode ),
253 mSamplingMode( samplingMode ),
254 mWrapModeU( WrapMode::DEFAULT ),
255 mWrapModeV( WrapMode::DEFAULT )
259 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
260 : Visual::Base( factoryCache ),
263 mPixelArea( FULL_TEXTURE_RECT ),
267 mFittingMode( FittingMode::DEFAULT ),
268 mSamplingMode( SamplingMode::DEFAULT ),
269 mWrapModeU( WrapMode::DEFAULT ),
270 mWrapModeV( WrapMode::DEFAULT )
274 ImageVisual::~ImageVisual()
278 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
280 // Url is already received in constructor
281 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
283 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
284 if( keyValue.first.type == Property::Key::INDEX )
286 DoSetProperty( keyValue.first.indexKey, keyValue.second );
290 if( keyValue.first == IMAGE_FITTING_MODE )
292 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
294 else if( keyValue.first == IMAGE_SAMPLING_MODE )
296 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
298 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
300 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
302 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
304 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
306 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
308 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
310 else if( keyValue.first == IMAGE_WRAP_MODE_U )
312 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
314 else if( keyValue.first == IMAGE_WRAP_MODE_V )
316 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
318 else if( keyValue.first == SYNCHRONOUS_LOADING )
320 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
325 if( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING && mImageUrl.size() > 0u )
327 // if sync loading is required, the loading should start
328 // immediately when new image url is set or the actor is off stage
329 // ( for on-stage actor with image url unchanged, resource loading
330 // is already finished )
331 LoadResourceSynchronously();
335 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
339 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
342 if( value.Get( sync ) )
346 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
350 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
355 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
360 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
363 if( value.Get( desiredWidth ) )
365 mDesiredSize.SetWidth( desiredWidth );
369 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
374 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
377 if( value.Get( desiredHeight ) )
379 mDesiredSize.SetHeight( desiredHeight );
383 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
388 case Toolkit::ImageVisual::Property::FITTING_MODE:
391 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
392 mFittingMode = Dali::FittingMode::Type( fittingMode );
396 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
399 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
400 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
404 case Toolkit::ImageVisual::Property::PIXEL_AREA:
406 value.Get( mPixelArea );
410 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
413 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
414 mWrapModeU = Dali::WrapMode::Type( wrapMode );
418 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
421 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
422 mWrapModeV = Dali::WrapMode::Type( wrapMode );
428 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
432 naturalSize.x = mImage.GetWidth();
433 naturalSize.y = mImage.GetHeight();
436 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
438 naturalSize.x = mDesiredSize.GetWidth();
439 naturalSize.y = mDesiredSize.GetHeight();
442 else if( !mImageUrl.empty() )
444 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
445 naturalSize.x = dimentions.GetWidth();
446 naturalSize.y = dimentions.GetHeight();
450 naturalSize = Vector2::ZERO;
453 void ImageVisual::CreateRenderer( TextureSet& textures )
458 if( !mImpl->mCustomShader )
460 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
462 shader = GetImageShader( mFactoryCache,
463 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
464 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
468 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
469 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
471 shader = GetImageShader( mFactoryCache, false, true );
475 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
476 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
477 mImpl->mCustomShader->mHints );
478 if( mImpl->mCustomShader->mVertexShader.empty() )
480 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
485 mImpl->mRenderer = Renderer::New( geometry, shader );
486 DALI_ASSERT_DEBUG( textures );
487 mImpl->mRenderer.SetTextures( textures );
489 //Register transform properties
490 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
493 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
498 std::string fragmentShader;
499 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
500 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
503 fragmentShader = fragmentPreFix;
504 fragmentShader += "\n";
506 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
508 fragmentShader += mImpl->mCustomShader->mFragmentShader;
512 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
514 if( customSamplerTypename )
516 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
519 if( !mImpl->mCustomShader )
521 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
523 shader = Shader::New( VERTEX_SHADER, fragmentShader );
524 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
528 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
529 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
531 mImpl->mCustomShader->mHints );
532 if( mImpl->mCustomShader->mVertexShader.empty() )
534 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
538 mImpl->mRenderer = Renderer::New( geometry, shader );
540 //Register transform properties
541 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
545 bool ImageVisual::IsSynchronousResourceLoading() const
547 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
550 void ImageVisual::LoadResourceSynchronously()
552 if( !mImageUrl.empty() )
554 BitmapLoader loader = BitmapLoader::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
556 mPixels = loader.GetPixelData();
560 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing )
562 TextureSet textureSet;
563 textureRect = FULL_TEXTURE_RECT;
564 if( synchronousLoading )
569 textureSet = TextureSet::New();
570 TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
574 if( attemptAtlasing )
576 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
577 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
579 if( !textureSet ) // big image, no atlasing or atlasing failed
581 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
582 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
583 mPixels.GetWidth(), mPixels.GetHeight() );
584 texture.Upload( mPixels );
585 textureSet = TextureSet::New();
586 textureSet.SetTexture( 0u, texture );
592 if( attemptAtlasing )
594 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, url, mDesiredSize, mFittingMode, true, this );
595 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
597 if( !textureSet ) // big image, no atlasing or atlasing failed
599 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
600 ResourceImage resourceImage = Dali::ResourceImage::New( url, mDesiredSize, mFittingMode, mSamplingMode );
601 resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
602 textureSet = TextureSet::New();
603 TextureSetImage( textureSet, 0u, resourceImage );
607 if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
609 Sampler sampler = Sampler::New();
610 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
611 textureSet.SetSampler( 0u, sampler );
616 void ImageVisual::InitializeRenderer( const std::string& imageUrl )
618 mImageUrl = imageUrl;
619 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
621 if( !mImpl->mCustomShader &&
622 ( strncasecmp( imageUrl.c_str(), HTTP_URL, sizeof(HTTP_URL) -1 ) != 0 ) && // dont atlas remote images
623 ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
625 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
626 bool defaultTransform = mImpl->mTransform.mSize == Vector2::ONE &&
627 mImpl->mTransform.mOffset == Vector2::ZERO &&
628 mImpl->mTransform.mOffsetSizeMode == Vector4::ZERO &&
629 mImpl->mTransform.mOrigin == Toolkit::Align::CENTER &&
630 mImpl->mTransform.mAnchorPoint == Toolkit::Align::CENTER;
632 bool cacheable = defaultWrapMode && defaultTransform && mPixelArea == FULL_TEXTURE_RECT;
635 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
636 if( cacheable ) // fetch the renderer from cache if exist
638 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
639 mImpl->mFlags |= Impl::IS_FROM_CACHE;
642 if( !mImpl->mRenderer ) // new renderer is needed
645 // texture set has to be created first as we need to know if atlasing succeeded or not
646 // when selecting the shader
647 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), true );
648 CreateRenderer( textures );
650 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
652 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
653 if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
655 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
656 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
657 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
661 // save the renderer to cache only when default wrap mode and default pixel area is used
664 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
670 // for custom shader or remote image, renderer is not cached and atlas is not applied
671 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
672 Vector4 atlasRect; // ignored in this case
673 TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), false );
674 CreateRenderer( textures );
678 void ImageVisual::InitializeRenderer( const Image& image )
680 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
682 // don't reuse CreateTextureSet
683 TextureSet textures = TextureSet::New();
684 // Renderer can't be shared if mImage is NativeImage
685 NativeImage nativeImage = NativeImage::DownCast( image );
688 CreateNativeImageRenderer( nativeImage );
689 DALI_ASSERT_DEBUG( textures );
690 mImpl->mRenderer.SetTextures( textures );
694 // reuse existing code for regular images
695 CreateRenderer( textures );
697 ApplyImageToSampler( image );
700 void ImageVisual::UploadCompleted()
702 // Resource image is loaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
703 Actor actor = mPlacementActor.GetHandle();
706 actor.AddRenderer( mImpl->mRenderer );
707 // reset the weak handle so that the renderer only get added to actor once
708 mPlacementActor.Reset();
712 void ImageVisual::DoSetOnStage( Actor& actor )
714 if( !mImageUrl.empty() )
716 InitializeRenderer( mImageUrl );
720 InitializeRenderer( mImage );
723 if ( !mImpl->mRenderer )
728 mPlacementActor = actor;
730 if( mPixelArea != FULL_TEXTURE_RECT )
732 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
735 if( IsSynchronousResourceLoading() || !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
737 actor.AddRenderer( mImpl->mRenderer );
738 mPlacementActor.Reset();
742 void ImageVisual::DoSetOffStage( Actor& actor )
744 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
746 //If we own the image then make sure we release it when we go off stage
747 actor.RemoveRenderer( mImpl->mRenderer);
748 if( !mImageUrl.empty() )
750 CleanCache(mImageUrl);
754 mImpl->mRenderer.Reset();
755 mPlacementActor.Reset();
758 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
761 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
763 bool sync = IsSynchronousResourceLoading();
764 map.Insert( SYNCHRONOUS_LOADING, sync );
765 if( !mImageUrl.empty() )
767 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
768 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
769 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
773 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
774 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
776 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
779 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
783 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
784 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
786 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
787 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
788 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
791 void ImageVisual::OnSetTransform()
793 if( mImpl->mRenderer )
795 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
799 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
804 if( defaultTextureWrapping )
806 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
809 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
810 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
811 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
816 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
819 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
820 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
821 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
827 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
830 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
831 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
832 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
839 void ImageVisual::ApplyImageToSampler( const Image& image )
843 TextureSet textureSet = mImpl->mRenderer.GetTextures();
844 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
846 TextureSetImage( textureSet, 0u, image );
847 Sampler sampler = Sampler::New();
848 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
849 textureSet.SetSampler( 0u, sampler );
853 void ImageVisual::OnImageLoaded( ResourceImage image )
855 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
857 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
858 if( mImpl->mRenderer )
860 ApplyImageToSampler( brokenImage );
865 void ImageVisual::CleanCache(const std::string& url)
869 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
870 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
871 if( index != Property::INVALID_INDEX )
873 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
874 atlasRectValue.Get( atlasRect );
877 TextureSet textureSet = mImpl->mRenderer.GetTextures();
878 mImpl->mRenderer.Reset();
879 if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
881 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
886 } // namespace Internal
888 } // namespace Toolkit