#define DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
*
*/
-// INTERNAL INCLUDES
-#include <dali-toolkit/internal/visuals/visual-impl.h>
-#include <dali-toolkit/internal/visuals/image-atlas-manager.h>
-
// EXTERNAL INCLUDES
-#include <dali/public-api/images/image.h>
+#include <memory>
+
+#include <dali/public-api/common/intrusive-ptr.h>
#include <dali/public-api/images/image-operations.h>
-#include <dali/public-api/images/resource-image.h>
+#include <dali/public-api/object/weak-handle.h>
+
+// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/image-loader/atlas-upload-observer.h>
+#include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
+#include <dali-toolkit/internal/visuals/texture-upload-observer.h>
+#include <dali-toolkit/internal/visuals/visual-base-impl.h>
+#include <dali-toolkit/internal/visuals/visual-url.h>
+#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
namespace Dali
{
-
class NativeImage;
namespace Toolkit
{
-
namespace Internal
{
-
+class ImageVisualShaderFactory;
class ImageVisual;
-typedef IntrusivePtr< ImageVisual > ImageVisualPtr;
+typedef IntrusivePtr<ImageVisual> ImageVisualPtr;
/**
- * The renderer which renders an image to the control's quad
+ * The visual which renders an image to a quad geometry
*
* The following properties are optional
*
- * | %Property Name | Type |
- * |--------------------|------------------|
- * | url | STRING |
- * | fittingMode | STRING |
- * | samplingMode | STRING |
- * | desiredWidth | INT |
- * | desiredHeight | INT |
- * | synchronousLoading | BOOLEAN |
+ * | %Property Name | Type |
+ * |-----------------------|-------------------|
+ * | url | STRING |
+ * | alphaMaskUrl | STRING |
+ * | fittingMode | INTEGER OR STRING |
+ * | samplingMode | INTEGER OR STRING |
+ * | desiredWidth | INTEGER |
+ * | desiredHeight | INTEGER |
+ * | synchronousLoading | BOOLEAN |
+ * | pixelArea | VECTOR4 |
+ * | wrapModeU | INTEGER OR STRING |
+ * | wrapModeV | INTEGER OR STRING |
+ * | loadPolicy | INTEGER OR STRING |
+ * | releasePolicy | INTEGER OR STRING |
+ * | orientationCorrection | BOOLEAN |
+ *
+ * where pixelArea is a rectangular area.
+ * In its Vector4 value, the first two elements indicate the top-left position of the area,
+ * and the last two elements are the area width and height respectively.
+ * If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image.
+ *
+ * where wrapModeU and wrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0.
+ * Its value should be one of the following wrap mode:
+ * "DEFAULT"
+ * "CLAMP_TO_EDGE"
+ * "REPEAT"
+ * "MIRRORED_REPEAT"
*
* where imageFittingMode should be one of the following fitting modes:
* "SHRINK_TO_FIT"
- * "SCALE_TO_FIT"
+ * "SCALE_TO_FILL"
* "FIT_WIDTH"
* "FIT_HEIGHT"
* "DEFAULT"
* "DONT_CARE"
* "DEFAULT"
*
+ * where loadPolicy should be one of the following image loading modes
+ * "IMMEDIATE" // Loads image even if visual not attached to stage yet
+ * "ATTACHED" // Only loads image once visual is attached to stage
+ *
+ * where releasePolicy should be one of the following policies for when to cache the image
+ * "DETACHED" // Release image from cache when visual detached from stage
+ * "DESTROYED" // Keep image in cache until the visual is destroyed
+ * "NEVER" // Keep image in cache until application ends.
+ *
+ * If the Visual is in a LayerUI it will pixel align the image, using a Layer3D will disable pixel alignment.
+ * Changing layer behaviour between LayerUI to Layer3D whilst the visual is already staged will not have an effect.
*/
-class ImageVisual: public Visual, public ConnectionTracker
+class ImageVisual : public Visual::Base, public ConnectionTracker, public AtlasUploadObserver, public TextureUploadObserver
{
public:
-
/**
- * @brief Constructor.
+ * @brief Create a new image visual with a URL.
+ *
+ * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
*
* @param[in] factoryCache The VisualFactoryCache object
- * @param[in] atlasManager The atlasManager object
+ * @param[in] shaderFactory The ImageVisualShaderFactory object
+ * @param[in] imageUrl The URL of the image resource to use
+ * @param[in] properties A Property::Map containing settings for this visual
+ * @param[in] size The width and height to fit the loaded image to.
+ * @param[in] fittingMode The FittingMode of the resource to load
+ * @param[in] samplingMode The SamplingMode of the resource to load
+ * @return A smart-pointer to the newly allocated visual.
*/
- ImageVisual( VisualFactoryCache& factoryCache, ImageAtlasManager& atlasManager );
+ static ImageVisualPtr New(VisualFactoryCache& factoryCache,
+ ImageVisualShaderFactory& shaderFactory,
+ const VisualUrl& imageUrl,
+ const Property::Map& properties,
+ ImageDimensions size = ImageDimensions(),
+ FittingMode::Type fittingMode = FittingMode::DEFAULT,
+ Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR);
/**
- * @brief A reference counted object may only be deleted by calling Unreference().
+ * @brief Create a new image visual with a URL.
+ *
+ * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
+ *
+ * @param[in] factoryCache The VisualFactoryCache object
+ * @param[in] shaderFactory The ImageVisualShaderFactory object
+ * @param[in] imageUrl The URL of the image resource to use
+ * @param[in] size The width and height to fit the loaded image to.
+ * @param[in] fittingMode The FittingMode of the resource to load
+ * @param[in] samplingMode The SamplingMode of the resource to load
+ * @return A smart-pointer to the newly allocated visual.
*/
- ~ImageVisual();
-
-public: // from Visual
-
+ static ImageVisualPtr New(VisualFactoryCache& factoryCache,
+ ImageVisualShaderFactory& shaderFactory,
+ const VisualUrl& imageUrl,
+ ImageDimensions size = ImageDimensions(),
+ FittingMode::Type fittingMode = FittingMode::DEFAULT,
+ Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR);
+
+public: // from Visual
/**
- * @copydoc Visual::SetSize
+ * @copydoc Visual::Base::GetNaturalSize
*/
- virtual void SetSize( const Vector2& size );
+ void GetNaturalSize(Vector2& naturalSize) override;
/**
- * @copydoc Visual::GetNaturalSize
+ * @copydoc Visual::Base::CreatePropertyMap
*/
- virtual void GetNaturalSize( Vector2& naturalSize ) const;
+ void DoCreatePropertyMap(Property::Map& map) const override;
/**
- * @copydoc Visual::SetClipRect
+ * @copydoc Visual::Base::CreateInstancePropertyMap
*/
- virtual void SetClipRect( const Rect<int>& clipRect );
+ void DoCreateInstancePropertyMap(Property::Map& map) const override;
/**
- * @copydoc Visual::SetOffset
+ * @copydoc Visual::Base::OnDoAction
*/
- virtual void SetOffset( const Vector2& offset );
+ void OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes) override;
+protected:
/**
- * @copydoc Visual::CreatePropertyMap
+ * @brief Constructor with a URL.
+ *
+ * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
+ *
+ * @param[in] factoryCache The VisualFactoryCache object
+ * @param[in] shaderFactory The ImageVisualShaderFactory object
+ * @param[in] imageUrl The URL of the image resource to use
+ * @param[in] size The width and height to fit the loaded image to.
+ * @param[in] fittingMode The FittingMode of the resource to load
+ * @param[in] samplingMode The SamplingMode of the resource to load
*/
- virtual void DoCreatePropertyMap( Property::Map& map ) const;
+ ImageVisual(VisualFactoryCache& factoryCache,
+ ImageVisualShaderFactory& shaderFactory,
+ const VisualUrl& imageUrl,
+ ImageDimensions size,
+ FittingMode::Type fittingMode,
+ Dali::SamplingMode::Type samplingMode);
-protected:
/**
- * @copydoc Visual::DoInitialize
+ * @brief A reference counted object may only be deleted by calling Unreference().
*/
- virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
+ virtual ~ImageVisual();
/**
- * @copydoc Visual::DoSetOnStage
+ * @copydoc Visual::Base::OnInitialize
*/
- virtual void DoSetOnStage( Actor& actor );
+ void OnInitialize() override;
/**
- * @copydoc Visual::DoSetOffStage
+ * @copydoc Visual::Base::DoSetProperties
*/
- virtual void DoSetOffStage( Actor& actor );
-
-public:
+ void DoSetProperties(const Property::Map& propertyMap) override;
/**
- * Get the standard image rendering shader.
- * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @copydoc Visual::Base::DoSetOnScene
*/
- static Shader GetImageShader( VisualFactoryCache& factoryCache );
+ void DoSetOnScene(Actor& actor) override;
/**
- * @brief Sets the image of this renderer to the resource at imageUrl
- * The renderer will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
- *
- * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor
- * @param[in] imageUrl The URL of the image resource to use
- * @param[in] size The width and height to fit the loaded image to.
- * @param[in] fittingMode The FittingMode of the resource to load
- * @param[in] samplingMode The SamplingMode of the resource to load
+ * @copydoc Visual::Base::DoSetOffScene
*/
- void SetImage( Actor& actor,
- const std::string& imageUrl,
- ImageDimensions size=ImageDimensions(),
- FittingMode::Type fittingMode = FittingMode::DEFAULT,
- Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
+ void DoSetOffScene(Actor& actor) override;
/**
- * @brief Sets the image of this renderer to use
- *
- * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor
- * @param[in] image The image to use
+ * @copydoc Visual::Base::OnSetTransform
*/
- void SetImage( Actor& actor, const Image& image );
+ void OnSetTransform() override;
-private:
+ /**
+ * @copydoc Visual::Base::IsResourceReady
+ */
+ bool IsResourceReady() const override;
/**
- * @brief Applies the image to the texture set used for this renderer
- *
- * @param[in] image The Image to apply to the texture set used for this renderer
+ * @copydoc Visual::Base::UpdateShader
*/
- void ApplyImageToSampler( const Image& image );
+ void UpdateShader() override;
/**
- * @brief Initializes the Dali::Renderer from an image url string
- *
- * @param[in] imageUrl The image url string to intialize this ImageVisual from
+ * @copydoc Visual::Base::GenerateShader
*/
- void InitializeRenderer( const std::string& imageUrl );
+ Shader GenerateShader() const override;
+public:
/**
- * @brief Initializes the Dali::Renderer from an image handle
+ * @copydoc AtlasUploadObserver::UploadCompleted
*
- * @param[in] image The image handle to intialize this ImageVisual from
+ * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
+ * This callback is the place to add the renderer as it would be called once the loading is finished.
*/
- void InitializeRenderer( const Image& image );
+ void UploadCompleted() override;
/**
- * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it
+ * @copydoc TextureUploadObserver::UploadCompleted
*
- * @return Returns the created Dali::Renderer
+ * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
+ * This callback is the place to add the renderer as it would be called once the loading is finished.
*/
- Renderer CreateRenderer() const;
+ void UploadComplete(bool success, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle, bool preMultiplied) override;
+private:
/**
- * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it
+ * @copydoc TextureUploadObserver::LoadComplete
*
- * @return Returns the created Dali::Renderer
+ * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
+ * This callback is the place to add the renderer as it would be called once the PixelBuffer loading is finished.
*/
- Renderer CreateNativeImageVisual() const;
+ void LoadComplete(bool loadSuccess, Devel::PixelBuffer pixelBuffer, const VisualUrl& url, bool preMultiplied) override
+ {
+ }
/**
- * @brief Query whether resources requires to be loaded synchronously.
- * @return Returns true if synchronoud resource loading is required, false otherwise.
+ * Allocate the mask data when a masking property is defined in the property map
*/
- bool IsSynchronousResourceLoading() const;
+ void AllocateMaskData();
/**
- * @brief Do the synchronous resource loading
+ * @brief Load the texture, will try to atlas unless unable or param set to false.
+ * @param[in, out] atlasing flag if the image has been put in a atlas (true), passing false will not atlas even if possible.
+ * @param[out] atlasRect if atlasing is used this the texture area of the image in the atlas.
+ * @param[out] textures resulting texture set from the image loading.
+ * @param[in] orientationCorrection flag determines if orientation correction should be performed
+ * @param[in] forceReload flag determines if the texture should be reloaded from its source or use the cached texture.
*/
- void DoSynchronousResourceLoading();
+ void LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload);
/**
- * Load the image.
- * @param[in] url The URL of the image resource to use.
- * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
+ * @brief Checks if atlasing should be attempted
+ * @return bool returns true if atlasing can be attempted.
*/
- Image LoadImage( const std::string& url, bool synchronousLoading );
+ bool AttemptAtlasing();
/**
- * Load the image and create a texture set to hold the texture, with automatic atlasing applied.
- * @param [out] textureRect The texture area of the resource image in the atlas.
- * @param[in] url The URL of the image resource to use.
- * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
+ * @brief Initializes the Dali::Renderer from the image url
*/
- TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading );
+ void InitializeRenderer();
/**
- * Callback function of image resource loading succeed
- * @param[in] image The Image content that we attempted to load from mImageUrl
+ * Creates the texture set and adds the texture to it
+ * @param[out] textureRect The texture area of the texture in the atlas.
+ * @param[in] url The URL of the image resource to use.
+ * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
+ * @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture
+ * @return the texture set to use
*/
- void OnImageLoaded( ResourceImage image );
+ TextureSet CreateTextureSet(Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing);
/**
* Set the value to the uTextureRect uniform
* @param[in] textureRect The texture rectangular area.
*/
- void SetTextureRectUniform( const Vector4& textureRect );
+ void SetTextureRectUniform(const Vector4& textureRect);
/**
- * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
+ * Remove texture with valid TextureId
*/
- void CleanCache(const std::string& url);
+ void RemoveTexture();
/**
- * Set shader code for nativeimage if it exists
+ * Helper method to set individual values by index key.
+ * @param[in] index The index key of the value
+ * @param[in] value The value
*/
- void SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage );
+ void DoSetProperty(Property::Index index, const Property::Value& value);
private:
- Image mImage;
- ImageAtlasManager& mAtlasManager;
- PixelData mPixels;
-
- std::string mImageUrl;
- Dali::ImageDimensions mDesiredSize;
- Dali::FittingMode::Type mFittingMode;
- Dali::SamplingMode::Type mSamplingMode;
-
- std::string mNativeFragmentShaderCode;
- bool mNativeImageFlag;
+ Vector4 mPixelArea;
+ WeakHandle<Actor> mPlacementActor;
+ VisualUrl mImageUrl;
+ TextureManager::MaskingDataPointer mMaskingData;
+
+ Dali::ImageDimensions mDesiredSize;
+ TextureManager::TextureId mTextureId;
+ TextureSet mTextures;
+
+ ImageVisualShaderFactory& mImageVisualShaderFactory;
+
+ Dali::FittingMode::Type mFittingMode : 3;
+ Dali::SamplingMode::Type mSamplingMode : 4;
+ Dali::WrapMode::Type mWrapModeU : 3;
+ Dali::WrapMode::Type mWrapModeV : 3;
+ Dali::Toolkit::ImageVisual::LoadPolicy::Type mLoadPolicy;
+ Dali::Toolkit::ImageVisual::ReleasePolicy::Type mReleasePolicy;
+ Vector4 mAtlasRect;
+ Dali::ImageDimensions mAtlasRectSize;
+ TextureManager::LoadState mLoadState; ///< The texture loading state
+ bool mAttemptAtlasing; ///< If true will attempt atlasing, otherwise create unique texture
+ bool mOrientationCorrection; ///< true if the image will have it's orientation corrected.
};
} // namespace Internal