dali/devel-api/adaptor-framework/native-image-source-devel.h

   1 #ifndef DALI_NATIVE_IMAGE_SOURCE_DEVEL_H\r
   2 #define DALI_NATIVE_IMAGE_SOURCE_DEVEL_H\r
   3 /*\r
   4  * Copyright (c) 2020 Samsung Electronics Co., Ltd.\r
   5  *\r
   6  * Licensed under the Apache License, Version 2.0 (the "License");\r
   7  * you may not use this file except in compliance with the License.\r
   8  * You may obtain a copy of the License at\r
   9  *\r
  10  * http://www.apache.org/licenses/LICENSE-2.0\r
  11  *\r
  12  * Unless required by applicable law or agreed to in writing, software\r
  13  * distributed under the License is distributed on an "AS IS" BASIS,\r
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  15  * See the License for the specific language governing permissions and\r
  16  * limitations under the License.\r
  17  *\r
  18  */\r
  19 \r
  20 // EXTERNAL INCLUDES\r
  21 #include <dali/public-api/adaptor-framework/native-image-source.h>\r
  22 \r
  23 namespace Dali\r
  24 {\r
  25 \r
  26 namespace DevelNativeImageSource\r
  27 {\r
  28 \r
  29 /**\r
  30  * @brief Acquire buffer and information of an internal native image.\r
  31  *\r
  32  * AcquireBuffer() and ReleaseBuffer() are a pair.\r
  33  * It should be call ReleaseBuffer() after AcquireBuffer().\r
  34  * @param[in] image The instance of NativeImageSource.\r
  35  * @param[out] width The width of image\r
  36  * @param[out] height The height of image\r
  37  * @param[out] stride The stride of image\r
  38  * @return     The buffer of an internal native image\r
  39  */\r
  40 DALI_ADAPTOR_API uint8_t* AcquireBuffer( NativeImageSource& image, uint16_t& width, uint16_t& height, uint16_t& stride );\r
  41 \r
  42 /**\r
  43  * @brief Release information of an internal native image.\r
  44  *\r
  45  * AcquireBuffer() and ReleaseBuffer() are a pair.\r
  46  * It should be call ReleaseBuffer() after AcquireBuffer().\r
  47  * @param[in] image The instance of NativeImageSource.\r
  48  * @return     @c true If the buffer is released successfully, and @c false otherwise\r
  49  */\r
  50 DALI_ADAPTOR_API bool ReleaseBuffer( NativeImageSource& image );\r
  51 \r
  52 } // namespace DevelNativeImageSource\r
  53 \r
  54 } // namespace Dali\r
  55 \r
  56 #endif // DALI_NATIVE_IMAGE_SOURCE_DEVEL_H\r