2 * Copyright (c) 2017 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/internal/visuals/texture-manager-impl.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 )
95 DALI_ENUM_TO_STRING_TABLE_BEGIN( LOAD_POLICY )
96 DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::LoadPolicy, IMMEDIATE )
97 DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::LoadPolicy, ATTACHED )
98 DALI_ENUM_TO_STRING_TABLE_END( LOAD_POLICY )
101 DALI_ENUM_TO_STRING_TABLE_BEGIN( RELEASE_POLICY )
102 DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, DETACHED )
103 DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, DESTROYED )
104 DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, NEVER )
105 DALI_ENUM_TO_STRING_TABLE_END( RELEASE_POLICY )
107 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
109 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
111 const float PIXEL_ALIGN_ON = 1.0f;
112 const float PIXEL_ALIGN_OFF = 0.0f;
114 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
115 attribute mediump vec2 aPosition;\n
116 uniform mediump mat4 uModelMatrix;\n
117 uniform mediump mat4 uViewMatrix;\n
118 uniform mediump mat4 uProjection;\n
119 uniform mediump vec3 uSize;\n
120 uniform mediump vec4 pixelArea;
121 varying mediump vec2 vTexCoord;\n
122 uniform lowp float uPixelAligned;\n
124 //Visual size and offset
125 uniform mediump vec2 offset;\n
126 uniform mediump vec2 size;\n
127 uniform mediump vec4 offsetSizeMode;\n
128 uniform mediump vec2 origin;\n
129 uniform mediump vec2 anchorPoint;\n
131 vec4 ComputeVertexPosition()\n
133 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
134 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
135 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
140 mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
141 vec4 alignedVertexPosition = vertexPosition;\n
142 alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
143 vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
144 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
145 gl_Position = vertexPosition;\n
149 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
150 varying mediump vec2 vTexCoord;\n
151 uniform sampler2D sTexture;\n
152 uniform lowp vec4 uColor;\n
153 uniform lowp vec3 mixColor;\n
154 uniform lowp float opacity;\n
155 uniform lowp float preMultipliedAlpha;\n
157 lowp vec4 visualMixColor()\n
159 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
163 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
167 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
168 varying mediump vec2 vTexCoord;\n
169 uniform sampler2D sTexture;\n
170 uniform mediump vec4 uAtlasRect;\n
171 uniform lowp vec4 uColor;\n
172 uniform lowp vec3 mixColor;\n
173 uniform lowp float opacity;\n
174 uniform lowp float preMultipliedAlpha;\n
176 lowp vec4 visualMixColor()\n
178 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
183 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
184 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
188 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
189 varying mediump vec2 vTexCoord;\n
190 uniform sampler2D sTexture;\n
191 uniform mediump vec4 uAtlasRect;\n
192 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
193 uniform lowp vec2 wrapMode;\n
194 uniform lowp vec4 uColor;\n
195 uniform lowp vec3 mixColor;\n
196 uniform lowp float opacity;\n
197 uniform lowp float preMultipliedAlpha;\n
199 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
201 mediump float coord;\n
202 if( wrap > 1.5 )\n // REFLECT
203 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
204 else \n// warp == 0 or 1
205 coord = mix(coordinate, fract( coordinate ), wrap);\n
206 return clamp( mix(range.x, range.y, coord), range.x, range.y );
209 lowp vec4 visualMixColor()\n
211 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
216 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
217 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
218 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
222 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
226 if( gridSize == ImageDimensions( 1, 1 ) )
228 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
232 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
238 } // unnamed namespace
240 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
241 const VisualUrl& imageUrl,
242 const Property::Map& properties,
243 ImageDimensions size,
244 FittingMode::Type fittingMode,
245 Dali::SamplingMode::Type samplingMode )
247 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
248 imageVisualPtr->SetProperties( properties );
249 return imageVisualPtr;
252 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
253 const VisualUrl& imageUrl,
254 ImageDimensions size,
255 FittingMode::Type fittingMode,
256 Dali::SamplingMode::Type samplingMode )
258 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
261 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
263 return new ImageVisual( factoryCache, image );
266 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
267 const VisualUrl& imageUrl,
268 ImageDimensions size,
269 FittingMode::Type fittingMode,
270 Dali::SamplingMode::Type samplingMode )
271 : Visual::Base( factoryCache ),
273 mPixelArea( FULL_TEXTURE_RECT ),
275 mImageUrl( imageUrl ),
277 mDesiredSize( size ),
278 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
279 mFittingMode( fittingMode ),
280 mSamplingMode( samplingMode ),
281 mWrapModeU( WrapMode::DEFAULT ),
282 mWrapModeV( WrapMode::DEFAULT ),
283 mLoadPolicy( DevelImageVisual::LoadPolicy::ATTACHED ),
284 mReleasePolicy( DevelImageVisual::ReleasePolicy::DETACHED ),
285 mAttemptAtlasing( false ),
290 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
291 : Visual::Base( factoryCache ),
293 mPixelArea( FULL_TEXTURE_RECT ),
298 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
299 mFittingMode( FittingMode::DEFAULT ),
300 mSamplingMode( SamplingMode::DEFAULT ),
301 mWrapModeU( WrapMode::DEFAULT ),
302 mWrapModeV( WrapMode::DEFAULT ),
303 mLoadPolicy( DevelImageVisual::LoadPolicy::ATTACHED ),
304 mReleasePolicy( DevelImageVisual::ReleasePolicy::DESTROYED ),
305 mAttemptAtlasing( false ),
310 ImageVisual::~ImageVisual()
312 if( Stage::IsInstalled() )
316 // TextureManager could have been deleted before the actor that contains this
317 // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
318 // is still valid before accessing texture manager.
319 if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
321 TextureManager& textureManager = mFactoryCache.GetTextureManager();
322 textureManager.Remove( mMaskingData->mAlphaMaskId );
326 // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
327 if( ( mTextureId != TextureManager::INVALID_TEXTURE_ID ) && ( mReleasePolicy != DevelImageVisual::ReleasePolicy::NEVER ) )
334 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
336 // Url is already received in constructor
337 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
339 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
340 if( keyValue.first.type == Property::Key::INDEX )
342 DoSetProperty( keyValue.first.indexKey, keyValue.second );
346 if( keyValue.first == IMAGE_FITTING_MODE )
348 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
350 else if( keyValue.first == IMAGE_SAMPLING_MODE )
352 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
354 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
356 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
358 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
360 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
362 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
364 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
366 else if( keyValue.first == IMAGE_WRAP_MODE_U )
368 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
370 else if( keyValue.first == IMAGE_WRAP_MODE_V )
372 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
374 else if( keyValue.first == SYNCHRONOUS_LOADING )
376 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
378 else if( keyValue.first == IMAGE_ATLASING )
380 DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
382 else if( keyValue.first == ALPHA_MASK_URL )
384 DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
386 else if( keyValue.first == MASK_CONTENT_SCALE_NAME )
388 DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
390 else if( keyValue.first == CROP_TO_MASK_NAME )
392 DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second );
394 else if ( keyValue.first == LOAD_POLICY_NAME )
396 DoSetProperty( Toolkit::DevelImageVisual::Property::LOAD_POLICY, keyValue.second );
398 else if( keyValue.first == RELEASE_POLICY_NAME )
400 DoSetProperty( Toolkit::DevelImageVisual::Property::RELEASE_POLICY, keyValue.second );
405 // Load image immediately if LOAD_POLICY requires it
406 if ( mLoadPolicy == DevelImageVisual::LoadPolicy::IMMEDIATE )
408 auto attemptAtlasing = mAttemptAtlasing;
409 LoadTexture( attemptAtlasing, mAtlasRect, mTextures );
413 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
417 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
420 if( value.Get( sync ) )
424 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
428 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
433 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
438 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
441 if( value.Get( desiredWidth ) )
443 mDesiredSize.SetWidth( desiredWidth );
447 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
452 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
455 if( value.Get( desiredHeight ) )
457 mDesiredSize.SetHeight( desiredHeight );
461 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
466 case Toolkit::ImageVisual::Property::FITTING_MODE:
469 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
470 mFittingMode = Dali::FittingMode::Type( fittingMode );
474 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
477 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
478 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
482 case Toolkit::ImageVisual::Property::PIXEL_AREA:
484 value.Get( mPixelArea );
488 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
491 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
492 mWrapModeU = Dali::WrapMode::Type( wrapMode );
496 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
499 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
500 mWrapModeV = Dali::WrapMode::Type( wrapMode );
504 case Toolkit::ImageVisual::Property::ATLASING:
506 bool atlasing = false;
507 mAttemptAtlasing = value.Get( atlasing );
511 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
513 std::string alphaUrl;
514 if( value.Get( alphaUrl ) )
517 // Immediately trigger the alpha mask loading (it may just get a cached value)
518 mMaskingData->mAlphaMaskUrl = alphaUrl;
519 TextureManager& textureManager = mFactoryCache.GetTextureManager();
520 mMaskingData->mAlphaMaskId = textureManager.RequestMaskLoad( alphaUrl );
525 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
528 if( value.Get( scale ) )
531 mMaskingData->mContentScaleFactor = scale;
536 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
539 if( value.Get( crop ) )
542 mMaskingData->mCropToMask = crop;
547 case Toolkit::DevelImageVisual::Property::RELEASE_POLICY:
550 Scripting::GetEnumerationProperty( value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy );
551 mReleasePolicy = DevelImageVisual::ReleasePolicy::Type( releasePolicy );
555 case Toolkit::DevelImageVisual::Property::LOAD_POLICY:
558 Scripting::GetEnumerationProperty( value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy );
559 mLoadPolicy = DevelImageVisual::LoadPolicy::Type( loadPolicy );
564 void ImageVisual::AllocateMaskData()
568 mMaskingData.reset(new TextureManager::MaskingData());
572 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
576 naturalSize.x = mImage.GetWidth();
577 naturalSize.y = mImage.GetHeight();
580 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
582 naturalSize.x = mDesiredSize.GetWidth();
583 naturalSize.y = mDesiredSize.GetHeight();
586 else if( mImpl->mRenderer ) // Check if we have a loaded image
588 auto textureSet = mImpl->mRenderer.GetTextures();
592 auto texture = textureSet.GetTexture(0);
593 naturalSize.x = texture.GetWidth();
594 naturalSize.y = texture.GetHeight();
599 if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
600 mMaskingData->mCropToMask )
602 ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() );
603 if( dimensions != ImageDimensions( 0, 0 ) )
605 naturalSize.x = dimensions.GetWidth();
606 naturalSize.y = dimensions.GetHeight();
610 else if( mImageUrl.IsValid() )
612 if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
614 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
616 if( dimensions != ImageDimensions( 0, 0 ) )
618 naturalSize.x = dimensions.GetWidth();
619 naturalSize.y = dimensions.GetHeight();
623 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
625 naturalSize.x = brokenImage.GetWidth();
626 naturalSize.y = brokenImage.GetWidth();
632 naturalSize = Vector2::ZERO;
635 void ImageVisual::CreateRenderer( TextureSet& textureSet )
640 if( !mImpl->mCustomShader )
642 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
644 shader = GetImageShader( mFactoryCache,
645 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
646 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
650 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
651 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
653 shader = GetImageShader( mFactoryCache, false, true );
657 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
658 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
659 mImpl->mCustomShader->mHints );
660 if( mImpl->mCustomShader->mVertexShader.empty() )
662 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
667 // Set pixel align off as default.
668 // ToDo: Pixel align causes issues such as rattling image animation.
669 // We should trun it off until issues are resolved
670 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
672 mImpl->mRenderer = Renderer::New( geometry, shader );
675 mImpl->mRenderer.SetTextures( textureSet );
677 // else still waiting for texture load to finish.
679 //Register transform properties
680 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
683 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
688 std::string fragmentShader;
689 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
690 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
694 fragmentShader = fragmentPreFix;
695 fragmentShader += "\n";
698 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
700 fragmentShader += mImpl->mCustomShader->mFragmentShader;
704 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
707 if( customSamplerTypename )
709 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
712 if( !mImpl->mCustomShader )
714 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
716 shader = Shader::New( VERTEX_SHADER, fragmentShader );
717 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
721 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
722 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
724 mImpl->mCustomShader->mHints );
725 if( mImpl->mCustomShader->mVertexShader.empty() )
727 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
731 mImpl->mRenderer = Renderer::New( geometry, shader );
733 //Register transform properties
734 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
738 bool ImageVisual::IsSynchronousResourceLoading() const
740 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
743 void ImageVisual::LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures )
745 TextureManager& textureManager = mFactoryCache.GetTextureManager();
747 ImageAtlasManagerPtr atlasManager = nullptr;
748 AtlasUploadObserver* atlasUploadObserver = nullptr;
749 auto textureObserver = this;
753 atlasManager = mFactoryCache.GetAtlasManager();
754 atlasUploadObserver = this;
757 textures = textureManager.LoadTexture( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
758 mMaskingData, IsSynchronousResourceLoading(), mTextureId,
759 atlasRect, atlasing, mLoading, mWrapModeU,
760 mWrapModeV, textureObserver, atlasUploadObserver, atlasManager );
763 void ImageVisual::InitializeRenderer()
765 auto attemptAtlasing = ( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL && mAttemptAtlasing );
767 // texture set has to be created first as we need to know if atlasing succeeded or not
768 // when selecting the shader
770 if( mTextureId == TextureManager::INVALID_TEXTURE_ID && ! mTextures ) // Only load the texture once
772 LoadTexture( attemptAtlasing, mAtlasRect, mTextures );
775 if( attemptAtlasing ) // Flag needs to be set before creating renderer
777 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
781 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
784 CreateRenderer( mTextures );
785 mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
787 if( attemptAtlasing ) // the texture is packed inside atlas
789 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
791 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
793 if( !defaultWrapMode ) // custom wrap mode
795 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
796 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
797 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
802 void ImageVisual::InitializeRenderer( const Image& image )
804 TextureSet textures = TextureSet::New();
806 NativeImage nativeImage = NativeImage::DownCast( image );
809 CreateNativeImageRenderer( nativeImage );
810 DALI_ASSERT_DEBUG( textures );
811 mImpl->mRenderer.SetTextures( textures );
815 // reuse existing code for regular images
816 CreateRenderer( textures ); // Textures will be retreived from Image
818 ApplyImageToSampler( image );
821 void ImageVisual::DoSetOnStage( Actor& actor )
823 if( mImageUrl.IsValid() )
825 InitializeRenderer();
829 InitializeRenderer( mImage );
832 if( !mImpl->mRenderer )
837 mPlacementActor = actor;
838 // Search the Actor tree to find if Layer UI behaviour set.
839 Layer layer = actor.GetLayer();
840 if( layer && layer.GetBehavior() == Layer::LAYER_3D )
842 // Layer 3D set, do not align pixels
843 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
846 if( mPixelArea != FULL_TEXTURE_RECT )
848 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
851 if( mLoading == false )
853 actor.AddRenderer( mImpl->mRenderer );
854 mPlacementActor.Reset();
856 // Image loaded and ready to display
861 void ImageVisual::DoSetOffStage( Actor& actor )
863 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
865 // Image release is dependent on the ReleasePolicy, renderer is destroyed.
866 actor.RemoveRenderer( mImpl->mRenderer);
867 if( mReleasePolicy == DevelImageVisual::ReleasePolicy::DETACHED )
869 RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
872 if( mImageUrl.IsValid() )
874 // Legacy support for deprecated Dali::Image
878 mImpl->mRenderer.Reset();
879 mPlacementActor.Reset();
882 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
885 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
887 bool sync = IsSynchronousResourceLoading();
888 map.Insert( SYNCHRONOUS_LOADING, sync );
889 if( mImageUrl.IsValid() )
891 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
892 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
893 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
897 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
898 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
900 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
903 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
907 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
908 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
910 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
911 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
912 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
914 map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
915 if( mMaskingData != NULL )
917 map.Insert( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
918 map.Insert( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
919 map.Insert( Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
922 map.Insert( Toolkit::DevelImageVisual::Property::LOAD_POLICY, mLoadPolicy );
923 map.Insert( Toolkit::DevelImageVisual::Property::RELEASE_POLICY, mReleasePolicy );
927 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
930 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
931 if( mImageUrl.IsValid() )
933 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
934 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
938 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
939 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
943 void ImageVisual::OnSetTransform()
945 if( mImpl->mRenderer )
947 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
951 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
956 if( defaultTextureWrapping )
958 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
961 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
962 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
963 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
968 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
971 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
972 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
973 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
979 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
982 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
983 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
984 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
991 void ImageVisual::ApplyImageToSampler( const Image& image )
995 TextureSet textureSet = mImpl->mRenderer.GetTextures();
996 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
998 TextureSetImage( textureSet, 0u, image );
999 Sampler sampler = Sampler::New();
1000 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
1001 textureSet.SetSampler( 0u, sampler );
1005 // From existing atlas manager
1006 void ImageVisual::UploadCompleted()
1008 // Texture has been uploaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
1009 Actor actor = mPlacementActor.GetHandle();
1012 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
1013 actor.AddRenderer( mImpl->mRenderer );
1014 // reset the weak handle so that the renderer only get added to actor once
1015 mPlacementActor.Reset();
1020 // From Texture Manager
1021 void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
1023 Actor actor = mPlacementActor.GetHandle();
1026 if( mImpl->mRenderer )
1030 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
1033 actor.AddRenderer( mImpl->mRenderer );
1034 // reset the weak handle so that the renderer only get added to actor once
1035 mPlacementActor.Reset();
1036 if( loadingSuccess )
1038 Sampler sampler = Sampler::New();
1039 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
1040 textureSet.SetSampler( 0u, sampler );
1041 mImpl->mRenderer.SetTextures(textureSet);
1045 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
1047 textureSet = TextureSet::New();
1048 mImpl->mRenderer.SetTextures( textureSet );
1050 ApplyImageToSampler( brokenImage );
1052 // Image loaded and ready to display
1059 void ImageVisual::RemoveTexture()
1061 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
1063 mFactoryCache.GetTextureManager().Remove( mTextureId );
1064 mTextureId = TextureManager::INVALID_TEXTURE_ID;
1068 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
1069 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
1070 if( index != Property::INVALID_INDEX )
1072 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
1073 atlasRectValue.Get( atlasRect );
1076 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1077 mImpl->mRenderer.Reset();
1079 if( index != Property::INVALID_INDEX )
1081 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
1086 } // namespace Internal
1088 } // namespace Toolkit