dali/public-api/adaptor-framework/encoded-image-buffer.h

   1 #ifndef DALI_ENCODED_IMAGE_BUFFER_H
   2 #define DALI_ENCODED_IMAGE_BUFFER_H
   3 /*
   4  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/public-api/object/base-handle.h>
  22 #include <dali/public-api/common/dali-vector.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/dali-adaptor-common.h>
  26
  27 namespace Dali
  28 {
  29 namespace Internal DALI_INTERNAL
  30 {
  31 class EncodedImageBuffer;
  32 }
  33
  34 /**
  35  * @brief EncodedImageBuffer contains the large encoded raw buffer informations.
  36  *
  37  * We can upload this buffer by generated url.
  38  * The images are loaded by a worker thread to avoid blocking the main event thread.
  39  * @note cannot change raw buffer after make handle.
  40  * @note only regular image upload support now.
  41  */
  42 class DALI_ADAPTOR_API EncodedImageBuffer : public BaseHandle
  43 {
  44 public:
  45   using RawBufferType = Dali::Vector<uint8_t>;
  46
  47 public:
  48   /**
  49    * @brief Create a new EncodedImageBuffer.
  50    *
  51    * @param [in] buffer The encoded raw buffer
  52    * @return A handle to a new EncodedImageBuffer.
  53    */
  54   static EncodedImageBuffer New(const RawBufferType& buffer);
  55
  56   /**
  57    * @brief Create an empty handle.
  58    *
  59    * Calling member functions of an empty handle is not allowed.
  60    */
  61   EncodedImageBuffer();
  62
  63   /**
  64    * @brief Destructor.
  65    */
  66   ~EncodedImageBuffer();
  67
  68   /**
  69    * @brief This copy constructor is required for (smart) pointer semantics.
  70    *
  71    * @param [in] handle A reference to the copied handle
  72    */
  73   EncodedImageBuffer(const EncodedImageBuffer& handle);
  74
  75   /**
  76    * @brief This assignment operator is required for (smart) pointer semantics.
  77    *
  78    * @param [in] handle  A reference to the copied handle
  79    * @return A reference to this
  80    */
  81   EncodedImageBuffer& operator=(const EncodedImageBuffer& handle);
  82
  83   /**
  84    * @brief Get raw buffer data
  85    * @note this method return const value. Mean, you cannot change raw buffer
  86    * @return A RawBufferType this buffer have
  87    */
  88   const RawBufferType& GetRawBuffer() const;
  89
  90 public: // Not intended for developer use
  91   explicit DALI_INTERNAL EncodedImageBuffer(Internal::EncodedImageBuffer* impl);
  92 };
  93
  94 } // namespace Dali
  95
  96 #endif // DALI_ENCODED_IMAGE_BUFFER_H