X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fimage%2Fimage-visual.h;h=c0a3f750ae71baa5d0f194eac952675533f443a0;hp=e485904708b2179fd7eccef69087a454414bcc23;hb=f15cbe6c00c4bcb9baffe8d6f95747e3c2e051d1;hpb=6338a533d19079e4415f75270d687e787ee1fa89 diff --git a/dali-toolkit/internal/visuals/image/image-visual.h b/dali-toolkit/internal/visuals/image/image-visual.h index e485904..c0a3f75 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) 2017 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. @@ -22,31 +22,28 @@ #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 a quad geometry @@ -83,7 +80,7 @@ typedef IntrusivePtr< ImageVisual > ImageVisualPtr; * * where imageFittingMode should be one of the following fitting modes: * "SHRINK_TO_FIT" - * "SCALE_TO_FIT" + * "SCALE_TO_FILL" * "FIT_WIDTH" * "FIT_HEIGHT" * "DEFAULT" @@ -110,16 +107,16 @@ typedef IntrusivePtr< ImageVisual > ImageVisualPtr; * 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, public TextureUploadObserver +class ImageVisual : public Visual::Base, public ConnectionTracker, public AtlasUploadObserver, public TextureUploadObserver { public: - /** * @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. @@ -127,12 +124,13 @@ public: * @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 VisualUrl& imageUrl, - const Property::Map& properties, - 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 a URL. @@ -140,112 +138,114 @@ public: * 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. */ - static ImageVisualPtr New( VisualFactoryCache& factoryCache, - const VisualUrl& imageUrl, - 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. - * - * @param[in] factoryCache The VisualFactoryCache object - * @param[in] image The image to use - */ - 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 ); + 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::CreateInstancePropertyMap */ - virtual void DoCreateInstancePropertyMap( Property::Map& map ) const; + void DoCreateInstancePropertyMap(Property::Map& map) const override; -protected: + /** + * @copydoc Visual::Base::OnDoAction + */ + void OnDoAction(const Dali::Property::Index actionName, const Dali::Property::Value& attributes) override; +protected: /** * @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 VisualUrl& 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::DoSetProperties */ - virtual void DoSetProperties( 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; /** * @copydoc Visual::Base::OnSetTransform */ - virtual void OnSetTransform(); + void OnSetTransform() override; -public: + /** + * @copydoc Visual::Base::IsResourceReady + */ + bool IsResourceReady() const 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::UpdateShader */ - static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping ); + void UpdateShader() override; /** + * @copydoc Visual::Base::GenerateShader + */ + Shader GenerateShader() const override; + +public: + /** * @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. */ - virtual void UploadCompleted(); + void UploadCompleted() override; /** * @copydoc TextureUploadObserver::UploadCompleted @@ -253,21 +253,23 @@ public: * 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. */ - virtual void UploadComplete( bool success, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle ); + void UploadComplete(bool success, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle, bool preMultiplied) override; private: - /** - * Allocate the mask data when a masking property is defined in the property map + * @copydoc TextureUploadObserver::LoadComplete + * + * 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 AllocateMaskData(); + void LoadComplete(bool loadSuccess, Devel::PixelBuffer pixelBuffer, const VisualUrl& url, bool preMultiplied) 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 + * Allocate the mask data when a masking property is defined in the property map */ - void ApplyImageToSampler( const Image& image ); + void AllocateMaskData(); /** * @brief Load the texture, will try to atlas unless unable or param set to false. @@ -275,38 +277,20 @@ private: * @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 LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection ); + void LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload); /** - * @brief Initializes the Dali::Renderer from the image url + * @brief Checks if atlasing should be attempted + * @return bool returns true if atlasing can be attempted. */ - void InitializeRenderer(); + bool AttemptAtlasing(); /** - * @brief Initializes the Dali::Renderer from an image handle - * - * @param[in] image The image handle to intialize this ImageVisual from - */ - void InitializeRenderer( const Image& image ); - - /** - * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it - * @param[in] textures to use - */ - void CreateRenderer( TextureSet& textures ); - - /** - * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it - * @param NativeImageRenderer - */ - void CreateNativeImageRenderer( NativeImage& nativeImage ); - - /** - * @brief Query whether resources requires to be loaded synchronously. - * @return Returns true if synchronous resource loading is required, false otherwise. + * @brief Initializes the Dali::Renderer from the image url */ - bool IsSynchronousResourceLoading() const; + void InitializeRenderer(); /** * Creates the texture set and adds the texture to it @@ -316,13 +300,13 @@ private: * @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture * @return the texture set to use */ - TextureSet CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing ); + 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); /** * Remove texture with valid TextureId @@ -334,34 +318,33 @@ private: * @param[in] index The index key of the value * @param[in] value The value */ - void DoSetProperty( Property::Index index, const Property::Value& value ); + void DoSetProperty(Property::Index index, const Property::Value& value); private: - - Image mImage; - Vector4 mPixelArea; - WeakHandle mPlacementActor; - VisualUrl mImageUrl; + Vector4 mPixelArea; + WeakHandle mPlacementActor; + VisualUrl mImageUrl; TextureManager::MaskingDataPointer mMaskingData; - Dali::ImageDimensions mDesiredSize; + Dali::ImageDimensions mDesiredSize; TextureManager::TextureId mTextureId; - TextureSet mTextures; - - Dali::FittingMode::Type mFittingMode:3; - Dali::SamplingMode::Type mSamplingMode:4; - Dali::WrapMode::Type mWrapModeU:3; - Dali::WrapMode::Type mWrapModeV:3; - DevelImageVisual::LoadPolicy::Type mLoadPolicy; - DevelImageVisual::ReleasePolicy::Type mReleasePolicy; - Vector4 mAtlasRect; - bool mAttemptAtlasing; ///< If true will attempt atlasing, otherwise create unique texture - bool mLoading; ///< True if the texture is still loading. - bool mOrientationCorrection; ///< true if the image will have it's orientation corrected. + 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 } // namespace Toolkit