#define DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
/*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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/circular-queue.h>
+#include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
#include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
-#include <dali-toolkit/internal/visuals/texture-manager-impl.h>
+#include <dali/devel-api/common/circular-queue.h>
namespace Dali
{
{
namespace Internal
{
-
/**
* Class to manage a rolling cache of images, where the cache size
* is smaller than the total number of images.
public:
/**
* Constructor.
- * @param[in] textureManager The texture manager
- * @param[in] urlList List of urls to cache
- * @param[in] observer FrameReady observer
- * @param[in] cacheSize The size of the cache
- * @param[in] batchSize The size of a batch to load
+ * @param[in] textureManager The texture manager
+ * @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
+ * @param[in] urlList List of urls to cache
+ * @param[in] maskingData Masking data to be applied.
+ * @param[in] observer FrameReady observer
+ * @param[in] cacheSize The size of the cache
+ * @param[in] batchSize The size of a batch to load
+ * @param[in] interval Time interval between each frame
+ * @param[in] preMultiplyOnLoad The flag if image's color should be multiplied by it's alpha
*
* This will start loading textures immediately, according to the
* batch and cache sizes.
*/
- RollingImageCache( TextureManager& textureManager,
- UrlList& urlList,
- ImageCache::FrameReadyObserver& observer,
- uint16_t cacheSize,
- uint16_t batchSize );
+ RollingImageCache(TextureManager& textureManager,
+ ImageDimensions size,
+ Dali::FittingMode::Type fittingMode,
+ Dali::SamplingMode::Type samplingMode,
+ UrlList& urlList,
+ TextureManager::MaskingDataPointer& maskingData,
+ ImageCache::FrameReadyObserver& observer,
+ uint16_t cacheSize,
+ uint16_t batchSize,
+ uint32_t interval,
+ bool preMultiplyOnLoad);
/**
* Destructor
*/
- virtual ~RollingImageCache();
+ ~RollingImageCache() override;
/**
- * Get the first frame. If it's not ready, this will trigger the
- * sending of FrameReady() when the image becomes ready.
+ * @copydoc Internal::ImageCache::Frame()
*/
- virtual TextureSet FirstFrame();
+ TextureSet Frame(uint32_t frameIndex) override;
/**
- * Get the next frame. If it's not ready, this will trigger the
- * sending of FrameReady() when the image becomes ready.
- * This will trigger the loading of the next batch.
+ * @copydoc Internal::ImageCache::FirstFrame()
*/
- virtual TextureSet NextFrame();
+ TextureSet FirstFrame() override;
-private:
/**
- * @return true if the front frame is ready
+ * @copydoc Internal::ImageCache::GetFrameInterval()
*/
- bool IsFrontReady() const;
+ uint32_t GetFrameInterval(uint32_t frameIndex) const override;
/**
- * Load the next batch of images
+ * @copydoc Internal::ImageCache::GetCurrentFrameIndex()
*/
- void LoadBatch();
+ int32_t GetCurrentFrameIndex() const override;
/**
- * Find the matching image frame, and set it to ready
+ * @copydoc Internal::ImageCache::GetTotalFrameCount()
*/
- void SetImageFrameReady( TextureManager::TextureId textureId );
+ int32_t GetTotalFrameCount() const override;
/**
- * Get the texture set of the front frame.
- * @return the texture set
+ * @copydoc Internal::ImageCache::ClearCache()
+ */
+ void ClearCache() override;
+
+private:
+ /**
+ * @brief Check whether the front frame is ready or not.
+ *
+ * @return true if the front frame is ready
+ */
+ bool IsFrontReady() const;
+
+ /**
+ * @brief Load the next batch of images
+ *
+ * @param[in] frameIndex starting frame index of batch to be loaded.
+ */
+ void LoadBatch(uint32_t frameIndex);
+
+ /**
+ * @brief Get the texture set of the front frame.
+ *
+ * @return the texture set of the front of Cache.
*/
TextureSet GetFrontTextureSet() const;
/**
- * Get the texture id of the given index
+ * @brief Get the texture id of the given index
+ *
+ * @param[in] index index of the queue.
*/
- TextureManager::TextureId GetCachedTextureId( int index ) const;
+ TextureManager::TextureId GetCachedTextureId(int index) const;
/**
- * Check if the front frame has become ready - if so, inform observer
- * @param[in] wasReady Readiness before call.
+ * @brief Pop front entity of Cache.
*/
- void CheckFrontFrame( bool wasReady );
+ void PopFrontCache();
protected:
- virtual void UploadComplete(
- bool loadSuccess,
- int32_t textureId,
- TextureSet textureSet,
- bool useAtlasing,
- const Vector4& atlasRect,
- bool preMultiplied ) override;
+ /**
+ * @copydoc Toolkit::TextureUploadObserver::LoadComplete()
+ */
+ void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
private:
/**
struct ImageFrame
{
unsigned int mUrlIndex = 0u;
- bool mReady = false;
+ bool mReady = false;
};
- std::vector<UrlStore>& mImageUrls;
+ std::vector<UrlStore>& mImageUrls;
CircularQueue<ImageFrame> mQueue;
};
projects / platform / core / uifw / dali-toolkit.git / blobdiff