X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fimage%2Fimage-visual.h;h=91134377e562b0fc92dc583e663eca7e40948550;hb=65ad9904d1df16ac5406fc316265c8f0388f0088;hp=24d652be248604f04c6db98d07602e5254cf023a;hpb=f4c1e7f52d49c3ce033b9ee4c3c7414b06a22d45;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/visuals/image/image-visual.h b/dali-toolkit/internal/visuals/image/image-visual.h index 24d652b..55fb59b 100644 --- a/dali-toolkit/internal/visuals/image/image-visual.h +++ b/dali-toolkit/internal/visuals/image/image-visual.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H /* - * Copyright (c) 2016 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. @@ -19,47 +19,68 @@ */ // EXTERNAL INCLUDES +#include + #include -#include #include -#include -#include +#include // INTERNAL INCLUDES -#include #include +#include +#include +#include +#include +#include namespace Dali { - class NativeImage; namespace Toolkit { - namespace Internal { - +class ImageVisualShaderFactory; class ImageVisual; -typedef IntrusivePtr< ImageVisual > ImageVisualPtr; +typedef IntrusivePtr ImageVisualPtr; /** - * The visual 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" @@ -74,181 +95,202 @@ typedef IntrusivePtr< ImageVisual > ImageVisualPtr; * "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::Base, public ConnectionTracker, public AtlasUploadObserver +class ImageVisual : public Visual::Base, public ConnectionTracker, public AtlasUploadObserver, public TextureUploadObserver { public: - - /** - * @brief Create a new image visual. - * - * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object - * @return A smart-pointer to the newly allocated visual. - */ - static ImageVisualPtr New( VisualFactoryCache& factoryCache ); - /** * @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] 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. */ - static ImageVisualPtr New( VisualFactoryCache& factoryCache, - const std::string& imageUrl, - ImageDimensions size = ImageDimensions(), - FittingMode::Type fittingMode = FittingMode::DEFAULT, - Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ); + 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 Create a new image visual with an Image type. + * @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] image The image to use + * @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. */ - static ImageVisualPtr New( VisualFactoryCache& factoryCache, const Image& image ); - -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::Base::GetNaturalSize */ - virtual void GetNaturalSize( Vector2& naturalSize ) const; + void GetNaturalSize(Vector2& naturalSize) override; /** * @copydoc Visual::Base::CreatePropertyMap */ - virtual void DoCreatePropertyMap( Property::Map& map ) const; + void DoCreatePropertyMap(Property::Map& map) const override; /** - * @copydoc Visual::Base::DoSetProperty + * @copydoc Visual::Base::CreateInstancePropertyMap */ - virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ); + void DoCreateInstancePropertyMap(Property::Map& map) const override; /** - * @copydoc Visual::Base::DoGetProperty + * @copydoc Visual::Base::OnDoAction */ - virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index ); + void OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes) override; protected: - - /** - * @brief Constructor. - * - * @param[in] factoryCache The VisualFactoryCache object - */ - ImageVisual( VisualFactoryCache& factoryCache ); - /** * @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 */ - ImageVisual( VisualFactoryCache& factoryCache, - const std::string& imageUrl, - ImageDimensions size, - FittingMode::Type fittingMode, - Dali::SamplingMode::Type samplingMode ); + ImageVisual(VisualFactoryCache& factoryCache, + ImageVisualShaderFactory& shaderFactory, + const VisualUrl& imageUrl, + ImageDimensions size, + FittingMode::Type fittingMode, + Dali::SamplingMode::Type samplingMode); /** - * @brief Constructor with an Image type. - * - * @param[in] factoryCache The VisualFactoryCache object - * @param[in] image The image to use + * @brief A reference counted object may only be deleted by calling Unreference(). */ - ImageVisual( VisualFactoryCache& factoryCache, const Image& image ); + virtual ~ImageVisual(); /** - * @brief A reference counted object may only be deleted by calling Unreference(). + * @copydoc Visual::Base::OnInitialize */ - virtual ~ImageVisual(); + void OnInitialize() override; /** - * @copydoc Visual::Base::DoInitialize + * @copydoc Visual::Base::DoSetProperties */ - virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap ); + void DoSetProperties(const Property::Map& propertyMap) override; /** - * @copydoc Visual::Base::DoSetOnStage + * @copydoc Visual::Base::DoSetOnScene */ - virtual void DoSetOnStage( Actor& actor ); + void DoSetOnScene(Actor& actor) override; /** - * @copydoc Visual::Base::DoSetOffStage + * @copydoc Visual::Base::DoSetOffScene */ - virtual void DoSetOffStage( Actor& actor ); + void DoSetOffScene(Actor& actor) override; -public: + /** + * @copydoc Visual::Base::OnSetTransform + */ + void OnSetTransform() override; /** - * Get the standard image rendering shader. - * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object - * @param[in] atlasing Whether texture atlasing is applied. - * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied. + * @copydoc Visual::Base::IsResourceReady */ - static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping ); + bool IsResourceReady() const override; /** - * @copydoc AtlasUploadObserver::UploadCompleted - * - * 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. + * @copydoc Visual::Base::UpdateShader */ - virtual void UploadCompleted(); + void UpdateShader() override; -private: + /** + * @copydoc Visual::Base::GenerateShader + */ + Shader GenerateShader() const override; +public: /** - * @brief Applies the image to the texture set used for this renderer + * @copydoc AtlasUploadObserver::UploadCompleted * - * @param[in] image The Image to apply to the texture set used for this 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. */ - void ApplyImageToSampler( const Image& image ); + void UploadCompleted() override; /** - * @brief Initializes the Dali::Renderer from an image url string + * @copydoc TextureUploadObserver::UploadCompleted * - * @param[in] imageUrl The image url string 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 std::string& imageUrl ); + void UploadComplete(bool success, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle, bool preMultiplied) override; +private: /** - * @brief Initializes the Dali::Renderer from an image handle + * @copydoc TextureUploadObserver::LoadComplete * - * @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 PixelBuffer loading is finished. */ - void InitializeRenderer( const Image& image ); + void LoadComplete(bool loadSuccess, Devel::PixelBuffer pixelBuffer, const VisualUrl& url, bool preMultiplied) override + { + } /** - * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it + * Allocate the mask data when a masking property is defined in the property map */ - void CreateRenderer(); + void AllocateMaskData(); /** - * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it + * @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 CreateNativeImageRenderer(); + void LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload); /** - * @brief Query whether resources requires to be loaded synchronously. - * @return Returns true if synchronous resource loading is required, false otherwise. + * @brief Checks if atlasing should be attempted + * @return bool returns true if atlasing can be attempted. */ - bool IsSynchronousResourceLoading() const; + bool AttemptAtlasing(); /** - * @brief Load the resource synchronously + * @brief Initializes the Dali::Renderer from the image url */ - void LoadResourceSynchronously(); + void InitializeRenderer(); /** * Creates the texture set and adds the texture to it @@ -256,47 +298,51 @@ private: * @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 CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing ); - - /** - * Callback function of image resource loading succeed - * @param[in] image The Image content that we attempted to load from mImageUrl - */ - 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; - PixelData mPixels; - TextureSet mTextureSet; - Vector4 mPixelArea; - WeakHandle mPlacementActor; - std::string mImageUrl; - std::string mNativeFragmentShaderCode; - - Dali::ImageDimensions mDesiredSize; - Dali::FittingMode::Type mFittingMode:3; - Dali::SamplingMode::Type mSamplingMode:4; - Dali::WrapMode::Type mWrapModeU:3; - Dali::WrapMode::Type mWrapModeV:3; - bool mNativeImageFlag:1; + Vector4 mPixelArea; + WeakHandle 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