2 * Copyright (c) 2018 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/common/stage.h>
25 #include <dali/public-api/images/resource-image.h>
26 #include <dali/public-api/images/native-image.h>
27 #include <dali/devel-api/images/texture-set-image.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/public-api/visuals/visual-properties.h>
36 #include <dali-toolkit/devel-api/visuals/image-visual-actions-devel.h>
37 #include <dali-toolkit/internal/visuals/texture-manager-impl.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 )
96 DALI_ENUM_TO_STRING_TABLE_BEGIN( LOAD_POLICY )
97 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE )
98 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED )
99 DALI_ENUM_TO_STRING_TABLE_END( LOAD_POLICY )
102 DALI_ENUM_TO_STRING_TABLE_BEGIN( RELEASE_POLICY )
103 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED )
104 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED )
105 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER )
106 DALI_ENUM_TO_STRING_TABLE_END( RELEASE_POLICY )
108 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
110 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
112 const float PIXEL_ALIGN_ON = 1.0f;
113 const float PIXEL_ALIGN_OFF = 0.0f;
115 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
116 attribute mediump vec2 aPosition;\n
117 uniform mediump mat4 uModelMatrix;\n
118 uniform mediump mat4 uViewMatrix;\n
119 uniform mediump mat4 uProjection;\n
120 uniform mediump vec3 uSize;\n
121 uniform mediump vec4 pixelArea;
122 varying mediump vec2 vTexCoord;\n
123 uniform lowp float uPixelAligned;\n
125 //Visual size and offset
126 uniform mediump vec2 offset;\n
127 uniform mediump vec2 size;\n
128 uniform mediump vec4 offsetSizeMode;\n
129 uniform mediump vec2 origin;\n
130 uniform mediump vec2 anchorPoint;\n
132 vec4 ComputeVertexPosition()\n
134 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
135 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
136 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
141 mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
142 vec4 alignedVertexPosition = vertexPosition;\n
143 alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
144 vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
145 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
146 gl_Position = vertexPosition;\n
150 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
151 varying mediump vec2 vTexCoord;\n
152 uniform sampler2D sTexture;\n
153 uniform lowp vec4 uColor;\n
154 uniform lowp vec3 mixColor;\n
155 uniform lowp float preMultipliedAlpha;\n
159 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * vec4( mixColor, 1.0 );\n
163 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
164 varying mediump vec2 vTexCoord;\n
165 uniform sampler2D sTexture;\n
166 uniform mediump vec4 uAtlasRect;\n
167 uniform lowp vec4 uColor;\n
168 uniform lowp vec3 mixColor;\n
169 uniform lowp float preMultipliedAlpha;\n
173 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
174 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * vec4( mixColor, 1.0 );\n
178 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
179 varying mediump vec2 vTexCoord;\n
180 uniform sampler2D sTexture;\n
181 uniform mediump vec4 uAtlasRect;\n
182 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
183 uniform lowp vec2 wrapMode;\n
184 uniform lowp vec4 uColor;\n
185 uniform lowp vec3 mixColor;\n
186 uniform lowp float preMultipliedAlpha;\n
188 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
190 mediump float coord;\n
191 if( wrap > 1.5 )\n // REFLECT
192 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
193 else \n// warp == 0 or 1
194 coord = mix(coordinate, fract( coordinate ), wrap);\n
195 return clamp( mix(range.x, range.y, coord), range.x, range.y );
200 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
201 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
202 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * vec4( mixColor, 1.0 );\n
206 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
210 if( gridSize == ImageDimensions( 1, 1 ) )
212 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
216 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
222 } // unnamed namespace
224 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
225 const VisualUrl& imageUrl,
226 const Property::Map& properties,
227 ImageDimensions size,
228 FittingMode::Type fittingMode,
229 Dali::SamplingMode::Type samplingMode )
231 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
232 imageVisualPtr->SetProperties( properties );
233 return imageVisualPtr;
236 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
237 const VisualUrl& imageUrl,
238 ImageDimensions size,
239 FittingMode::Type fittingMode,
240 Dali::SamplingMode::Type samplingMode )
242 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
245 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
247 return new ImageVisual( factoryCache, image );
250 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
251 const VisualUrl& imageUrl,
252 ImageDimensions size,
253 FittingMode::Type fittingMode,
254 Dali::SamplingMode::Type samplingMode )
255 : Visual::Base( factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ),
257 mPixelArea( FULL_TEXTURE_RECT ),
259 mImageUrl( imageUrl ),
261 mDesiredSize( size ),
262 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
264 mFittingMode( fittingMode ),
265 mSamplingMode( samplingMode ),
266 mWrapModeU( WrapMode::DEFAULT ),
267 mWrapModeV( WrapMode::DEFAULT ),
268 mLoadPolicy( Toolkit::ImageVisual::LoadPolicy::ATTACHED ),
269 mReleasePolicy( Toolkit::ImageVisual::ReleasePolicy::DETACHED ),
270 mAtlasRect( 0.0f, 0.0f, 0.0f, 0.0f ),
271 mAttemptAtlasing( false ),
273 mOrientationCorrection( true )
277 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
278 : Visual::Base( factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ),
280 mPixelArea( FULL_TEXTURE_RECT ),
285 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
287 mFittingMode( FittingMode::DEFAULT ),
288 mSamplingMode( SamplingMode::DEFAULT ),
289 mWrapModeU( WrapMode::DEFAULT ),
290 mWrapModeV( WrapMode::DEFAULT ),
291 mLoadPolicy( Toolkit::ImageVisual::LoadPolicy::ATTACHED ),
292 mReleasePolicy( Toolkit::ImageVisual::ReleasePolicy::DESTROYED ),
293 mAtlasRect( 0.0f, 0.0f, 0.0f, 0.0f ),
294 mAttemptAtlasing( false ),
296 mOrientationCorrection( true )
300 ImageVisual::~ImageVisual()
302 if( Stage::IsInstalled() )
306 // TextureManager could have been deleted before the actor that contains this
307 // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
308 // is still valid before accessing texture manager.
309 if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
311 TextureManager& textureManager = mFactoryCache.GetTextureManager();
312 textureManager.Remove( mMaskingData->mAlphaMaskId );
316 // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
317 if( ( mTextureId != TextureManager::INVALID_TEXTURE_ID ) && ( mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER ) )
324 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
326 // Url is already received in constructor
327 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
329 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
330 if( keyValue.first.type == Property::Key::INDEX )
332 DoSetProperty( keyValue.first.indexKey, keyValue.second );
336 if( keyValue.first == IMAGE_FITTING_MODE )
338 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
340 else if( keyValue.first == IMAGE_SAMPLING_MODE )
342 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
344 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
346 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
348 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
350 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
352 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
354 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
356 else if( keyValue.first == IMAGE_WRAP_MODE_U )
358 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
360 else if( keyValue.first == IMAGE_WRAP_MODE_V )
362 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
364 else if( keyValue.first == SYNCHRONOUS_LOADING )
366 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
368 else if( keyValue.first == IMAGE_ATLASING )
370 DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
372 else if( keyValue.first == ALPHA_MASK_URL )
374 DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
376 else if( keyValue.first == MASK_CONTENT_SCALE_NAME )
378 DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
380 else if( keyValue.first == CROP_TO_MASK_NAME )
382 DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second );
384 else if ( keyValue.first == LOAD_POLICY_NAME )
386 DoSetProperty( Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second );
388 else if( keyValue.first == RELEASE_POLICY_NAME )
390 DoSetProperty( Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second );
392 else if( keyValue.first == ORIENTATION_CORRECTION_NAME )
394 DoSetProperty( Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, keyValue.second );
398 // Load image immediately if LOAD_POLICY requires it
399 if ( mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE )
401 auto attemptAtlasing = AttemptAtlasing();
402 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
403 TextureManager::ReloadPolicy::CACHED );
407 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
411 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
414 if( value.Get( sync ) )
418 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
422 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
427 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
432 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
435 if( value.Get( desiredWidth ) )
437 mDesiredSize.SetWidth( desiredWidth );
441 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
446 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
449 if( value.Get( desiredHeight ) )
451 mDesiredSize.SetHeight( desiredHeight );
455 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
460 case Toolkit::ImageVisual::Property::FITTING_MODE:
463 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
464 mFittingMode = Dali::FittingMode::Type( fittingMode );
468 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
471 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
472 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
476 case Toolkit::ImageVisual::Property::PIXEL_AREA:
478 value.Get( mPixelArea );
482 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
485 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
486 mWrapModeU = Dali::WrapMode::Type( wrapMode );
490 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
493 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
494 mWrapModeV = Dali::WrapMode::Type( wrapMode );
498 case Toolkit::ImageVisual::Property::ATLASING:
500 value.Get( mAttemptAtlasing );
504 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
506 std::string alphaUrl;
507 if( value.Get( alphaUrl ) )
510 // Immediately trigger the alpha mask loading (it may just get a cached value)
511 mMaskingData->mAlphaMaskUrl = alphaUrl;
512 TextureManager& textureManager = mFactoryCache.GetTextureManager();
513 mMaskingData->mAlphaMaskId = textureManager.RequestMaskLoad( alphaUrl );
518 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
521 if( value.Get( scale ) )
524 mMaskingData->mContentScaleFactor = scale;
529 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
532 if( value.Get( crop ) )
535 mMaskingData->mCropToMask = crop;
540 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
543 Scripting::GetEnumerationProperty( value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy );
544 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type( releasePolicy );
548 case Toolkit::ImageVisual::Property::LOAD_POLICY:
551 Scripting::GetEnumerationProperty( value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy );
552 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type( loadPolicy );
555 case Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION:
557 bool orientationCorrection( mOrientationCorrection );
558 if( value.Get( orientationCorrection ) )
560 mOrientationCorrection = orientationCorrection;
567 void ImageVisual::AllocateMaskData()
571 mMaskingData.reset(new TextureManager::MaskingData());
575 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
579 naturalSize.x = mImage.GetWidth();
580 naturalSize.y = mImage.GetHeight();
583 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
585 naturalSize.x = mDesiredSize.GetWidth();
586 naturalSize.y = mDesiredSize.GetHeight();
589 else if( mImpl->mRenderer ) // Check if we have a loaded image
591 auto textureSet = mImpl->mRenderer.GetTextures();
595 auto texture = textureSet.GetTexture(0);
596 naturalSize.x = texture.GetWidth();
597 naturalSize.y = texture.GetHeight();
602 if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
603 mMaskingData->mCropToMask )
605 ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() );
606 if( dimensions != ImageDimensions( 0, 0 ) )
608 naturalSize.x = dimensions.GetWidth();
609 naturalSize.y = dimensions.GetHeight();
613 else if( mImageUrl.IsValid() )
615 if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
617 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
619 if( dimensions != ImageDimensions( 0, 0 ) )
621 naturalSize.x = dimensions.GetWidth();
622 naturalSize.y = dimensions.GetHeight();
626 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
628 naturalSize.x = brokenImage.GetWidth();
629 naturalSize.y = brokenImage.GetWidth();
635 naturalSize = Vector2::ZERO;
638 void ImageVisual::CreateRenderer( TextureSet& textureSet )
643 if( !mImpl->mCustomShader )
645 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
647 shader = GetImageShader( mFactoryCache,
648 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
649 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
653 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
654 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
656 shader = GetImageShader( mFactoryCache, false, true );
660 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
661 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
662 mImpl->mCustomShader->mHints );
663 if( mImpl->mCustomShader->mVertexShader.empty() )
665 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
670 // Set pixel align off as default.
671 // ToDo: Pixel align causes issues such as rattling image animation.
672 // We should trun it off until issues are resolved
673 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
675 mImpl->mRenderer = Renderer::New( geometry, shader );
678 mImpl->mRenderer.SetTextures( textureSet );
680 // else still waiting for texture load to finish.
682 //Register transform properties
683 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
685 if( IsPreMultipliedAlphaEnabled() )
687 EnablePreMultipliedAlpha( true );
691 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
696 std::string fragmentShader;
697 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
698 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
702 fragmentShader = fragmentPreFix;
703 fragmentShader += "\n";
706 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
708 fragmentShader += mImpl->mCustomShader->mFragmentShader;
712 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
715 if( customSamplerTypename )
717 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
720 if( !mImpl->mCustomShader )
722 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
724 shader = Shader::New( VERTEX_SHADER, fragmentShader );
725 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
729 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
730 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
732 mImpl->mCustomShader->mHints );
733 if( mImpl->mCustomShader->mVertexShader.empty() )
735 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
739 mImpl->mRenderer = Renderer::New( geometry, shader );
741 //Register transform properties
742 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
745 bool ImageVisual::IsSynchronousResourceLoading() const
747 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
750 void ImageVisual::LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection,
751 TextureManager::ReloadPolicy forceReload )
753 TextureManager& textureManager = mFactoryCache.GetTextureManager();
755 ImageAtlasManagerPtr atlasManager = nullptr;
756 AtlasUploadObserver* atlasUploadObserver = nullptr;
757 auto textureObserver = this;
761 atlasManager = mFactoryCache.GetAtlasManager();
762 atlasUploadObserver = this;
765 auto preMultiplyOnLoad = mFactoryCache.GetPreMultiplyOnLoad() && !mImpl->mCustomShader
766 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
767 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
769 textures = textureManager.LoadTexture( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
770 mMaskingData, IsSynchronousResourceLoading(), mTextureId,
771 atlasRect, atlasing, mLoading, mWrapModeU,
772 mWrapModeV, textureObserver, atlasUploadObserver, atlasManager,
773 mOrientationCorrection, forceReload, preMultiplyOnLoad);
775 if( textures && preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
777 EnablePreMultipliedAlpha( true );
780 if( atlasing ) // Flag needs to be set before creating renderer
782 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
786 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
790 bool ImageVisual::AttemptAtlasing()
792 return ( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL && mAttemptAtlasing );
795 void ImageVisual::InitializeRenderer()
797 auto attemptAtlasing = AttemptAtlasing();
798 // texture set has to be created first as we need to know if atlasing succeeded or not
799 // when selecting the shader
801 if( mTextureId == TextureManager::INVALID_TEXTURE_ID && ! mTextures ) // Only load the texture once
803 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
804 TextureManager::ReloadPolicy::CACHED );
807 CreateRenderer( mTextures );
808 mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
810 if( attemptAtlasing ) // the texture is packed inside atlas
812 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
814 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
816 if( !defaultWrapMode ) // custom wrap mode
818 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
819 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
820 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
825 void ImageVisual::InitializeRenderer( const Image& image )
827 TextureSet textures = TextureSet::New();
829 NativeImage nativeImage = NativeImage::DownCast( image );
832 CreateNativeImageRenderer( nativeImage );
833 DALI_ASSERT_DEBUG( textures );
834 mImpl->mRenderer.SetTextures( textures );
838 // reuse existing code for regular images
839 CreateRenderer( textures ); // Textures will be retreived from Image
841 ApplyImageToSampler( image );
844 void ImageVisual::DoSetOnStage( Actor& actor )
846 if( mImageUrl.IsValid() )
848 InitializeRenderer();
852 InitializeRenderer( mImage );
855 if( !mImpl->mRenderer )
860 mPlacementActor = actor;
861 // Search the Actor tree to find if Layer UI behaviour set.
862 Layer layer = actor.GetLayer();
863 if( layer && layer.GetBehavior() == Layer::LAYER_3D )
865 // Layer 3D set, do not align pixels
866 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
869 if( mPixelArea != FULL_TEXTURE_RECT )
871 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
874 if( mLoading == false )
876 actor.AddRenderer( mImpl->mRenderer );
877 mPlacementActor.Reset();
879 // Image loaded and ready to display
880 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
884 void ImageVisual::DoSetOffStage( Actor& actor )
886 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
888 // Image release is dependent on the ReleasePolicy, renderer is destroyed.
889 actor.RemoveRenderer( mImpl->mRenderer);
890 if( mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED )
892 RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
895 if( mImageUrl.IsValid() )
897 // Legacy support for deprecated Dali::Image
901 mImpl->mRenderer.Reset();
902 mPlacementActor.Reset();
905 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
908 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
910 bool sync = IsSynchronousResourceLoading();
911 map.Insert( SYNCHRONOUS_LOADING, sync );
912 if( mImageUrl.IsValid() )
914 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
915 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
916 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
920 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
921 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
923 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
926 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
930 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
931 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
933 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
934 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
935 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
937 map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
939 if( mMaskingData != NULL )
941 map.Insert( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
942 map.Insert( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
943 map.Insert( Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
946 map.Insert( Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy );
947 map.Insert( Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy );
948 map.Insert( Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection );
951 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
954 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
955 if( mImageUrl.IsValid() )
957 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
958 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
962 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
963 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
967 void ImageVisual::OnDoAction( const Dali::Property::Index actionName, const Dali::Property::Value& attributes )
969 // Check if action is valid for this visual type and perform action if possible
971 switch ( actionName )
973 case DevelImageVisual::Action::RELOAD:
975 auto attemptAtlasing = AttemptAtlasing();
976 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
977 TextureManager::ReloadPolicy::FORCED );
983 void ImageVisual::OnSetTransform()
985 if( mImpl->mRenderer )
987 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
991 bool ImageVisual::IsResourceReady() const
993 return ( mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY ||
994 mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED );
997 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
1002 if( defaultTextureWrapping )
1004 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
1007 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
1008 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
1009 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
1014 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
1017 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
1018 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
1019 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
1025 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
1028 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
1029 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
1030 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
1037 void ImageVisual::ApplyImageToSampler( const Image& image )
1041 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1042 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
1044 TextureSetImage( textureSet, 0u, image );
1045 Sampler sampler = Sampler::New();
1046 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
1047 textureSet.SetSampler( 0u, sampler );
1051 // From existing atlas manager
1052 void ImageVisual::UploadCompleted()
1054 // Texture has been uploaded. If weak handle is holding a placement actor,
1055 // it is the time to add the renderer to actor.
1056 Actor actor = mPlacementActor.GetHandle();
1059 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
1060 actor.AddRenderer( mImpl->mRenderer );
1061 // reset the weak handle so that the renderer only get added to actor once
1062 mPlacementActor.Reset();
1065 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
1069 // From Texture Manager
1070 void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas,
1071 const Vector4& atlasRectangle, bool preMultiplied )
1073 Toolkit::Visual::ResourceStatus resourceStatus;
1074 Actor actor = mPlacementActor.GetHandle();
1077 if( mImpl->mRenderer )
1081 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
1083 else if( preMultiplied )
1085 EnablePreMultipliedAlpha( true );
1088 actor.AddRenderer( mImpl->mRenderer );
1089 // reset the weak handle so that the renderer only get added to actor once
1090 mPlacementActor.Reset();
1091 if( loadingSuccess )
1093 Sampler sampler = Sampler::New();
1094 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
1095 textureSet.SetSampler( 0u, sampler );
1096 mImpl->mRenderer.SetTextures(textureSet);
1100 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
1102 textureSet = TextureSet::New();
1103 mImpl->mRenderer.SetTextures( textureSet );
1105 ApplyImageToSampler( brokenImage );
1109 // Storing TextureSet needed when renderer staged.
1110 if( ! mImpl->mRenderer )
1112 mTextures = textureSet;
1115 // Image loaded, set status regardless of staged status.
1116 if( loadingSuccess )
1118 resourceStatus = Toolkit::Visual::ResourceStatus::READY;
1122 resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
1124 // Signal to observers ( control ) that resources are ready. Must be all resources.
1125 ResourceReady( resourceStatus );
1129 void ImageVisual::RemoveTexture()
1131 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
1133 mFactoryCache.GetTextureManager().Remove( mTextureId );
1134 mTextureId = TextureManager::INVALID_TEXTURE_ID;
1138 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
1139 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
1140 if( index != Property::INVALID_INDEX )
1142 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
1143 atlasRectValue.Get( atlasRect );
1146 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1147 mImpl->mRenderer.Reset();
1149 if( index != Property::INVALID_INDEX )
1151 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
1156 } // namespace Internal
1158 } // namespace Toolkit