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/image-loading.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/image-visual-properties-devel.h>
35 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
36 #include <dali-toolkit/internal/visuals/texture-manager.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");
64 const char * const ALPHA_MASK_URL("alphaMaskUrl");
67 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
73 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
76 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
83 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
84 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
87 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
90 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
91 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
92 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
94 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
96 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
98 const float PIXEL_ALIGN_ON = 1.0f;
99 const float PIXEL_ALIGN_OFF = 0.0f;
101 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
102 attribute mediump vec2 aPosition;\n
103 uniform mediump mat4 uModelMatrix;\n
104 uniform mediump mat4 uViewMatrix;\n
105 uniform mediump mat4 uProjection;\n
106 uniform mediump vec3 uSize;\n
107 uniform mediump vec4 pixelArea;
108 varying mediump vec2 vTexCoord;\n
109 uniform lowp float uPixelAligned;\n
111 //Visual size and offset
112 uniform mediump vec2 offset;\n
113 uniform mediump vec2 size;\n
114 uniform mediump vec4 offsetSizeMode;\n
115 uniform mediump vec2 origin;\n
116 uniform mediump vec2 anchorPoint;\n
118 vec4 ComputeVertexPosition()\n
120 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
121 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
122 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
127 mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
128 vec4 alignedVertexPosition = vertexPosition;\n
129 alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
130 vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
131 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
132 gl_Position = vertexPosition;\n
136 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
137 varying mediump vec2 vTexCoord;\n
138 uniform sampler2D sTexture;\n
139 uniform lowp vec4 uColor;\n
140 uniform lowp vec3 mixColor;\n
141 uniform lowp float opacity;\n
142 uniform lowp float preMultipliedAlpha;\n
144 lowp vec4 visualMixColor()\n
146 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
150 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
154 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
155 varying mediump vec2 vTexCoord;\n
156 uniform sampler2D sTexture;\n
157 uniform mediump vec4 uAtlasRect;\n
158 uniform lowp vec4 uColor;\n
159 uniform lowp vec3 mixColor;\n
160 uniform lowp float opacity;\n
161 uniform lowp float preMultipliedAlpha;\n
163 lowp vec4 visualMixColor()\n
165 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
170 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
171 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
175 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
176 varying mediump vec2 vTexCoord;\n
177 uniform sampler2D sTexture;\n
178 uniform mediump vec4 uAtlasRect;\n
179 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
180 uniform lowp vec2 wrapMode;\n
181 uniform lowp vec4 uColor;\n
182 uniform lowp vec3 mixColor;\n
183 uniform lowp float opacity;\n
184 uniform lowp float preMultipliedAlpha;\n
186 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
188 mediump float coord;\n
189 if( wrap > 1.5 )\n // REFLECT
190 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
191 else \n// warp == 0 or 1
192 coord = mix(coordinate, fract( coordinate ), wrap);\n
193 return clamp( mix(range.x, range.y, coord), range.x, range.y );
196 lowp vec4 visualMixColor()\n
198 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
203 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
204 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
205 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
209 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
213 if( gridSize == ImageDimensions( 1, 1 ) )
215 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
219 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
225 } // unnamed namespace
227 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
228 const VisualUrl& imageUrl,
229 const Property::Map& properties,
230 ImageDimensions size,
231 FittingMode::Type fittingMode,
232 Dali::SamplingMode::Type samplingMode )
234 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
235 imageVisualPtr->SetProperties( properties );
236 return imageVisualPtr;
239 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
240 const VisualUrl& imageUrl,
241 ImageDimensions size,
242 FittingMode::Type fittingMode,
243 Dali::SamplingMode::Type samplingMode )
245 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
248 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
250 return new ImageVisual( factoryCache, image );
253 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
254 const VisualUrl& imageUrl,
255 ImageDimensions size,
256 FittingMode::Type fittingMode,
257 Dali::SamplingMode::Type samplingMode )
258 : Visual::Base( factoryCache ),
261 mPixelArea( FULL_TEXTURE_RECT ),
263 mImageUrl( imageUrl ),
265 mDesiredSize( size ),
266 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
267 mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
268 mFittingMode( fittingMode ),
269 mSamplingMode( samplingMode ),
270 mWrapModeU( WrapMode::DEFAULT ),
271 mWrapModeV( WrapMode::DEFAULT ),
272 mAttemptAtlasing( false ),
273 mTextureLoading( false )
277 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
278 : Visual::Base( factoryCache ),
281 mPixelArea( FULL_TEXTURE_RECT ),
286 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
287 mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
288 mFittingMode( FittingMode::DEFAULT ),
289 mSamplingMode( SamplingMode::DEFAULT ),
290 mWrapModeU( WrapMode::DEFAULT ),
291 mWrapModeV( WrapMode::DEFAULT ),
292 mAttemptAtlasing( false ),
293 mTextureLoading( false )
297 ImageVisual::~ImageVisual()
299 if( mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
301 TextureManager& textureManager = mFactoryCache.GetTextureManager();
302 textureManager.Remove( mAlphaMaskId );
306 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
308 // Url is already received in constructor
309 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
311 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
312 if( keyValue.first.type == Property::Key::INDEX )
314 DoSetProperty( keyValue.first.indexKey, keyValue.second );
318 if( keyValue.first == IMAGE_FITTING_MODE )
320 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
322 else if( keyValue.first == IMAGE_SAMPLING_MODE )
324 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
326 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
328 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
330 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
332 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
334 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
336 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
338 else if( keyValue.first == IMAGE_WRAP_MODE_U )
340 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
342 else if( keyValue.first == IMAGE_WRAP_MODE_V )
344 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
346 else if( keyValue.first == SYNCHRONOUS_LOADING )
348 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
350 else if ( keyValue.first == IMAGE_ATLASING )
352 DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
354 else if ( keyValue.first == ALPHA_MASK_URL )
356 DoSetProperty( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
361 if( mAlphaMaskUrl.IsValid() )
363 // Immediately trigger the alpha mask loading (it may just get a cached value)
364 TextureManager& textureManager = mFactoryCache.GetTextureManager();
365 mAlphaMaskId = textureManager.RequestMaskLoad( mAlphaMaskUrl );
368 if( ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING ) && mImageUrl.IsValid() )
370 // if sync loading is required, the loading should start
371 // immediately when new image url is set or the actor is off stage
372 // ( for on-stage actor with image url unchanged, resource loading
373 // is already finished )
374 LoadResourceSynchronously();
378 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
382 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
385 if( value.Get( sync ) )
389 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
393 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
398 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
403 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
406 if( value.Get( desiredWidth ) )
408 mDesiredSize.SetWidth( desiredWidth );
412 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
417 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
420 if( value.Get( desiredHeight ) )
422 mDesiredSize.SetHeight( desiredHeight );
426 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
431 case Toolkit::ImageVisual::Property::FITTING_MODE:
434 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
435 mFittingMode = Dali::FittingMode::Type( fittingMode );
439 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
442 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
443 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
447 case Toolkit::ImageVisual::Property::PIXEL_AREA:
449 value.Get( mPixelArea );
453 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
456 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
457 mWrapModeU = Dali::WrapMode::Type( wrapMode );
461 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
464 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
465 mWrapModeV = Dali::WrapMode::Type( wrapMode );
469 case Toolkit::DevelImageVisual::Property::ATLASING:
471 bool atlasing = false;
472 mAttemptAtlasing = value.Get( atlasing );
475 case Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL:
477 std::string alphaUrl;
478 if( value.Get( alphaUrl ) )
480 mAlphaMaskUrl = VisualUrl( alphaUrl );
486 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
490 naturalSize.x = mImage.GetWidth();
491 naturalSize.y = mImage.GetHeight();
494 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
496 naturalSize.x = mDesiredSize.GetWidth();
497 naturalSize.y = mDesiredSize.GetHeight();
500 else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL )
502 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
504 if( dimensions != ImageDimensions( 0, 0 ) )
506 naturalSize.x = dimensions.GetWidth();
507 naturalSize.y = dimensions.GetHeight();
511 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
513 naturalSize.x = brokenImage.GetWidth();
514 naturalSize.y = brokenImage.GetWidth();
519 naturalSize = Vector2::ZERO;
522 void ImageVisual::CreateRenderer( TextureSet& textureSet )
527 if( !mImpl->mCustomShader )
529 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
531 shader = GetImageShader( mFactoryCache,
532 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
533 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
537 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
538 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
540 shader = GetImageShader( mFactoryCache, false, true );
544 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
545 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
546 mImpl->mCustomShader->mHints );
547 if( mImpl->mCustomShader->mVertexShader.empty() )
549 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
554 // Set pixel align off as default.
555 // ToDo: Pixel align causes issues such as rattling image animation.
556 // We should trun it off until issues are resolved
557 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
559 mImpl->mRenderer = Renderer::New( geometry, shader );
562 mImpl->mRenderer.SetTextures( textureSet );
564 // else still waiting for texture load to finish.
566 //Register transform properties
567 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
570 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
575 std::string fragmentShader;
576 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
577 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
581 fragmentShader = fragmentPreFix;
582 fragmentShader += "\n";
585 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
587 fragmentShader += mImpl->mCustomShader->mFragmentShader;
591 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
594 if( customSamplerTypename )
596 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
599 if( !mImpl->mCustomShader )
601 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
603 shader = Shader::New( VERTEX_SHADER, fragmentShader );
604 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
608 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
609 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
611 mImpl->mCustomShader->mHints );
612 if( mImpl->mCustomShader->mVertexShader.empty() )
614 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
618 mImpl->mRenderer = Renderer::New( geometry, shader );
620 //Register transform properties
621 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
625 bool ImageVisual::IsSynchronousResourceLoading() const
627 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
630 void ImageVisual::LoadResourceSynchronously()
632 if( mImageUrl.IsValid() )
634 Devel::PixelBuffer pixelBuffer = LoadImageFromFile( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
638 mPixels = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
640 mTextureLoading = false;
644 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
646 TextureSet textureSet;
648 mTextureLoading = false;
650 textureRect = FULL_TEXTURE_RECT;
651 if( synchronousLoading )
656 textureSet = TextureSet::New();
657 TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
661 if( attemptAtlasing )
663 textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
664 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
666 if( !textureSet ) // big image, no atlasing or atlasing failed
668 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
669 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
670 mPixels.GetWidth(), mPixels.GetHeight() );
671 texture.Upload( mPixels );
672 textureSet = TextureSet::New();
673 textureSet.SetTexture( 0u, texture );
679 if( attemptAtlasing )
681 textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
682 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
683 mTextureLoading = true;
685 if( !textureSet ) // big image, no atlasing or atlasing failed
687 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
688 TextureManager& textureManager = mFactoryCache.GetTextureManager();
689 if( mAlphaMaskId == TextureManager::INVALID_TEXTURE_ID )
691 mTextureId = textureManager.RequestLoad( mImageUrl, mDesiredSize, mFittingMode,
692 mSamplingMode, TextureManager::NO_ATLAS, this );
696 mTextureId = textureManager.RequestLoad( mImageUrl, mAlphaMaskId, mDesiredSize,
697 mFittingMode, mSamplingMode,
698 TextureManager::NO_ATLAS, this );
701 TextureManager::LoadState loadState = textureManager.GetTextureState( mTextureId );
703 mTextureLoading = ( loadState == TextureManager::LOADING );
705 if( loadState == TextureManager::UPLOADED )
707 // UploadComplete has already been called - keep the same texture set
708 textureSet = textureManager.GetTextureSet(mTextureId);
713 if( ! (mImpl->mFlags & Impl::IS_ATLASING_APPLIED) && textureSet )
715 Sampler sampler = Sampler::New();
716 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
717 textureSet.SetSampler( 0u, sampler );
723 void ImageVisual::InitializeRenderer()
725 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
727 if( ! mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL )
729 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
732 // texture set has to be created first as we need to know if atlasing succeeded or not
733 // when selecting the shader
734 TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), mAttemptAtlasing );
735 CreateRenderer( textures );
737 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
739 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
740 if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
742 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
743 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
744 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
750 // for custom shader or remote image, atlas is not applied
751 Vector4 atlasRect; // ignored in this case
752 TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
753 CreateRenderer( textures );
757 void ImageVisual::InitializeRenderer( const Image& image )
759 // don't reuse CreateTextureSet
760 TextureSet textures = TextureSet::New();
762 NativeImage nativeImage = NativeImage::DownCast( image );
765 CreateNativeImageRenderer( nativeImage );
766 DALI_ASSERT_DEBUG( textures );
767 mImpl->mRenderer.SetTextures( textures );
771 // reuse existing code for regular images
772 CreateRenderer( textures );
774 ApplyImageToSampler( image );
777 void ImageVisual::DoSetOnStage( Actor& actor )
779 if( mImageUrl.IsValid() )
781 InitializeRenderer();
785 InitializeRenderer( mImage );
788 if ( !mImpl->mRenderer )
793 mPlacementActor = actor;
794 // Search the Actor tree to find if Layer UI behaviour set.
795 Layer layer = actor.GetLayer();
796 if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
798 // Layer 3D set, do not align pixels
799 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
802 if( mPixelArea != FULL_TEXTURE_RECT )
804 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
807 if( mTextureLoading == false )
809 actor.AddRenderer( mImpl->mRenderer );
810 mPlacementActor.Reset();
812 // Image loaded and ready to display
817 void ImageVisual::DoSetOffStage( Actor& actor )
819 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
821 //If we own the image then make sure we release it when we go off stage
822 actor.RemoveRenderer( mImpl->mRenderer);
823 if( mImageUrl.IsValid() )
825 RemoveTexture( mImageUrl.GetUrl() );
828 mTextureLoading = false;
829 mImpl->mRenderer.Reset();
830 mPlacementActor.Reset();
833 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
836 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
838 bool sync = IsSynchronousResourceLoading();
839 map.Insert( SYNCHRONOUS_LOADING, sync );
840 if( mImageUrl.IsValid() )
842 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
843 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
844 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
848 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
849 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
851 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
854 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
858 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
859 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
861 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
862 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
863 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
865 map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing );
866 map.Insert( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, mAlphaMaskUrl.GetUrl() );
869 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
872 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
873 if( mImageUrl.IsValid() )
875 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
876 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
880 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
881 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
885 void ImageVisual::OnSetTransform()
887 if( mImpl->mRenderer )
889 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
893 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
898 if( defaultTextureWrapping )
900 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
903 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
904 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
905 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
910 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
913 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
914 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
915 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
921 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
924 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
925 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
926 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
933 void ImageVisual::ApplyImageToSampler( const Image& image )
937 TextureSet textureSet = mImpl->mRenderer.GetTextures();
938 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
940 TextureSetImage( textureSet, 0u, image );
941 Sampler sampler = Sampler::New();
942 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
943 textureSet.SetSampler( 0u, sampler );
947 // From existing atlas manager
948 void ImageVisual::UploadCompleted()
950 // Texture has been uploaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
951 Actor actor = mPlacementActor.GetHandle();
954 actor.AddRenderer( mImpl->mRenderer );
956 // reset the weak handle so that the renderer only get added to actor once
957 mPlacementActor.Reset();
959 mTextureLoading = false;
962 // From Texture Manager
963 void ImageVisual::UploadComplete( bool loadingSuccess, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
965 Actor actor = mPlacementActor.GetHandle();
968 if( mImpl->mRenderer )
970 actor.AddRenderer( mImpl->mRenderer );
971 // reset the weak handle so that the renderer only get added to actor once
972 mPlacementActor.Reset();
976 Sampler sampler = Sampler::New();
977 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
978 textureSet.SetSampler( 0u, sampler );
979 mImpl->mRenderer.SetTextures(textureSet);
983 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
985 textureSet = TextureSet::New();
986 mImpl->mRenderer.SetTextures( textureSet );
988 ApplyImageToSampler( brokenImage );
990 // Image loaded and ready to display
994 mTextureLoading = false;
997 void ImageVisual::RemoveTexture(const std::string& url)
999 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
1001 mFactoryCache.GetTextureManager().Remove( mTextureId );
1002 mTextureId = TextureManager::INVALID_TEXTURE_ID;
1006 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
1007 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
1008 if( index != Property::INVALID_INDEX )
1010 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
1011 atlasRectValue.Get( atlasRect );
1014 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1015 mImpl->mRenderer.Reset();
1017 if( index != Property::INVALID_INDEX )
1019 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
1024 } // namespace Internal
1026 } // namespace Toolkit