dali-toolkit/internal/visuals/texture-upload-observer.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24 #include <dali/public-api/rendering/texture-set.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/internal/visuals/visual-url.h>
  28 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35 /**
  36  * @brief Base class used to observe the upload status of a texture.
  37  *
  38  * Derived class must implement the LoadComplete method which is
  39  * executed once the texture is ready to draw.
  40  */
  41 class TextureUploadObserver
  42 {
  43 public:
  44   typedef Signal<void(TextureUploadObserver*)> DestructionSignalType; ///< Signal prototype for the Destruction Signal.
  45
  46   enum class ReturnType
  47   {
  48     TEXTURE = 0,
  49     PIXEL_BUFFER
  50   };
  51
  52   struct TextureInformation
  53   {
  54     TextureInformation(ReturnType returnType, int32_t textureId, TextureSet textureSet, bool useAtlasing, const Vector4& atlasRect, bool preMultiplied);
  55     TextureInformation(ReturnType returnType, Devel::PixelBuffer pixelBuffer, const std::string& url, bool preMultiplied);
  56
  57     TextureInformation();
  58
  59     ReturnType                 returnType;    ///< Returned Texture type.
  60     int32_t                    textureId;     ///< The textureId of the loaded texture in the TextureManager
  61     TextureSet                 textureSet;    ///< The TextureSet containing the Texture
  62     bool                       useAtlasing;   ///< True if atlasing was used (note: this may be different to what was requested)
  63     const Vector4&             atlasRect;     ///< If using atlasing, this is the rectangle within the atlas to use.
  64     bool                       preMultiplied; ///< True if the image had pre-multiplied alpha applied
  65     Devel::PixelBuffer         pixelBuffer;   ///< The PixelBuffer of the loaded image.
  66     std::string_view           url;           ///< The url address of the loaded image.
  67   };
  68
  69 public:
  70   /**
  71    * @brief Constructor.
  72    */
  73   TextureUploadObserver();
  74
  75   /**
  76    * @brief Virtual destructor.
  77    */
  78   virtual ~TextureUploadObserver();
  79
  80   /**
  81    * The action to be taken once the async load has finished.
  82    * And in case of texture loading, this method is called after uploading.
  83    * This should be overridden by the deriving class.
  84    *
  85    * @param[in] loadSuccess True if the texture load was successful (i.e. the resource is available). If false, then the resource failed to load. In future, this will automatically upload a "broken" image.
  86    * @param[in] textureInformation Structure that contains loaded texture information.
  87    */
  88   virtual void LoadComplete(bool loadSuccess, TextureInformation textureInformation) = 0;
  89
  90   /**
  91    * @brief Returns the destruction signal.
  92    * This is emitted when the observer is destroyed.
  93    * This is used by the observer notifier to mark this observer as destroyed (IE. It no longer needs notifying).
  94    */
  95   DestructionSignalType& DestructionSignal();
  96
  97 private:
  98   DestructionSignalType mDestructionSignal; ///< The destruction signal emitted when the observer is destroyed.
  99 };
 100
 101 } // namespace Toolkit
 102
 103 } // namespace Dali
 104
 105 #endif // DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H