// 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/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>
DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
+// load policies
+DALI_ENUM_TO_STRING_TABLE_BEGIN( LOAD_POLICY )
+DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::LoadPolicy, IMMEDIATE )
+DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::LoadPolicy, ATTACHED )
+DALI_ENUM_TO_STRING_TABLE_END( LOAD_POLICY )
+
+// 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";
mPixelArea( FULL_TEXTURE_RECT ),
mPlacementActor(),
mImageUrl( imageUrl ),
- mMaskingData( NULL ),
+ mMaskingData( ),
mDesiredSize( size ),
mTextureId( TextureManager::INVALID_TEXTURE_ID ),
mFittingMode( fittingMode ),
mSamplingMode( samplingMode ),
mWrapModeU( WrapMode::DEFAULT ),
mWrapModeV( WrapMode::DEFAULT ),
+ mLoadPolicy( DevelImageVisual::LoadPolicy::ATTACHED ),
+ mReleasePolicy( DevelImageVisual::ReleasePolicy::DETACHED ),
mAttemptAtlasing( false ),
- mTextureLoading( false )
+ mLoading( false )
{
}
mPixelArea( FULL_TEXTURE_RECT ),
mPlacementActor(),
mImageUrl(),
- mMaskingData( NULL ),
+ mMaskingData( ),
mDesiredSize(),
mTextureId( TextureManager::INVALID_TEXTURE_ID ),
mFittingMode( FittingMode::DEFAULT ),
mSamplingMode( SamplingMode::DEFAULT ),
mWrapModeU( WrapMode::DEFAULT ),
mWrapModeV( WrapMode::DEFAULT ),
+ mLoadPolicy( DevelImageVisual::LoadPolicy::ATTACHED ),
+ mReleasePolicy( DevelImageVisual::ReleasePolicy::DESTROYED ),
mAttemptAtlasing( false ),
- mTextureLoading( false )
+ mLoading( false )
{
}
ImageVisual::~ImageVisual()
{
- delete mMaskingData;
+ if( Stage::IsInstalled() )
+ {
+ 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();
+ }
+ }
}
void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
{
DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
}
- else if ( keyValue.first == IMAGE_ATLASING )
+ else if( keyValue.first == IMAGE_ATLASING )
+ {
+ DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
+ }
+ else if( keyValue.first == ALPHA_MASK_URL )
+ {
+ DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
+ }
+ else if( keyValue.first == MASK_CONTENT_SCALE_NAME )
{
- DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
+ DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
}
- else if ( keyValue.first == ALPHA_MASK_URL )
+ else if( keyValue.first == CROP_TO_MASK_NAME )
{
- DoSetProperty( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
+ DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second );
}
- else if ( keyValue.first == MASK_CONTENT_SCALE_NAME )
+ else if ( keyValue.first == LOAD_POLICY_NAME )
{
- DoSetProperty( Toolkit::DevelImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
+ DoSetProperty( Toolkit::DevelImageVisual::Property::LOAD_POLICY, keyValue.second );
}
- else if ( keyValue.first == CROP_TO_MASK_NAME )
+ else if( keyValue.first == RELEASE_POLICY_NAME )
{
- DoSetProperty( Toolkit::DevelImageVisual::Property::CROP_TO_MASK, keyValue.second );
+ DoSetProperty( Toolkit::DevelImageVisual::Property::RELEASE_POLICY, keyValue.second );
}
}
}
+ // Load image immediately if LOAD_POLICY requires it
+ if ( mLoadPolicy == DevelImageVisual::LoadPolicy::IMMEDIATE )
+ {
+ auto attemptAtlasing = mAttemptAtlasing;
+ LoadTexture( attemptAtlasing, mAtlasRect, mTextures );
+ }
}
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 ) )
{
AllocateMaskData();
// Immediately trigger the alpha mask loading (it may just get a cached value)
- mMaskingData->SetImage( alphaUrl );
+ mMaskingData->mAlphaMaskUrl = alphaUrl;
+ TextureManager& textureManager = mFactoryCache.GetTextureManager();
+ mMaskingData->mAlphaMaskId = textureManager.RequestMaskLoad( alphaUrl );
}
break;
}
- case Toolkit::DevelImageVisual::Property::MASK_CONTENT_SCALE:
+ case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
{
float scale;
if( value.Get( scale ) )
break;
}
- case Toolkit::DevelImageVisual::Property::CROP_TO_MASK:
+ case Toolkit::ImageVisual::Property::CROP_TO_MASK:
{
bool crop=false;
if( value.Get( 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;
+ }
+
+ case Toolkit::DevelImageVisual::Property::LOAD_POLICY:
+ {
+ int loadPolicy;
+ Scripting::GetEnumerationProperty( value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy );
+ mLoadPolicy = DevelImageVisual::LoadPolicy::Type( loadPolicy );
+ }
}
}
void ImageVisual::AllocateMaskData()
{
- if( mMaskingData == NULL )
+ if( !mMaskingData )
{
- TextureManager& textureManager = mFactoryCache.GetTextureManager();
- mMaskingData = new MaskingData(textureManager);
+ mMaskingData.reset(new TextureManager::MaskingData());
}
}
return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
}
-TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
+void ImageVisual::LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures )
{
- TextureSet textureSet;
+ TextureManager& textureManager = mFactoryCache.GetTextureManager();
- mTextureLoading = false;
- textureRect = FULL_TEXTURE_RECT;
+ ImageAtlasManagerPtr atlasManager = nullptr;
+ AtlasUploadObserver* atlasUploadObserver = nullptr;
+ auto textureObserver = this;
- if( synchronousLoading )
+ if( atlasing )
{
- PixelData data;
- if( mImageUrl.IsValid() )
- {
- // if sync loading is required, the loading should immediately when actor is on stage
- Devel::PixelBuffer pixelBuffer = LoadImageFromFile( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
-
- if( pixelBuffer )
- {
- data = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
- }
- }
- if( !data )
- {
- // use broken image
- textureSet = TextureSet::New();
- TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
- }
- else
- {
- if( attemptAtlasing )
- {
- textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, data );
- 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, data.GetPixelFormat(),
- data.GetWidth(), data.GetHeight() );
- texture.Upload( data );
- textureSet = TextureSet::New();
- textureSet.SetTexture( 0u, texture );
- }
- }
+ atlasManager = mFactoryCache.GetAtlasManager();
+ atlasUploadObserver = this;
}
- else
- {
- mTextureLoading = true;
- if( attemptAtlasing )
- {
- textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
- mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
- }
- if( !textureSet ) // big image, no atlasing or atlasing failed
- {
- mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
- TextureManager& textureManager = mFactoryCache.GetTextureManager();
- if( mMaskingData == NULL )
- {
- mTextureId = textureManager.RequestLoad( mImageUrl, mDesiredSize, mFittingMode,
- mSamplingMode, TextureManager::NO_ATLAS, this );
- }
- else
- {
- mTextureId = textureManager.RequestLoad( mImageUrl,
- mMaskingData->mAlphaMaskId,
- mMaskingData->mContentScaleFactor,
- mDesiredSize,
- mFittingMode, mSamplingMode,
- TextureManager::NO_ATLAS,
- mMaskingData->mCropToMask,
- this );
- }
- TextureManager::LoadState loadState = textureManager.GetTextureState( mTextureId );
- mTextureLoading = ( loadState == TextureManager::LOADING );
+ textures = textureManager.LoadTexture( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
+ mMaskingData, IsSynchronousResourceLoading(), mTextureId,
+ atlasRect, atlasing, mLoading, mWrapModeU,
+ mWrapModeV, textureObserver, atlasUploadObserver, atlasManager );
+}
- if( loadState == TextureManager::UPLOADED )
- {
- // UploadComplete has already been called - keep the same texture set
- textureSet = textureManager.GetTextureSet(mTextureId);
- }
- }
- }
+void ImageVisual::InitializeRenderer()
+{
+ auto attemptAtlasing = ( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL && mAttemptAtlasing );
+
+ // texture set has to be created first as we need to know if atlasing succeeded or not
+ // when selecting the shader
- if( ! (mImpl->mFlags & Impl::IS_ATLASING_APPLIED) && textureSet )
+ if( mTextureId == TextureManager::INVALID_TEXTURE_ID && ! mTextures ) // Only load the texture once
{
- Sampler sampler = Sampler::New();
- sampler.SetWrapMode( mWrapModeU, mWrapModeV );
- textureSet.SetSampler( 0u, sampler );
+ LoadTexture( attemptAtlasing, mAtlasRect, mTextures );
}
- return textureSet;
-}
+ if( attemptAtlasing ) // Flag needs to be set before creating renderer
+ {
+ mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
+ }
+ else
+ {
+ mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
+ }
-void ImageVisual::InitializeRenderer()
-{
- mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
+ CreateRenderer( mTextures );
+ mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
- if( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
+ if( attemptAtlasing ) // the texture is packed inside atlas
{
- bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
+ mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
- Vector4 atlasRect;
- // 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 );
- CreateRenderer( textures );
+ bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
- if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
+ if( !defaultWrapMode ) // custom wrap mode
{
- mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
- if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
- {
- Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
- wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
- mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
- }
+ Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
+ wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
+ mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
}
}
- else
- {
- // for custom shader or remote image, atlas is not applied
- Vector4 atlasRect; // ignored in this case
- TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
- CreateRenderer( textures );
- }
}
void ImageVisual::InitializeRenderer( const Image& image )
{
- // don't reuse CreateTextureSet
TextureSet textures = TextureSet::New();
NativeImage nativeImage = NativeImage::DownCast( image );
else
{
// reuse existing code for regular images
- CreateRenderer( textures );
+ CreateRenderer( textures ); // Textures will be retreived from Image
}
ApplyImageToSampler( 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::ImageVisual::Property::ATLASING, mAttemptAtlasing );
if( mMaskingData != NULL )
{
- map.Insert( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
- map.Insert( Toolkit::DevelImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
- map.Insert( Toolkit::DevelImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
+ 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::LOAD_POLICY, mLoadPolicy );
+ 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() );
Actor actor = mPlacementActor.GetHandle();
if( actor )
{
+ mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
actor.AddRenderer( mImpl->mRenderer );
-
// reset the weak handle so that the renderer only get added to actor once
mPlacementActor.Reset();
}
- mTextureLoading = false;
+ mLoading = false;
}
// From Texture Manager
{
if( mImpl->mRenderer )
{
+ if( usingAtlas )
+ {
+ mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
+ }
+
actor.AddRenderer( mImpl->mRenderer );
// reset the weak handle so that the renderer only get added to actor once
mPlacementActor.Reset();
-
if( loadingSuccess )
{
Sampler sampler = Sampler::New();
ResourceReady();
}
}
- mTextureLoading = false;
+ mLoading = false;
}
-void ImageVisual::RemoveTexture(const std::string& url)
+void ImageVisual::RemoveTexture()
{
if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
{
}
}
-
-ImageVisual::MaskingData::MaskingData( TextureManager& textureManager )
-: mTextureManager( textureManager ),
- mAlphaMaskUrl(),
- mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
- mContentScaleFactor( 1.0f ),
- mCropToMask( true )
-{
-}
-
-ImageVisual::MaskingData::~MaskingData()
-{
- if( Stage::IsInstalled() )
- {
- // 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( mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
- {
- mTextureManager.Remove( mAlphaMaskId );
- }
- }
-}
-
-void ImageVisual::MaskingData::SetImage( const std::string& maskUrl )
-{
- mAlphaMaskUrl = maskUrl;
- mAlphaMaskId = mTextureManager.RequestMaskLoad( mAlphaMaskUrl );
-}
-
} // namespace Internal
} // namespace Toolkit
projects / platform / core / uifw / dali-toolkit.git / blobdiff