#define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_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.
*/
// EXTERNAL INCLUDES
+#include <dali/devel-api/common/owner-container.h>
#include <dali/public-api/math/uint-16-pair.h>
#include <dali/public-api/object/ref-object.h>
#include <dali/public-api/rendering/geometry.h>
-#include <dali/public-api/rendering/renderer.h>
#include <dali/public-api/rendering/shader.h>
-#include <dali/devel-api/common/owner-container.h>
-#include <dali/devel-api/object/weak-handle.h>
// INTERNAL INCLUDES
#include <dali-toolkit/internal/visuals/npatch-loader.h>
#include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
+#include <dali-toolkit/internal/visuals/texture-manager-impl.h>
+#include <dali/devel-api/rendering/renderer-devel.h>
namespace Dali
{
+class Texture;
namespace Toolkit
{
-
namespace Internal
{
-
class ImageAtlasManager;
-typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
-
class NPatchLoader;
+class TextureManager;
+class VectorAnimationManager;
+
+typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
/**
* Caches shaders and geometries. Owned by VisualFactory.
*/
-class VisualFactoryCache : public RefObject
+class VisualFactoryCache
{
public:
-
/**
* Type of shader for caching.
*/
enum ShaderType
{
COLOR_SHADER,
+ COLOR_SHADER_ROUNDED_CORNER,
+ COLOR_SHADER_BORDERLINE,
+ COLOR_SHADER_ROUNDED_BORDERLINE,
+ COLOR_SHADER_BLUR_EDGE,
+ COLOR_SHADER_ROUNDED_CORNER_BLUR_EDGE,
BORDER_SHADER,
BORDER_SHADER_ANTI_ALIASING,
- GRADIENT_SHADER_LINEAR_USER_SPACE,
GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
- GRADIENT_SHADER_RADIAL_USER_SPACE,
+ GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
+ GRADIENT_SHADER_LINEAR_BOUNDING_BOX_BORDERLINE,
+ GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_BORDERLINE,
+ GRADIENT_SHADER_LINEAR_USER_SPACE,
+ GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
+ GRADIENT_SHADER_LINEAR_USER_SPACE_BORDERLINE,
+ GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_BORDERLINE,
GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
+ GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
+ GRADIENT_SHADER_RADIAL_BOUNDING_BOX_BORDERLINE,
+ GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_BORDERLINE,
+ GRADIENT_SHADER_RADIAL_USER_SPACE,
+ GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
+ GRADIENT_SHADER_RADIAL_USER_SPACE_BORDERLINE,
+ GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_BORDERLINE,
IMAGE_SHADER,
- BATCH_IMAGE_SHADER,
+ IMAGE_SHADER_ROUNDED_CORNER,
+ IMAGE_SHADER_BORDERLINE,
+ IMAGE_SHADER_ROUNDED_BORDERLINE,
IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
+ NATIVE_IMAGE_SHADER,
+ NATIVE_IMAGE_SHADER_ROUNDED_CORNER,
+ NATIVE_IMAGE_SHADER_BORDERLINE,
+ NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE,
NINE_PATCH_SHADER,
- SVG_SHADER,
- TEXT_SHADER,
+ NINE_PATCH_MASK_SHADER,
+ TEXT_SHADER_MULTI_COLOR_TEXT,
+ TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
+ TEXT_SHADER_SINGLE_COLOR_TEXT,
+ TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
+ TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
+ TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
+ ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
+ ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
+ ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
+ ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
+ ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
+ ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
+ ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
+ ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
+ ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
+ ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
+ ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
+ ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
WIREFRAME_SHADER,
- SHADER_TYPE_MAX = WIREFRAME_SHADER
+ ARC_BUTT_CAP_SHADER,
+ ARC_ROUND_CAP_SHADER,
+ SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
};
/**
};
public:
-
/**
* @brief Constructor
+ *
+ * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
*/
- VisualFactoryCache();
+ VisualFactoryCache(bool preMultiplyOnLoad);
+
+ /**
+ * @brief Destructor
+ */
+ ~VisualFactoryCache();
/**
* Request geometry of the given type.
* @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
*/
- Geometry GetGeometry( GeometryType type );
+ Geometry GetGeometry(GeometryType type);
/**
* Cache the geometry of the give type.
* @param[in] type The geometry type.
* @param[in] geometry The geometry for caching.
*/
- void SaveGeometry( GeometryType type, Geometry geometry);
+ void SaveGeometry(GeometryType type, Geometry geometry);
/**
* Request shader of the given type.
* @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
*/
- Shader GetShader( ShaderType type );
+ Shader GetShader(ShaderType type);
/**
* Cache the geometry of the give type.
* @param[in] type The geometry type.
* @param[in] geometry The geometry for caching.
*/
- void SaveShader( ShaderType type, Shader shader );
+ void SaveShader(ShaderType type, Shader shader);
/*
* Greate the quad geometry.
* @param[in] gridSize The size of the grid.
* @return The created grid geometry.
*/
- static Geometry CreateGridGeometry( Uint16Pair gridSize );
+ static Geometry CreateGridGeometry(Uint16Pair gridSize);
/**
- * Create the batchable geometry
- * @param[in] texCoords The texture atlas rect coordinates
- * @return The created batchable geometry
+ * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
*/
- static Geometry CreateBatchQuadGeometry( Vector4 texCoords );
-
- /**
- * @brief Returns an image to be used when a visual has failed to correctly render
- * @return The broken image handle.
- */
- static Image GetBrokenVisualImage();
-
-public:
+ void SetPreMultiplyOnLoad(bool preMultiply);
/**
- * @brief Request renderer from the url
- *
- * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
+ * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
*/
- Renderer GetRenderer( const std::string& key ) const;
+ bool GetPreMultiplyOnLoad();
/**
- * @brief Cache the renderer based on the given key.
- *
- * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
- * RemoveRenderer will then need to be called twice to remove both items from the cache.
- *
- * @param[in] key The key to use for caching
- * @param[in] renderer The Renderer to be cached
+ * @brief Set an image to be used when a visual has failed to correctly render
+ * @param[in] brokenImageUrlList The broken image url list
*/
- void SaveRenderer( const std::string& key, Renderer& renderer );
+ void SetBrokenImageUrl(std::string& defaultBrokenUrl, const std::vector<std::string>& brokenImageUrlList);
/**
- * @brief Cleans the renderer cache by removing the renderer from the cache based on the given key if there are no longer any references to it
- *
- * @param[in] key The key used for caching
- *
- * @return True if the renderer is no longer used anywhere, false otherwise
+ * @brief Update the broken image Renderer object
+ * @param[in,out] renderer renderer for broken image
+ * @param[in] size the size of actor
*/
- bool CleanRendererCache( const std::string& key );
+ void UpdateBrokenImageRenderer(Renderer& renderer, const Vector2& size);
+public:
/**
* Get the image atlas manager.
* @return A pointer to the atlas manager
ImageAtlasManagerPtr GetAtlasManager();
/**
+ * Get the texture manager
+ * @return A reference to the texture manager
+ */
+ TextureManager& GetTextureManager();
+
+ /**
* Get the N-Patch texture cache.
* @return A reference to the N patch loader
*/
*/
SvgRasterizeThread* GetSVGRasterizationThread();
-private: // for svg rasterization thread
-
/**
- * Applies the rasterized image to material
+ * Get the vector animation manager.
+ * @return A reference to the vector animation manager.
*/
- void ApplyRasterizedSVGToSampler();
+ VectorAnimationManager& GetVectorAnimationManager();
protected:
-
- /**
- * A reference counted object may only be deleted by calling Unreference()
- */
- virtual ~VisualFactoryCache();
-
/**
* Undefined copy constructor.
*/
VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
private:
- struct CachedRenderer
- {
- std::string mKey;
- WeakHandle< Renderer > mRenderer;
+ /**
+ * @brief Returns a cached Texture to use when a visual has failed to correctly render
+ * @param[in] brokenIndex The index of broken image
+ *
+ * @return The broken image texture.
+ */
+ Texture GetBrokenVisualImage(uint32_t brokenIndex);
- CachedRenderer( const std::string& key, Renderer& renderer )
- : mKey( key ),
- mRenderer( renderer)
- {}
- };
+ /**
+ * @brief Gets the Proper broken image index
+ * @param[in] size The size of actor
+ *
+ * @return The index of broken image
+ */
+ int32_t GetProperBrokenImageIndex(const Vector2& size);
- typedef Dali::Vector< std::size_t > HashVector;
- typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
+ /**
+ * @brief Apply a texture and uniforms
+ *
+ * @param[in,out] renderer The renderer for broken image
+ * @param[in] index The index of broken image
+ */
+ void ApplyTextureAndUniforms(Renderer& renderer, int index);
/**
- * @brief Finds the first index into the cached visuals from the url
+ * @brief Gets a geometry for npatch image
*
- * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
+ * @param[in] index the index of broken image
+ * @return The Geometry for NPatch
*/
- int FindRenderer( const std::string& key ) const;
+ Geometry GetNPatchGeometry(int index);
-private:
- Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
- Shader mShader[SHADER_TYPE_MAX+1];
+ /**
+ * @brief Gets the Npatch Shader object
+ *
+ * @param[in] index The index of broken image
+ * @return The Shader for NPatch
+ */
+ Shader GetNPatchShader(int index);
+
+ /**
+ * @brief Returns a broken image type
+ * @param[in] index BrokenImage index
+ * @return The broken image type.
+ */
+ VisualUrl::Type GetBrokenImageVisualType(int index);
- HashVector mRendererHashes;
- CachedRenderers mRenderers;
+private:
+ struct BrokenImageInfo
+ {
+ BrokenImageInfo()
+ :visualType(),
+ url(""),
+ npatchId(NPatchData::INVALID_NPATCH_DATA_ID),
+ texture(),
+ width(0),
+ height(0)
+ {
+ }
+
+ ~BrokenImageInfo()
+ {
+ }
+
+ // Data
+ VisualUrl::Type visualType;
+ std::string url;
+ NPatchData::NPatchDataId npatchId;
+ Texture texture;
+ uint32_t width;
+ uint32_t height;
+ };
- Renderer mWireframeRenderer;
+ Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
+ Shader mShader[SHADER_TYPE_MAX + 1];
- ImageAtlasManagerPtr mAtlasManager;
- NPatchLoader mNPatchLoader;
+ ImageAtlasManagerPtr mAtlasManager;
+ TextureManager mTextureManager;
+ NPatchLoader mNPatchLoader;
- SvgRasterizeThread* mSvgRasterizeThread;
+ SvgRasterizeThread* mSvgRasterizeThread;
+ std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
+ bool mPreMultiplyOnLoad;
+ std::vector<BrokenImageInfo> mBrokenImageInfoContainer;
+ std::string mDefaultBrokenImageUrl;
+ bool mUseDefaultBrokenImageOnly;
};
} // namespace Internal