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 strlen()
23 #include <dali/public-api/actors/layer.h>
24 #include <dali/public-api/images/resource-image.h>
25 #include <dali/public-api/images/native-image.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/adaptor-framework/image-loading.h>
29 #include <dali/devel-api/scripting/enum-helper.h>
30 #include <dali/devel-api/scripting/scripting.h>
31 #include <dali/integration-api/debug.h>
34 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
35 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
36 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
37 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
38 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
39 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
40 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
41 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
42 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
43 #include <dali-toolkit/internal/visuals/visual-url.h>
58 const char * const IMAGE_FITTING_MODE( "fittingMode" );
59 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
60 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
61 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
62 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
63 const char * const IMAGE_ATLASING("atlasing");
66 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
67 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
72 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
75 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
76 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
83 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
86 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
87 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
90 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
91 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
93 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
95 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
97 const float PIXEL_ALIGN_ON = 1.0f;
98 const float PIXEL_ALIGN_OFF = 0.0f;
100 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
101 attribute mediump vec2 aPosition;\n
102 uniform mediump mat4 uModelMatrix;\n
103 uniform mediump mat4 uViewMatrix;\n
104 uniform mediump mat4 uProjection;\n
105 uniform mediump vec3 uSize;\n
106 uniform mediump vec4 pixelArea;
107 varying mediump vec2 vTexCoord;\n
108 uniform lowp float uPixelAligned;\n
110 //Visual size and offset
111 uniform mediump vec2 offset;\n
112 uniform mediump vec2 size;\n
113 uniform mediump vec4 offsetSizeMode;\n
114 uniform mediump vec2 origin;\n
115 uniform mediump vec2 anchorPoint;\n
117 vec4 ComputeVertexPosition()\n
119 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
120 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
121 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
126 mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
127 vec4 alignedVertexPosition = vertexPosition;\n
128 alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
129 vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
130 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
131 gl_Position = vertexPosition;\n
135 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
136 varying mediump vec2 vTexCoord;\n
137 uniform sampler2D sTexture;\n
138 uniform lowp vec4 uColor;\n
139 uniform lowp vec3 mixColor;\n
140 uniform lowp float opacity;\n
141 uniform lowp float preMultipliedAlpha;\n
143 lowp vec4 visualMixColor()\n
145 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
149 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
153 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
154 varying mediump vec2 vTexCoord;\n
155 uniform sampler2D sTexture;\n
156 uniform mediump vec4 uAtlasRect;\n
157 uniform lowp vec4 uColor;\n
158 uniform lowp vec3 mixColor;\n
159 uniform lowp float opacity;\n
160 uniform lowp float preMultipliedAlpha;\n
162 lowp vec4 visualMixColor()\n
164 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
169 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
170 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
174 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
175 varying mediump vec2 vTexCoord;\n
176 uniform sampler2D sTexture;\n
177 uniform mediump vec4 uAtlasRect;\n
178 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
179 uniform lowp vec2 wrapMode;\n
180 uniform lowp vec4 uColor;\n
181 uniform lowp vec3 mixColor;\n
182 uniform lowp float opacity;\n
183 uniform lowp float preMultipliedAlpha;\n
185 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
187 mediump float coord;\n
188 if( wrap > 1.5 )\n // REFLECT
189 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
190 else \n// warp == 0 or 1
191 coord = mix(coordinate, fract( coordinate ), wrap);\n
192 return clamp( mix(range.x, range.y, coord), range.x, range.y );
195 lowp vec4 visualMixColor()\n
197 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
202 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
203 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
204 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
208 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
212 if( gridSize == ImageDimensions( 1, 1 ) )
214 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
218 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
224 } // unnamed namespace
226 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
227 const VisualUrl& imageUrl,
228 const Property::Map& properties,
229 ImageDimensions size,
230 FittingMode::Type fittingMode,
231 Dali::SamplingMode::Type samplingMode )
233 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
234 imageVisualPtr->SetProperties( properties );
235 return imageVisualPtr;
238 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
239 const VisualUrl& imageUrl,
240 ImageDimensions size,
241 FittingMode::Type fittingMode,
242 Dali::SamplingMode::Type samplingMode )
244 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
247 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
249 return new ImageVisual( factoryCache, image );
252 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
253 const VisualUrl& imageUrl,
254 ImageDimensions size,
255 FittingMode::Type fittingMode,
256 Dali::SamplingMode::Type samplingMode )
257 : Visual::Base( factoryCache ),
260 mPixelArea( FULL_TEXTURE_RECT ),
262 mImageUrl( imageUrl ),
263 mDesiredSize( size ),
264 mFittingMode( fittingMode ),
265 mSamplingMode( samplingMode ),
266 mWrapModeU( WrapMode::DEFAULT ),
267 mWrapModeV( WrapMode::DEFAULT ),
268 mAttemptAtlasing( false )
272 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
273 : Visual::Base( factoryCache ),
276 mPixelArea( FULL_TEXTURE_RECT ),
280 mFittingMode( FittingMode::DEFAULT ),
281 mSamplingMode( SamplingMode::DEFAULT ),
282 mWrapModeU( WrapMode::DEFAULT ),
283 mWrapModeV( WrapMode::DEFAULT ),
284 mAttemptAtlasing( false )
288 ImageVisual::~ImageVisual()
292 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
294 // Url is already received in constructor
295 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
297 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
298 if( keyValue.first.type == Property::Key::INDEX )
300 DoSetProperty( keyValue.first.indexKey, keyValue.second );
304 if( keyValue.first == IMAGE_FITTING_MODE )
306 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
308 else if( keyValue.first == IMAGE_SAMPLING_MODE )
310 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
312 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
314 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
316 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
318 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
320 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
322 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
324 else if( keyValue.first == IMAGE_WRAP_MODE_U )
326 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
328 else if( keyValue.first == IMAGE_WRAP_MODE_V )
330 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
332 else if( keyValue.first == SYNCHRONOUS_LOADING )
334 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
336 else if ( keyValue.first == IMAGE_ATLASING )
338 DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
343 if( ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING ) && mImageUrl.IsValid() )
345 // if sync loading is required, the loading should start
346 // immediately when new image url is set or the actor is off stage
347 // ( for on-stage actor with image url unchanged, resource loading
348 // is already finished )
349 LoadResourceSynchronously();
353 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
357 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
360 if( value.Get( sync ) )
364 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
368 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
373 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
378 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
381 if( value.Get( desiredWidth ) )
383 mDesiredSize.SetWidth( desiredWidth );
387 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
392 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
395 if( value.Get( desiredHeight ) )
397 mDesiredSize.SetHeight( desiredHeight );
401 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
406 case Toolkit::ImageVisual::Property::FITTING_MODE:
409 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
410 mFittingMode = Dali::FittingMode::Type( fittingMode );
414 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
417 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
418 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
422 case Toolkit::ImageVisual::Property::PIXEL_AREA:
424 value.Get( mPixelArea );
428 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
431 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
432 mWrapModeU = Dali::WrapMode::Type( wrapMode );
436 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
439 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
440 mWrapModeV = Dali::WrapMode::Type( wrapMode );
444 case Toolkit::DevelImageVisual::Property::ATLASING:
446 bool atlasing = false;
447 mAttemptAtlasing = value.Get( atlasing );
452 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
456 naturalSize.x = mImage.GetWidth();
457 naturalSize.y = mImage.GetHeight();
460 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
462 naturalSize.x = mDesiredSize.GetWidth();
463 naturalSize.y = mDesiredSize.GetHeight();
466 else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL )
468 ImageDimensions dimentions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
469 naturalSize.x = dimentions.GetWidth();
470 naturalSize.y = dimentions.GetHeight();
474 naturalSize = Vector2::ZERO;
477 void ImageVisual::CreateRenderer( TextureSet& textures )
482 if( !mImpl->mCustomShader )
484 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
486 shader = GetImageShader( mFactoryCache,
487 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
488 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
492 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
493 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
495 shader = GetImageShader( mFactoryCache, false, true );
499 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
500 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
501 mImpl->mCustomShader->mHints );
502 if( mImpl->mCustomShader->mVertexShader.empty() )
504 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
509 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_ON ); // Set default to align
511 mImpl->mRenderer = Renderer::New( geometry, shader );
512 DALI_ASSERT_DEBUG( textures );
513 mImpl->mRenderer.SetTextures( textures );
515 //Register transform properties
516 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
519 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
524 std::string fragmentShader;
525 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
526 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
530 fragmentShader = fragmentPreFix;
531 fragmentShader += "\n";
534 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
536 fragmentShader += mImpl->mCustomShader->mFragmentShader;
540 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
543 if( customSamplerTypename )
545 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
548 if( !mImpl->mCustomShader )
550 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
552 shader = Shader::New( VERTEX_SHADER, fragmentShader );
553 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
557 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
558 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
560 mImpl->mCustomShader->mHints );
561 if( mImpl->mCustomShader->mVertexShader.empty() )
563 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
567 mImpl->mRenderer = Renderer::New( geometry, shader );
569 //Register transform properties
570 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
574 bool ImageVisual::IsSynchronousResourceLoading() const
576 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
579 void ImageVisual::LoadResourceSynchronously()
581 if( mImageUrl.IsValid() )
583 BitmapLoader loader = BitmapLoader::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
585 mPixels = loader.GetPixelData();
589 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
591 TextureSet textureSet;
592 textureRect = FULL_TEXTURE_RECT;
593 if( synchronousLoading )
598 textureSet = TextureSet::New();
599 TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
603 if( attemptAtlasing )
605 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
606 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
608 if( !textureSet ) // big image, no atlasing or atlasing failed
610 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
611 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
612 mPixels.GetWidth(), mPixels.GetHeight() );
613 texture.Upload( mPixels );
614 textureSet = TextureSet::New();
615 textureSet.SetTexture( 0u, texture );
621 if( attemptAtlasing )
623 textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
624 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
626 if( !textureSet ) // big image, no atlasing or atlasing failed
628 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
629 ResourceImage resourceImage = Dali::ResourceImage::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
630 resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
631 textureSet = TextureSet::New();
632 TextureSetImage( textureSet, 0u, resourceImage );
636 if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
638 Sampler sampler = Sampler::New();
639 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
640 textureSet.SetSampler( 0u, sampler );
645 void ImageVisual::InitializeRenderer()
647 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
649 if( !mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL )
651 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
654 // texture set has to be created first as we need to know if atlasing succeeded or not
655 // when selecting the shader
656 TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), mAttemptAtlasing );
657 CreateRenderer( textures );
659 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
661 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
662 if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
664 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
665 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
666 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
672 // for custom shader or remote image, atlas is not applied
673 Vector4 atlasRect; // ignored in this case
674 TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
675 CreateRenderer( textures );
679 void ImageVisual::InitializeRenderer( const Image& image )
681 // don't reuse CreateTextureSet
682 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.IsValid() )
716 InitializeRenderer();
720 InitializeRenderer( mImage );
723 if ( !mImpl->mRenderer )
728 mPlacementActor = actor;
730 // Search the Actor tree to find if Layer UI behaviour set.
731 Layer layer = actor.GetLayer();
732 if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
734 // Layer 3D set, do not align pixels
735 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
738 if( mPixelArea != FULL_TEXTURE_RECT )
740 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
743 if( IsSynchronousResourceLoading() || !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
745 actor.AddRenderer( mImpl->mRenderer );
746 mPlacementActor.Reset();
750 void ImageVisual::DoSetOffStage( Actor& actor )
752 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
754 //If we own the image then make sure we release it when we go off stage
755 actor.RemoveRenderer( mImpl->mRenderer);
756 if( mImageUrl.IsValid() )
758 RemoveFromAtlas( mImageUrl.GetUrl() );
762 mImpl->mRenderer.Reset();
763 mPlacementActor.Reset();
766 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
769 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
771 bool sync = IsSynchronousResourceLoading();
772 map.Insert( SYNCHRONOUS_LOADING, sync );
773 if( mImageUrl.IsValid() )
775 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
776 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
777 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
781 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
782 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
784 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
787 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
791 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
792 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
794 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
795 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
796 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
798 map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing );
801 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
804 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
805 if( mImageUrl.IsValid() )
807 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
808 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
812 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
813 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
817 void ImageVisual::OnSetTransform()
819 if( mImpl->mRenderer )
821 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
825 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
830 if( defaultTextureWrapping )
832 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
835 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
836 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
837 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
842 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
845 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
846 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
847 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
853 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
856 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
857 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
858 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
865 void ImageVisual::ApplyImageToSampler( const Image& image )
869 TextureSet textureSet = mImpl->mRenderer.GetTextures();
870 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
872 TextureSetImage( textureSet, 0u, image );
873 Sampler sampler = Sampler::New();
874 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
875 textureSet.SetSampler( 0u, sampler );
879 void ImageVisual::OnImageLoaded( ResourceImage image )
881 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
883 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
884 if( mImpl->mRenderer )
886 ApplyImageToSampler( brokenImage );
891 void ImageVisual::RemoveFromAtlas(const std::string& url)
893 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
894 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
895 if( index != Property::INVALID_INDEX )
897 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
898 atlasRectValue.Get( atlasRect );
901 TextureSet textureSet = mImpl->mRenderer.GetTextures();
902 mImpl->mRenderer.Reset();
904 if( index != Property::INVALID_INDEX )
906 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
910 } // namespace Internal
912 } // namespace Toolkit