1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H
2 #define DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali-toolkit/internal/visuals/texture-upload-observer.h>
22 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
31 class ImageCache : public TextureManager::LifecycleObserver
35 * Observer class to inform when the next image is ready
37 class FrameReadyObserver
41 * Informs observer when the next texture set is ready to display
42 * @param[in] textureSet The ready texture set
44 virtual void FrameReady( TextureSet textureSet ) = 0;
49 TextureManager::TextureId mTextureId = TextureManager::INVALID_TEXTURE_ID;
56 typedef std::vector<UrlStore> UrlList;
61 * @param[in] textureManager The texture manager
62 * @param[in] urlList List of urls to cache
63 * @param[in] observer FrameReady observer
64 * @param[in] batchSize The size of a batch to load
66 * This will start loading textures immediately, according to the
67 * batch and cache sizes. The cache is as large as the number of urls.
69 ImageCache( TextureManager& textureManager,
70 ImageCache::FrameReadyObserver& observer,
71 unsigned int batchSize );
73 virtual ~ImageCache();
76 * Get the first frame. If it's not ready, this will trigger the
77 * sending of FrameReady() when the image becomes ready.
79 virtual TextureSet FirstFrame() = 0;
82 * Get the next frame. If it's not ready, this will trigger the
83 * sending of FrameReady() when the image becomes ready.
85 virtual TextureSet NextFrame() = 0;
88 * Get the Nth frame. If it's not ready, this will trigger the
89 * sending of FrameReady() when the image becomes ready.
91 virtual TextureSet Frame( uint32_t frameIndex ) = 0;
94 * Get the interval of Nth frame.
96 virtual uint32_t GetFrameInterval( uint32_t frameIndex ) const = 0;
99 * Get the current rendered frame index.
100 * If there isn't any loaded frame, returns -1.
102 virtual int32_t GetCurrentFrameIndex() const = 0;
105 * Get total frame count of the animated image file.
107 virtual int32_t GetTotalFrameCount() const = 0;
112 * Called before the texture manager is destroyed.
114 void TextureManagerDestroyed() final;
117 TextureManager& mTextureManager;
118 FrameReadyObserver& mObserver;
119 unsigned int mBatchSize;
120 unsigned int mUrlIndex;
121 bool mWaitingForReadyFrame:1;
122 bool mRequestingLoad:1;
123 bool mTextureManagerAlive:1;
126 } //namespace Internal
127 } //namespace Toolkit
130 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H