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/texture-manager.h>
38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
40 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
41 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
42 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
43 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
44 #include <dali-toolkit/internal/visuals/visual-url.h>
59 const char * const IMAGE_FITTING_MODE( "fittingMode" );
60 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
61 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
62 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
63 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
64 const char * const IMAGE_ATLASING("atlasing");
65 const char * const ALPHA_MASK_URL("alphaMaskUrl");
68 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
73 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
74 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
77 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
83 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
84 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
85 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
88 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
90 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
91 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
92 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
93 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
95 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
97 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
99 const float PIXEL_ALIGN_ON = 1.0f;
100 const float PIXEL_ALIGN_OFF = 0.0f;
102 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
103 attribute mediump vec2 aPosition;\n
104 uniform mediump mat4 uModelMatrix;\n
105 uniform mediump mat4 uViewMatrix;\n
106 uniform mediump mat4 uProjection;\n
107 uniform mediump vec3 uSize;\n
108 uniform mediump vec4 pixelArea;
109 varying mediump vec2 vTexCoord;\n
110 uniform lowp float uPixelAligned;\n
112 //Visual size and offset
113 uniform mediump vec2 offset;\n
114 uniform mediump vec2 size;\n
115 uniform mediump vec4 offsetSizeMode;\n
116 uniform mediump vec2 origin;\n
117 uniform mediump vec2 anchorPoint;\n
119 vec4 ComputeVertexPosition()\n
121 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
122 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
123 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
128 mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
129 vec4 alignedVertexPosition = vertexPosition;\n
130 alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
131 vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
132 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
133 gl_Position = vertexPosition;\n
137 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
138 varying mediump vec2 vTexCoord;\n
139 uniform sampler2D sTexture;\n
140 uniform lowp vec4 uColor;\n
141 uniform lowp vec3 mixColor;\n
142 uniform lowp float opacity;\n
143 uniform lowp float preMultipliedAlpha;\n
145 lowp vec4 visualMixColor()\n
147 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
151 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
155 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
156 varying mediump vec2 vTexCoord;\n
157 uniform sampler2D sTexture;\n
158 uniform mediump vec4 uAtlasRect;\n
159 uniform lowp vec4 uColor;\n
160 uniform lowp vec3 mixColor;\n
161 uniform lowp float opacity;\n
162 uniform lowp float preMultipliedAlpha;\n
164 lowp vec4 visualMixColor()\n
166 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
171 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
172 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
176 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
177 varying mediump vec2 vTexCoord;\n
178 uniform sampler2D sTexture;\n
179 uniform mediump vec4 uAtlasRect;\n
180 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
181 uniform lowp vec2 wrapMode;\n
182 uniform lowp vec4 uColor;\n
183 uniform lowp vec3 mixColor;\n
184 uniform lowp float opacity;\n
185 uniform lowp float preMultipliedAlpha;\n
187 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
189 mediump float coord;\n
190 if( wrap > 1.5 )\n // REFLECT
191 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
192 else \n// warp == 0 or 1
193 coord = mix(coordinate, fract( coordinate ), wrap);\n
194 return clamp( mix(range.x, range.y, coord), range.x, range.y );
197 lowp vec4 visualMixColor()\n
199 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
204 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
205 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
206 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
210 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
214 if( gridSize == ImageDimensions( 1, 1 ) )
216 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
220 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
226 } // unnamed namespace
228 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
229 const VisualUrl& imageUrl,
230 const Property::Map& properties,
231 ImageDimensions size,
232 FittingMode::Type fittingMode,
233 Dali::SamplingMode::Type samplingMode )
235 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
236 imageVisualPtr->SetProperties( properties );
237 return imageVisualPtr;
240 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
241 const VisualUrl& imageUrl,
242 ImageDimensions size,
243 FittingMode::Type fittingMode,
244 Dali::SamplingMode::Type samplingMode )
246 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
249 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
251 return new ImageVisual( factoryCache, image );
254 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
255 const VisualUrl& imageUrl,
256 ImageDimensions size,
257 FittingMode::Type fittingMode,
258 Dali::SamplingMode::Type samplingMode )
259 : Visual::Base( factoryCache ),
262 mPixelArea( FULL_TEXTURE_RECT ),
264 mImageUrl( imageUrl ),
266 mDesiredSize( size ),
267 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
268 mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
269 mFittingMode( fittingMode ),
270 mSamplingMode( samplingMode ),
271 mWrapModeU( WrapMode::DEFAULT ),
272 mWrapModeV( WrapMode::DEFAULT ),
273 mAttemptAtlasing( false ),
274 mTextureLoading( false )
278 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
279 : Visual::Base( factoryCache ),
282 mPixelArea( FULL_TEXTURE_RECT ),
287 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
288 mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
289 mFittingMode( FittingMode::DEFAULT ),
290 mSamplingMode( SamplingMode::DEFAULT ),
291 mWrapModeU( WrapMode::DEFAULT ),
292 mWrapModeV( WrapMode::DEFAULT ),
293 mAttemptAtlasing( false ),
294 mTextureLoading( false )
298 ImageVisual::~ImageVisual()
300 if( mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
302 TextureManager& textureManager = mFactoryCache.GetTextureManager();
303 textureManager.Remove( mAlphaMaskId );
307 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
309 // Url is already received in constructor
310 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
312 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
313 if( keyValue.first.type == Property::Key::INDEX )
315 DoSetProperty( keyValue.first.indexKey, keyValue.second );
319 if( keyValue.first == IMAGE_FITTING_MODE )
321 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
323 else if( keyValue.first == IMAGE_SAMPLING_MODE )
325 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
327 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
329 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
331 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
333 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
335 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
337 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
339 else if( keyValue.first == IMAGE_WRAP_MODE_U )
341 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
343 else if( keyValue.first == IMAGE_WRAP_MODE_V )
345 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
347 else if( keyValue.first == SYNCHRONOUS_LOADING )
349 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
351 else if ( keyValue.first == IMAGE_ATLASING )
353 DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
355 else if ( keyValue.first == ALPHA_MASK_URL )
357 DoSetProperty( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
362 if( mAlphaMaskUrl.IsValid() )
364 // Immediately trigger the alpha mask loading (it may just get a cached value)
365 TextureManager& textureManager = mFactoryCache.GetTextureManager();
366 mAlphaMaskId = textureManager.RequestMaskLoad( mAlphaMaskUrl );
369 if( ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING ) && mImageUrl.IsValid() )
371 // if sync loading is required, the loading should start
372 // immediately when new image url is set or the actor is off stage
373 // ( for on-stage actor with image url unchanged, resource loading
374 // is already finished )
375 LoadResourceSynchronously();
379 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
383 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
386 if( value.Get( sync ) )
390 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
394 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
399 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
404 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
407 if( value.Get( desiredWidth ) )
409 mDesiredSize.SetWidth( desiredWidth );
413 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
418 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
421 if( value.Get( desiredHeight ) )
423 mDesiredSize.SetHeight( desiredHeight );
427 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
432 case Toolkit::ImageVisual::Property::FITTING_MODE:
435 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
436 mFittingMode = Dali::FittingMode::Type( fittingMode );
440 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
443 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
444 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
448 case Toolkit::ImageVisual::Property::PIXEL_AREA:
450 value.Get( mPixelArea );
454 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
457 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
458 mWrapModeU = Dali::WrapMode::Type( wrapMode );
462 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
465 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
466 mWrapModeV = Dali::WrapMode::Type( wrapMode );
470 case Toolkit::DevelImageVisual::Property::ATLASING:
472 bool atlasing = false;
473 mAttemptAtlasing = value.Get( atlasing );
476 case Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL:
478 std::string alphaUrl;
479 if( value.Get( alphaUrl ) )
481 mAlphaMaskUrl = VisualUrl( alphaUrl );
487 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
491 naturalSize.x = mImage.GetWidth();
492 naturalSize.y = mImage.GetHeight();
495 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
497 naturalSize.x = mDesiredSize.GetWidth();
498 naturalSize.y = mDesiredSize.GetHeight();
501 else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL )
503 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
505 if( dimensions != ImageDimensions( 0, 0 ) )
507 naturalSize.x = dimensions.GetWidth();
508 naturalSize.y = dimensions.GetHeight();
512 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
514 naturalSize.x = brokenImage.GetWidth();
515 naturalSize.y = brokenImage.GetWidth();
520 naturalSize = Vector2::ZERO;
523 void ImageVisual::CreateRenderer( TextureSet& textureSet )
528 if( !mImpl->mCustomShader )
530 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
532 shader = GetImageShader( mFactoryCache,
533 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
534 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
538 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
539 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
541 shader = GetImageShader( mFactoryCache, false, true );
545 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
546 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
547 mImpl->mCustomShader->mHints );
548 if( mImpl->mCustomShader->mVertexShader.empty() )
550 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
555 // Set pixel align off as default.
556 // ToDo: Pixel align causes issues such as rattling image animation.
557 // We should trun it off until issues are resolved
558 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
560 mImpl->mRenderer = Renderer::New( geometry, shader );
563 mImpl->mRenderer.SetTextures( textureSet );
565 // else still waiting for texture load to finish.
567 //Register transform properties
568 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
571 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
576 std::string fragmentShader;
577 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
578 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
582 fragmentShader = fragmentPreFix;
583 fragmentShader += "\n";
586 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
588 fragmentShader += mImpl->mCustomShader->mFragmentShader;
592 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
595 if( customSamplerTypename )
597 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
600 if( !mImpl->mCustomShader )
602 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
604 shader = Shader::New( VERTEX_SHADER, fragmentShader );
605 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
609 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
610 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
612 mImpl->mCustomShader->mHints );
613 if( mImpl->mCustomShader->mVertexShader.empty() )
615 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
619 mImpl->mRenderer = Renderer::New( geometry, shader );
621 //Register transform properties
622 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
626 bool ImageVisual::IsSynchronousResourceLoading() const
628 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
631 void ImageVisual::LoadResourceSynchronously()
633 if( mImageUrl.IsValid() )
635 BitmapLoader loader = BitmapLoader::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
637 mPixels = loader.GetPixelData();
638 mTextureLoading = false;
642 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
644 TextureSet textureSet;
646 mTextureLoading = false;
648 textureRect = FULL_TEXTURE_RECT;
649 if( synchronousLoading )
654 textureSet = TextureSet::New();
655 TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
659 if( attemptAtlasing )
661 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
662 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
664 if( !textureSet ) // big image, no atlasing or atlasing failed
666 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
667 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
668 mPixels.GetWidth(), mPixels.GetHeight() );
669 texture.Upload( mPixels );
670 textureSet = TextureSet::New();
671 textureSet.SetTexture( 0u, texture );
677 if( attemptAtlasing )
679 textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
680 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
681 mTextureLoading = true;
683 if( !textureSet ) // big image, no atlasing or atlasing failed
685 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
686 TextureManager& textureManager = mFactoryCache.GetTextureManager();
687 if( mAlphaMaskId == TextureManager::INVALID_TEXTURE_ID )
689 mTextureId = textureManager.RequestLoad( mImageUrl, mDesiredSize, mFittingMode,
690 mSamplingMode, TextureManager::NO_ATLAS, this );
694 mTextureId = textureManager.RequestLoad( mImageUrl, mAlphaMaskId, mDesiredSize,
695 mFittingMode, mSamplingMode,
696 TextureManager::NO_ATLAS, this );
699 TextureManager::LoadState loadState = textureManager.GetTextureState( mTextureId );
701 mTextureLoading = ( loadState == TextureManager::LOADING );
703 if( loadState == TextureManager::UPLOADED )
705 // UploadComplete has already been called - keep the same texture set
706 textureSet = textureManager.GetTextureSet(mTextureId);
711 if( ! (mImpl->mFlags & Impl::IS_ATLASING_APPLIED) && textureSet )
713 Sampler sampler = Sampler::New();
714 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
715 textureSet.SetSampler( 0u, sampler );
721 void ImageVisual::InitializeRenderer()
723 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
725 if( ! mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL )
727 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
730 // texture set has to be created first as we need to know if atlasing succeeded or not
731 // when selecting the shader
732 TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), mAttemptAtlasing );
733 CreateRenderer( textures );
735 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
737 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
738 if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
740 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
741 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
742 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
748 // for custom shader or remote image, atlas is not applied
749 Vector4 atlasRect; // ignored in this case
750 TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
751 CreateRenderer( textures );
755 void ImageVisual::InitializeRenderer( const Image& image )
757 // don't reuse CreateTextureSet
758 TextureSet textures = TextureSet::New();
760 NativeImage nativeImage = NativeImage::DownCast( image );
763 CreateNativeImageRenderer( nativeImage );
764 DALI_ASSERT_DEBUG( textures );
765 mImpl->mRenderer.SetTextures( textures );
769 // reuse existing code for regular images
770 CreateRenderer( textures );
772 ApplyImageToSampler( image );
775 void ImageVisual::DoSetOnStage( Actor& actor )
777 if( mImageUrl.IsValid() )
779 InitializeRenderer();
783 InitializeRenderer( mImage );
786 if ( !mImpl->mRenderer )
791 mPlacementActor = actor;
792 // Search the Actor tree to find if Layer UI behaviour set.
793 Layer layer = actor.GetLayer();
794 if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
796 // Layer 3D set, do not align pixels
797 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
800 if( mPixelArea != FULL_TEXTURE_RECT )
802 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
805 if( mTextureLoading == false )
807 actor.AddRenderer( mImpl->mRenderer );
808 mPlacementActor.Reset();
810 // Image loaded and ready to display
815 void ImageVisual::DoSetOffStage( Actor& actor )
817 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
819 //If we own the image then make sure we release it when we go off stage
820 actor.RemoveRenderer( mImpl->mRenderer);
821 if( mImageUrl.IsValid() )
823 RemoveTexture( mImageUrl.GetUrl() );
826 mTextureLoading = false;
827 mImpl->mRenderer.Reset();
828 mPlacementActor.Reset();
831 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
834 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
836 bool sync = IsSynchronousResourceLoading();
837 map.Insert( SYNCHRONOUS_LOADING, sync );
838 if( mImageUrl.IsValid() )
840 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
841 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
842 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
846 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
847 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
849 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
852 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
856 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
857 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
859 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
860 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
861 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
863 map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing );
864 map.Insert( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, mAlphaMaskUrl.GetUrl() );
867 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
870 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
871 if( mImageUrl.IsValid() )
873 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
874 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
878 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
879 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
883 void ImageVisual::OnSetTransform()
885 if( mImpl->mRenderer )
887 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
891 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
896 if( defaultTextureWrapping )
898 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
901 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
902 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
903 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
908 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
911 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
912 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
913 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
919 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
922 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
923 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
924 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
931 void ImageVisual::ApplyImageToSampler( const Image& image )
935 TextureSet textureSet = mImpl->mRenderer.GetTextures();
936 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
938 TextureSetImage( textureSet, 0u, image );
939 Sampler sampler = Sampler::New();
940 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
941 textureSet.SetSampler( 0u, sampler );
945 // From existing atlas manager
946 void ImageVisual::UploadCompleted()
948 // Texture has been uploaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
949 Actor actor = mPlacementActor.GetHandle();
952 actor.AddRenderer( mImpl->mRenderer );
954 // reset the weak handle so that the renderer only get added to actor once
955 mPlacementActor.Reset();
957 mTextureLoading = false;
960 // From Texture Manager
961 void ImageVisual::UploadComplete( bool loadingSuccess, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
963 Actor actor = mPlacementActor.GetHandle();
966 if( mImpl->mRenderer )
968 actor.AddRenderer( mImpl->mRenderer );
969 // reset the weak handle so that the renderer only get added to actor once
970 mPlacementActor.Reset();
974 Sampler sampler = Sampler::New();
975 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
976 textureSet.SetSampler( 0u, sampler );
977 mImpl->mRenderer.SetTextures(textureSet);
981 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
983 textureSet = TextureSet::New();
984 mImpl->mRenderer.SetTextures( textureSet );
986 ApplyImageToSampler( brokenImage );
988 // Image loaded and ready to display
992 mTextureLoading = false;
995 void ImageVisual::RemoveTexture(const std::string& url)
997 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
999 mFactoryCache.GetTextureManager().Remove( mTextureId );
1000 mTextureId = TextureManager::INVALID_TEXTURE_ID;
1004 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
1005 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
1006 if( index != Property::INVALID_INDEX )
1008 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
1009 atlasRectValue.Get( atlasRect );
1012 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1013 mImpl->mRenderer.Reset();
1015 if( index != Property::INVALID_INDEX )
1017 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
1022 } // namespace Internal
1024 } // namespace Toolkit