[Tizen] Add DesiredWidth/Height for animated image loading
[platform/core/uifw/dali-adaptor.git] / dali / internal / imaging / common / animated-image-loading-impl.h
index d2a624c..f1dcf31 100644 (file)
@@ -27,6 +27,7 @@
 // INTERNAL INCLUDES
 #include <dali/devel-api/adaptor-framework/animated-image-loading.h>
 #include <dali/public-api/dali-adaptor-common.h>
+#include <dali/internal/imaging/common/image-operations.h>
 
 namespace Dali
 {
@@ -66,14 +67,30 @@ public:
   ~AnimatedImageLoading() override = default;
 
   /**
-   * @copydoc Dali::AnimatedImageLoading::LoadNextNFrames()
+   * @brief Load a frame of the animated image.
+   *
+   * @note This function will load the entire animated image into memory if not already loaded.
+   * @param[in] frameIndex The frame index to load.
+   * @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 Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
    */
-  virtual bool LoadNextNFrames(uint32_t frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData) = 0;
+  Dali::Devel::PixelBuffer LoadFrame(uint32_t                 frameIndex,
+                                     ImageDimensions          size,
+                                     FittingMode::Type        fittingMode,
+                                     Dali::SamplingMode::Type samplingMode)
+  {
+    Dali::Devel::PixelBuffer pixelBuffer = LoadFrame(frameIndex);
+    return Dali::Internal::Platform::ApplyAttributesToBitmap(pixelBuffer, size, fittingMode, samplingMode);
+  }
 
+public:
   /**
-   * @copydoc Dali::AnimatedImageLoading::LoadFrame()
+   * @copydoc Dali::AnimatedImageLoading::LoadNextNFrames()
    */
-  virtual Dali::Devel::PixelBuffer LoadFrame(uint32_t frameIndex) = 0;
+  virtual bool LoadNextNFrames(uint32_t frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData) = 0;
 
   /**
    * @copydoc Dali::AnimatedImageLoading::GetImageSize()
@@ -99,6 +116,16 @@ public:
    * @copydoc Dali::AnimatedImageLoading::HasLoadingSucceeded()
    */
   virtual bool HasLoadingSucceeded() const = 0;
+
+private:
+  /**
+   * @brief Load a frame of the animated image.
+   *
+   * @note This function will load the entire animated image into memory if not already loaded.
+   * @param[in] frameIndex The frame index to load.
+   * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
+   */
+  virtual Dali::Devel::PixelBuffer LoadFrame(uint32_t frameIndex) = 0;
 };
 
 } // namespace Adaptor