/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// EXTERNAL HEADERS
#include <cstring> // for strlen()
#include <dali/public-api/actors/layer.h>
+#include <dali/public-api/common/stage.h>
#include <dali/public-api/images/resource-image.h>
#include <dali/public-api/images/native-image.h>
#include <dali/devel-api/images/texture-set-image.h>
-#include <dali/devel-api/adaptor-framework/bitmap-loader.h>
#include <dali/devel-api/adaptor-framework/image-loading.h>
#include <dali/devel-api/scripting/enum-helper.h>
#include <dali/devel-api/scripting/scripting.h>
// INTERNAL HEADERS
#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
-#include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
-#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
-#include <dali-toolkit/internal/visuals/texture-manager.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
+#include <dali-toolkit/internal/visuals/texture-manager-impl.h>
#include <dali-toolkit/internal/visuals/visual-string-constants.h>
#include <dali-toolkit/internal/visuals/visual-factory-impl.h>
#include <dali-toolkit/internal/visuals/visual-factory-cache.h>
DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
+// release policies
+DALI_ENUM_TO_STRING_TABLE_BEGIN( RELEASE_POLICY )
+DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, DETACHED )
+DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, DESTROYED )
+DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, NEVER )
+DALI_ENUM_TO_STRING_TABLE_END( RELEASE_POLICY )
+
const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
Dali::SamplingMode::Type samplingMode )
: Visual::Base( factoryCache ),
mImage(),
- mPixels(),
mPixelArea( FULL_TEXTURE_RECT ),
mPlacementActor(),
mImageUrl( imageUrl ),
- mAlphaMaskUrl(),
+ mMaskingData( ),
mDesiredSize( size ),
mTextureId( TextureManager::INVALID_TEXTURE_ID ),
- mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
mFittingMode( fittingMode ),
mSamplingMode( samplingMode ),
mWrapModeU( WrapMode::DEFAULT ),
mWrapModeV( WrapMode::DEFAULT ),
+ mReleasePolicy( DevelImageVisual::ReleasePolicy::DETACHED ),
mAttemptAtlasing( false ),
- mTextureLoading( false )
+ mLoading( false )
{
}
ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
: Visual::Base( factoryCache ),
mImage( image ),
- mPixels(),
mPixelArea( FULL_TEXTURE_RECT ),
mPlacementActor(),
mImageUrl(),
- mAlphaMaskUrl(),
+ mMaskingData( ),
mDesiredSize(),
mTextureId( TextureManager::INVALID_TEXTURE_ID ),
- mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
mFittingMode( FittingMode::DEFAULT ),
mSamplingMode( SamplingMode::DEFAULT ),
mWrapModeU( WrapMode::DEFAULT ),
mWrapModeV( WrapMode::DEFAULT ),
+ mReleasePolicy( DevelImageVisual::ReleasePolicy::DESTROYED ),
mAttemptAtlasing( false ),
- mTextureLoading( false )
+ mLoading( false )
{
}
ImageVisual::~ImageVisual()
{
- if( mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
+ if( Stage::IsInstalled() )
{
- TextureManager& textureManager = mFactoryCache.GetTextureManager();
- textureManager.Remove( mAlphaMaskId );
+ if( mMaskingData )
+ {
+ // TextureManager could have been deleted before the actor that contains this
+ // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
+ // is still valid before accessing texture manager.
+ if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
+ {
+ TextureManager& textureManager = mFactoryCache.GetTextureManager();
+ textureManager.Remove( mMaskingData->mAlphaMaskId );
+ }
+ }
+
+ // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
+ if( ( mTextureId != TextureManager::INVALID_TEXTURE_ID ) && ( mReleasePolicy != DevelImageVisual::ReleasePolicy::NEVER ) )
+ {
+ RemoveTexture();
+ }
}
}
{
DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
}
- else if ( keyValue.first == IMAGE_ATLASING )
+ else if( keyValue.first == IMAGE_ATLASING )
{
- DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
+ DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
}
- else if ( keyValue.first == ALPHA_MASK_URL )
+ else if( keyValue.first == ALPHA_MASK_URL )
{
- DoSetProperty( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
+ DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
+ }
+ else if( keyValue.first == MASK_CONTENT_SCALE_NAME )
+ {
+ DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
+ }
+ else if( keyValue.first == CROP_TO_MASK_NAME )
+ {
+ DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second );
+ }
+ else if( keyValue.first == RELEASE_POLICY_NAME )
+ {
+ DoSetProperty( Toolkit::DevelImageVisual::Property::RELEASE_POLICY, keyValue.second );
}
}
}
-
- if( mAlphaMaskUrl.IsValid() )
- {
- // Immediately trigger the alpha mask loading (it may just get a cached value)
- TextureManager& textureManager = mFactoryCache.GetTextureManager();
- mAlphaMaskId = textureManager.RequestMaskLoad( mAlphaMaskUrl );
- }
-
- if( ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING ) && mImageUrl.IsValid() )
- {
- // if sync loading is required, the loading should start
- // immediately when new image url is set or the actor is off stage
- // ( for on-stage actor with image url unchanged, resource loading
- // is already finished )
- LoadResourceSynchronously();
- }
}
void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
break;
}
- case Toolkit::DevelImageVisual::Property::ATLASING:
+ case Toolkit::ImageVisual::Property::ATLASING:
{
bool atlasing = false;
mAttemptAtlasing = value.Get( atlasing );
+ break;
}
- case Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL:
+ case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
{
std::string alphaUrl;
if( value.Get( alphaUrl ) )
{
- mAlphaMaskUrl = VisualUrl( alphaUrl );
+ AllocateMaskData();
+ // Immediately trigger the alpha mask loading (it may just get a cached value)
+ mMaskingData->mAlphaMaskUrl = alphaUrl;
+ TextureManager& textureManager = mFactoryCache.GetTextureManager();
+ mMaskingData->mAlphaMaskId = textureManager.RequestMaskLoad( alphaUrl );
+ }
+ break;
+ }
+
+ case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
+ {
+ float scale;
+ if( value.Get( scale ) )
+ {
+ AllocateMaskData();
+ mMaskingData->mContentScaleFactor = scale;
+ }
+ break;
+ }
+
+ case Toolkit::ImageVisual::Property::CROP_TO_MASK:
+ {
+ bool crop=false;
+ if( value.Get( crop ) )
+ {
+ AllocateMaskData();
+ mMaskingData->mCropToMask = crop;
}
+ break;
+ }
+
+ case Toolkit::DevelImageVisual::Property::RELEASE_POLICY:
+ {
+ int releasePolicy;
+ Scripting::GetEnumerationProperty( value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy );
+ mReleasePolicy = DevelImageVisual::ReleasePolicy::Type( releasePolicy );
+ break;
}
}
}
+void ImageVisual::AllocateMaskData()
+{
+ if( !mMaskingData )
+ {
+ mMaskingData.reset(new TextureManager::MaskingData());
+ }
+}
+
void ImageVisual::GetNaturalSize( Vector2& naturalSize )
{
if(mImage)
naturalSize.y = mDesiredSize.GetHeight();
return;
}
- else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL )
+ else if( mImpl->mRenderer ) // Check if we have a loaded image
{
- ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
+ auto textureSet = mImpl->mRenderer.GetTextures();
+
+ if( textureSet )
+ {
+ auto texture = textureSet.GetTexture(0);
+ naturalSize.x = texture.GetWidth();
+ naturalSize.y = texture.GetHeight();
+ return;
+ }
+ }
+ if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
+ mMaskingData->mCropToMask )
+ {
+ ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() );
if( dimensions != ImageDimensions( 0, 0 ) )
{
naturalSize.x = dimensions.GetWidth();
naturalSize.y = dimensions.GetHeight();
}
- else
+ return;
+ }
+ else if( mImageUrl.IsValid() )
+ {
+ if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
{
- Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
+ ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
- naturalSize.x = brokenImage.GetWidth();
- naturalSize.y = brokenImage.GetWidth();
+ if( dimensions != ImageDimensions( 0, 0 ) )
+ {
+ naturalSize.x = dimensions.GetWidth();
+ naturalSize.y = dimensions.GetHeight();
+ }
+ else
+ {
+ Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
+
+ naturalSize.x = brokenImage.GetWidth();
+ naturalSize.y = brokenImage.GetWidth();
+ }
+ return;
}
- return;
}
naturalSize = Vector2::ZERO;
return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
}
-void ImageVisual::LoadResourceSynchronously()
-{
- if( mImageUrl.IsValid() )
- {
- BitmapLoader loader = BitmapLoader::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
- loader.Load();
- mPixels = loader.GetPixelData();
- mTextureLoading = false;
- }
-}
-
-TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
-{
- TextureSet textureSet;
-
- mTextureLoading = false;
-
- textureRect = FULL_TEXTURE_RECT;
- if( synchronousLoading )
- {
- if( !mPixels )
- {
- // use broken image
- textureSet = TextureSet::New();
- TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
- }
- else
- {
- if( attemptAtlasing )
- {
- textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
- mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
- }
- if( !textureSet ) // big image, no atlasing or atlasing failed
- {
- mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
- Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
- mPixels.GetWidth(), mPixels.GetHeight() );
- texture.Upload( mPixels );
- textureSet = TextureSet::New();
- textureSet.SetTexture( 0u, texture );
- }
- }
- }
- else
- {
- if( attemptAtlasing )
- {
- textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
- mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
- mTextureLoading = true;
- }
- if( !textureSet ) // big image, no atlasing or atlasing failed
- {
- mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
- TextureManager& textureManager = mFactoryCache.GetTextureManager();
- if( mAlphaMaskId == TextureManager::INVALID_TEXTURE_ID )
- {
- mTextureId = textureManager.RequestLoad( mImageUrl, mDesiredSize, mFittingMode,
- mSamplingMode, TextureManager::NO_ATLAS, this );
- }
- else
- {
- mTextureId = textureManager.RequestLoad( mImageUrl, mAlphaMaskId, mDesiredSize,
- mFittingMode, mSamplingMode,
- TextureManager::NO_ATLAS, this );
- }
-
- TextureManager::LoadState loadState = textureManager.GetTextureState( mTextureId );
-
- mTextureLoading = ( loadState == TextureManager::LOADING );
-
- if( loadState == TextureManager::UPLOADED )
- {
- // UploadComplete has already been called - keep the same texture set
- textureSet = textureManager.GetTextureSet(mTextureId);
- }
- }
- }
-
- if( ! (mImpl->mFlags & Impl::IS_ATLASING_APPLIED) && textureSet )
- {
- Sampler sampler = Sampler::New();
- sampler.SetWrapMode( mWrapModeU, mWrapModeV );
- textureSet.SetSampler( 0u, sampler );
- }
-
- return textureSet;
-}
-
+/*
+( VisualUrl& url, Dali::ImageDimensions desiredSize, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode,
+ ImageVisual::MaskingData* maskInfo, bool synchronousLoading,
+ TextureManager::TextureId textureId, Vector4& textureRect, bool& atlasingStatus, bool& loadingStatus
+ */
void ImageVisual::InitializeRenderer()
{
mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
- if( ! mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL )
+ TextureManager& textureManager = mFactoryCache.GetTextureManager();
+
+ if( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
{
bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
Vector4 atlasRect;
+
+ auto attemptAtlasing = mAttemptAtlasing;
+
// texture set has to be created first as we need to know if atlasing succeeded or not
// when selecting the shader
- TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), mAttemptAtlasing );
+ TextureSet textures =
+ textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
+ mMaskingData, IsSynchronousResourceLoading(), mTextureId,
+ atlasRect, attemptAtlasing, mLoading, mWrapModeU,
+ mWrapModeV, this, this, mFactoryCache.GetAtlasManager());
+ if(attemptAtlasing)
+ {
+ mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
+ }
CreateRenderer( textures );
if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
{
mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
- if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
+ if( !defaultWrapMode ) // custom wrap mode
{
Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
}
else
{
+ auto attemptAtlasing = false;
// for custom shader or remote image, atlas is not applied
Vector4 atlasRect; // ignored in this case
- TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
+ TextureSet textures =
+ textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
+ mMaskingData, IsSynchronousResourceLoading(), mTextureId,
+ atlasRect, attemptAtlasing, mLoading, mWrapModeU, mWrapModeV, this,
+ nullptr, nullptr); // no atlasing
+ DALI_ASSERT_DEBUG(attemptAtlasing == false);
CreateRenderer( textures );
}
}
void ImageVisual::InitializeRenderer( const Image& image )
{
- // don't reuse CreateTextureSet
TextureSet textures = TextureSet::New();
NativeImage nativeImage = NativeImage::DownCast( image );
{
InitializeRenderer();
}
- else if ( mImage )
+ else if( mImage )
{
InitializeRenderer( mImage );
}
- if ( !mImpl->mRenderer )
+ if( !mImpl->mRenderer )
{
return;
}
mPlacementActor = actor;
// Search the Actor tree to find if Layer UI behaviour set.
Layer layer = actor.GetLayer();
- if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
+ if( layer && layer.GetBehavior() == Layer::LAYER_3D )
{
// Layer 3D set, do not align pixels
mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
}
- if( mTextureLoading == false )
+ if( mLoading == false )
{
actor.AddRenderer( mImpl->mRenderer );
mPlacementActor.Reset();
{
// Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
- //If we own the image then make sure we release it when we go off stage
+ // Image release is dependent on the ReleasePolicy, renderer is destroyed.
actor.RemoveRenderer( mImpl->mRenderer);
+ if( mReleasePolicy == DevelImageVisual::ReleasePolicy::DETACHED )
+ {
+ RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
+ }
+
if( mImageUrl.IsValid() )
{
- RemoveTexture( mImageUrl.GetUrl() );
+ // Legacy support for deprecated Dali::Image
mImage.Reset();
}
- mTextureLoading = false;
+ mLoading = false;
mImpl->mRenderer.Reset();
mPlacementActor.Reset();
}
void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
{
map.Clear();
- map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
+ map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
bool sync = IsSynchronousResourceLoading();
map.Insert( SYNCHRONOUS_LOADING, sync );
map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
- map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing );
- map.Insert( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, mAlphaMaskUrl.GetUrl() );
+ map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
+ if( mMaskingData != NULL )
+ {
+ map.Insert( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
+ map.Insert( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
+ map.Insert( Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
+ }
+
+ map.Insert( Toolkit::DevelImageVisual::Property::RELEASE_POLICY, mReleasePolicy );
+
}
void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
{
map.Clear();
- map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
+ map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
if( mImageUrl.IsValid() )
{
map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
// reset the weak handle so that the renderer only get added to actor once
mPlacementActor.Reset();
}
- mTextureLoading = false;
+ mLoading = false;
}
// From Texture Manager
-void ImageVisual::UploadComplete( bool loadingSuccess, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
+void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
{
Actor actor = mPlacementActor.GetHandle();
if( actor )
ResourceReady();
}
}
- mTextureLoading = false;
+ mLoading = false;
}
-void ImageVisual::RemoveTexture(const std::string& url)
+void ImageVisual::RemoveTexture()
{
if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
{
projects / platform / core / uifw / dali-toolkit.git / blobdiff