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/devel-api/visuals/image-visual-properties-devel.h>
36 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
37 #include <dali-toolkit/internal/visuals/texture-manager-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 )
95 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
97 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
99 const float PIXEL_ALIGN_ON = 1.0f;
100 const float PIXEL_ALIGN_OFF = 0.0f;
102 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
103 attribute mediump vec2 aPosition;\n
104 uniform mediump mat4 uModelMatrix;\n
105 uniform mediump mat4 uViewMatrix;\n
106 uniform mediump mat4 uProjection;\n
107 uniform mediump vec3 uSize;\n
108 uniform mediump vec4 pixelArea;
109 varying mediump vec2 vTexCoord;\n
110 uniform lowp float uPixelAligned;\n
112 //Visual size and offset
113 uniform mediump vec2 offset;\n
114 uniform mediump vec2 size;\n
115 uniform mediump vec4 offsetSizeMode;\n
116 uniform mediump vec2 origin;\n
117 uniform mediump vec2 anchorPoint;\n
119 vec4 ComputeVertexPosition()\n
121 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
122 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
123 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
128 mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
129 vec4 alignedVertexPosition = vertexPosition;\n
130 alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
131 vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
132 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
133 gl_Position = vertexPosition;\n
137 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
138 varying mediump vec2 vTexCoord;\n
139 uniform sampler2D sTexture;\n
140 uniform lowp vec4 uColor;\n
141 uniform lowp vec3 mixColor;\n
142 uniform lowp float opacity;\n
143 uniform lowp float preMultipliedAlpha;\n
145 lowp vec4 visualMixColor()\n
147 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
151 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
155 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
156 varying mediump vec2 vTexCoord;\n
157 uniform sampler2D sTexture;\n
158 uniform mediump vec4 uAtlasRect;\n
159 uniform lowp vec4 uColor;\n
160 uniform lowp vec3 mixColor;\n
161 uniform lowp float opacity;\n
162 uniform lowp float preMultipliedAlpha;\n
164 lowp vec4 visualMixColor()\n
166 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
171 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
172 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
176 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
177 varying mediump vec2 vTexCoord;\n
178 uniform sampler2D sTexture;\n
179 uniform mediump vec4 uAtlasRect;\n
180 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
181 uniform lowp vec2 wrapMode;\n
182 uniform lowp vec4 uColor;\n
183 uniform lowp vec3 mixColor;\n
184 uniform lowp float opacity;\n
185 uniform lowp float preMultipliedAlpha;\n
187 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
189 mediump float coord;\n
190 if( wrap > 1.5 )\n // REFLECT
191 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
192 else \n// warp == 0 or 1
193 coord = mix(coordinate, fract( coordinate ), wrap);\n
194 return clamp( mix(range.x, range.y, coord), range.x, range.y );
197 lowp vec4 visualMixColor()\n
199 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
204 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
205 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
206 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
210 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
214 if( gridSize == ImageDimensions( 1, 1 ) )
216 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
220 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
226 } // unnamed namespace
228 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
229 const VisualUrl& imageUrl,
230 const Property::Map& properties,
231 ImageDimensions size,
232 FittingMode::Type fittingMode,
233 Dali::SamplingMode::Type samplingMode )
235 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
236 imageVisualPtr->SetProperties( properties );
237 return imageVisualPtr;
240 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
241 const VisualUrl& imageUrl,
242 ImageDimensions size,
243 FittingMode::Type fittingMode,
244 Dali::SamplingMode::Type samplingMode )
246 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
249 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
251 return new ImageVisual( factoryCache, image );
254 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
255 const VisualUrl& imageUrl,
256 ImageDimensions size,
257 FittingMode::Type fittingMode,
258 Dali::SamplingMode::Type samplingMode )
259 : Visual::Base( factoryCache ),
261 mPixelArea( FULL_TEXTURE_RECT ),
263 mImageUrl( imageUrl ),
265 mDesiredSize( size ),
266 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
267 mFittingMode( fittingMode ),
268 mSamplingMode( samplingMode ),
269 mWrapModeU( WrapMode::DEFAULT ),
270 mWrapModeV( WrapMode::DEFAULT ),
271 mAttemptAtlasing( false ),
272 mLoadingStatus( false )
276 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
277 : Visual::Base( factoryCache ),
279 mPixelArea( FULL_TEXTURE_RECT ),
284 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
285 mFittingMode( FittingMode::DEFAULT ),
286 mSamplingMode( SamplingMode::DEFAULT ),
287 mWrapModeU( WrapMode::DEFAULT ),
288 mWrapModeV( WrapMode::DEFAULT ),
289 mAttemptAtlasing( false ),
290 mLoadingStatus( false )
294 ImageVisual::~ImageVisual()
296 if( mMaskingData && Stage::IsInstalled() )
298 // TextureManager could have been deleted before the actor that contains this
299 // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
300 // is still valid before accessing texture manager.
301 if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
303 TextureManager& textureManager = mFactoryCache.GetTextureManager();
304 textureManager.Remove( mMaskingData->mAlphaMaskId );
309 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
311 // Url is already received in constructor
312 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
314 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
315 if( keyValue.first.type == Property::Key::INDEX )
317 DoSetProperty( keyValue.first.indexKey, keyValue.second );
321 if( keyValue.first == IMAGE_FITTING_MODE )
323 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
325 else if( keyValue.first == IMAGE_SAMPLING_MODE )
327 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
329 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
331 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
333 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
335 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
337 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
339 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
341 else if( keyValue.first == IMAGE_WRAP_MODE_U )
343 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
345 else if( keyValue.first == IMAGE_WRAP_MODE_V )
347 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
349 else if( keyValue.first == SYNCHRONOUS_LOADING )
351 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
353 else if ( keyValue.first == IMAGE_ATLASING )
355 DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
357 else if ( keyValue.first == ALPHA_MASK_URL )
359 DoSetProperty( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
361 else if ( keyValue.first == MASK_CONTENT_SCALE_NAME )
363 DoSetProperty( Toolkit::DevelImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
365 else if ( keyValue.first == CROP_TO_MASK_NAME )
367 DoSetProperty( Toolkit::DevelImageVisual::Property::CROP_TO_MASK, keyValue.second );
373 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
377 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
380 if( value.Get( sync ) )
384 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
388 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
393 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
398 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
401 if( value.Get( desiredWidth ) )
403 mDesiredSize.SetWidth( desiredWidth );
407 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
412 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
415 if( value.Get( desiredHeight ) )
417 mDesiredSize.SetHeight( desiredHeight );
421 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
426 case Toolkit::ImageVisual::Property::FITTING_MODE:
429 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
430 mFittingMode = Dali::FittingMode::Type( fittingMode );
434 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
437 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
438 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
442 case Toolkit::ImageVisual::Property::PIXEL_AREA:
444 value.Get( mPixelArea );
448 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
451 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
452 mWrapModeU = Dali::WrapMode::Type( wrapMode );
456 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
459 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
460 mWrapModeV = Dali::WrapMode::Type( wrapMode );
464 case Toolkit::DevelImageVisual::Property::ATLASING:
466 bool atlasing = false;
467 mAttemptAtlasing = value.Get( atlasing );
471 case Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL:
473 std::string alphaUrl;
474 if( value.Get( alphaUrl ) )
477 // Immediately trigger the alpha mask loading (it may just get a cached value)
478 mMaskingData->mAlphaMaskUrl = alphaUrl;
479 TextureManager& textureManager = mFactoryCache.GetTextureManager();
480 mMaskingData->mAlphaMaskId = textureManager.RequestMaskLoad( alphaUrl );
485 case Toolkit::DevelImageVisual::Property::MASK_CONTENT_SCALE:
488 if( value.Get( scale ) )
491 mMaskingData->mContentScaleFactor = scale;
496 case Toolkit::DevelImageVisual::Property::CROP_TO_MASK:
499 if( value.Get( crop ) )
502 mMaskingData->mCropToMask = crop;
509 void ImageVisual::AllocateMaskData()
513 mMaskingData.reset(new TextureManager::MaskingData());
517 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
521 naturalSize.x = mImage.GetWidth();
522 naturalSize.y = mImage.GetHeight();
525 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
527 naturalSize.x = mDesiredSize.GetWidth();
528 naturalSize.y = mDesiredSize.GetHeight();
531 else if( mImpl->mRenderer ) // Check if we have a loaded image
533 auto textureSet = mImpl->mRenderer.GetTextures();
537 auto texture = textureSet.GetTexture(0);
538 naturalSize.x = texture.GetWidth();
539 naturalSize.y = texture.GetHeight();
544 if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
545 mMaskingData->mCropToMask )
547 ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() );
548 if( dimensions != ImageDimensions( 0, 0 ) )
550 naturalSize.x = dimensions.GetWidth();
551 naturalSize.y = dimensions.GetHeight();
555 else if( mImageUrl.IsValid() )
557 if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
559 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
561 if( dimensions != ImageDimensions( 0, 0 ) )
563 naturalSize.x = dimensions.GetWidth();
564 naturalSize.y = dimensions.GetHeight();
568 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
570 naturalSize.x = brokenImage.GetWidth();
571 naturalSize.y = brokenImage.GetWidth();
577 naturalSize = Vector2::ZERO;
580 void ImageVisual::CreateRenderer( TextureSet& textureSet )
585 if( !mImpl->mCustomShader )
587 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
589 shader = GetImageShader( mFactoryCache,
590 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
591 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
595 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
596 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
598 shader = GetImageShader( mFactoryCache, false, true );
602 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
603 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
604 mImpl->mCustomShader->mHints );
605 if( mImpl->mCustomShader->mVertexShader.empty() )
607 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
612 // Set pixel align off as default.
613 // ToDo: Pixel align causes issues such as rattling image animation.
614 // We should trun it off until issues are resolved
615 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
617 mImpl->mRenderer = Renderer::New( geometry, shader );
620 mImpl->mRenderer.SetTextures( textureSet );
622 // else still waiting for texture load to finish.
624 //Register transform properties
625 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
628 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
633 std::string fragmentShader;
634 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
635 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
639 fragmentShader = fragmentPreFix;
640 fragmentShader += "\n";
643 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
645 fragmentShader += mImpl->mCustomShader->mFragmentShader;
649 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
652 if( customSamplerTypename )
654 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
657 if( !mImpl->mCustomShader )
659 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
661 shader = Shader::New( VERTEX_SHADER, fragmentShader );
662 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
666 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
667 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
669 mImpl->mCustomShader->mHints );
670 if( mImpl->mCustomShader->mVertexShader.empty() )
672 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
676 mImpl->mRenderer = Renderer::New( geometry, shader );
678 //Register transform properties
679 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
683 bool ImageVisual::IsSynchronousResourceLoading() const
685 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
689 ( VisualUrl& url, Dali::ImageDimensions desiredSize, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode,
690 ImageVisual::MaskingData* maskInfo, bool synchronousLoading,
691 TextureManager::TextureId textureId, Vector4& textureRect, bool& atlasingStatus, bool& loadingStatus
693 void ImageVisual::InitializeRenderer()
695 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
697 TextureManager& textureManager = mFactoryCache.GetTextureManager();
699 if( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
701 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
705 auto attemptAtlasing = mAttemptAtlasing;
707 // texture set has to be created first as we need to know if atlasing succeeded or not
708 // when selecting the shader
709 TextureSet textures =
710 textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
711 mMaskingData, IsSynchronousResourceLoading(), mTextureId,
712 atlasRect, attemptAtlasing, mLoadingStatus, mWrapModeU,
713 mWrapModeV, this, this, mFactoryCache.GetAtlasManager());
716 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
718 CreateRenderer( textures );
720 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
722 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
723 if( !defaultWrapMode ) // custom wrap mode
725 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
726 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
727 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
733 auto attemptAtlasing = false;
734 // for custom shader or remote image, atlas is not applied
735 Vector4 atlasRect; // ignored in this case
736 TextureSet textures =
737 textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
738 mMaskingData, IsSynchronousResourceLoading(), mTextureId,
739 atlasRect, attemptAtlasing, mLoadingStatus, mWrapModeU, mWrapModeV, this,
740 nullptr, nullptr); // no atlasing
741 DALI_ASSERT_DEBUG(attemptAtlasing == false);
742 CreateRenderer( textures );
746 void ImageVisual::InitializeRenderer( const Image& image )
748 TextureSet textures = TextureSet::New();
750 NativeImage nativeImage = NativeImage::DownCast( image );
753 CreateNativeImageRenderer( nativeImage );
754 DALI_ASSERT_DEBUG( textures );
755 mImpl->mRenderer.SetTextures( textures );
759 // reuse existing code for regular images
760 CreateRenderer( textures );
762 ApplyImageToSampler( image );
765 void ImageVisual::DoSetOnStage( Actor& actor )
767 if( mImageUrl.IsValid() )
769 InitializeRenderer();
773 InitializeRenderer( mImage );
776 if ( !mImpl->mRenderer )
781 mPlacementActor = actor;
782 // Search the Actor tree to find if Layer UI behaviour set.
783 Layer layer = actor.GetLayer();
784 if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
786 // Layer 3D set, do not align pixels
787 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
790 if( mPixelArea != FULL_TEXTURE_RECT )
792 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
795 if( mLoadingStatus == false )
797 actor.AddRenderer( mImpl->mRenderer );
798 mPlacementActor.Reset();
800 // Image loaded and ready to display
805 void ImageVisual::DoSetOffStage( Actor& actor )
807 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
809 //If we own the image then make sure we release it when we go off stage
810 actor.RemoveRenderer( mImpl->mRenderer);
811 if( mImageUrl.IsValid() )
813 RemoveTexture( mImageUrl.GetUrl() );
816 mLoadingStatus = false;
817 mImpl->mRenderer.Reset();
818 mPlacementActor.Reset();
821 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
824 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
826 bool sync = IsSynchronousResourceLoading();
827 map.Insert( SYNCHRONOUS_LOADING, sync );
828 if( mImageUrl.IsValid() )
830 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
831 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
832 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
836 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
837 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
839 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
842 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
846 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
847 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
849 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
850 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
851 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
853 map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing );
854 if( mMaskingData != NULL )
856 map.Insert( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
857 map.Insert( Toolkit::DevelImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
858 map.Insert( Toolkit::DevelImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
862 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
865 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
866 if( mImageUrl.IsValid() )
868 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
869 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
873 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
874 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
878 void ImageVisual::OnSetTransform()
880 if( mImpl->mRenderer )
882 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
886 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
891 if( defaultTextureWrapping )
893 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
896 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
897 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
898 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
903 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
906 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
907 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
908 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
914 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
917 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
918 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
919 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
926 void ImageVisual::ApplyImageToSampler( const Image& image )
930 TextureSet textureSet = mImpl->mRenderer.GetTextures();
931 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
933 TextureSetImage( textureSet, 0u, image );
934 Sampler sampler = Sampler::New();
935 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
936 textureSet.SetSampler( 0u, sampler );
940 // From existing atlas manager
941 void ImageVisual::UploadCompleted()
943 // Texture has been uploaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
944 Actor actor = mPlacementActor.GetHandle();
947 actor.AddRenderer( mImpl->mRenderer );
949 // reset the weak handle so that the renderer only get added to actor once
950 mPlacementActor.Reset();
952 mLoadingStatus = false;
955 // From Texture Manager
956 void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
958 Actor actor = mPlacementActor.GetHandle();
961 if( mImpl->mRenderer )
963 actor.AddRenderer( mImpl->mRenderer );
964 // reset the weak handle so that the renderer only get added to actor once
965 mPlacementActor.Reset();
969 Sampler sampler = Sampler::New();
970 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
971 textureSet.SetSampler( 0u, sampler );
972 mImpl->mRenderer.SetTextures(textureSet);
976 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
978 textureSet = TextureSet::New();
979 mImpl->mRenderer.SetTextures( textureSet );
981 ApplyImageToSampler( brokenImage );
983 // Image loaded and ready to display
987 mLoadingStatus = false;
990 void ImageVisual::RemoveTexture(const std::string& url)
992 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
994 mFactoryCache.GetTextureManager().Remove( mTextureId );
995 mTextureId = TextureManager::INVALID_TEXTURE_ID;
999 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
1000 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
1001 if( index != Property::INVALID_INDEX )
1003 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
1004 atlasRectValue.Get( atlasRect );
1007 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1008 mImpl->mRenderer.Reset();
1010 if( index != Property::INVALID_INDEX )
1012 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
1017 } // namespace Internal
1019 } // namespace Toolkit