dali/devel-api/adaptor-framework/bitmap-saver.h

   1 #ifndef DALI_ADAPTOR_BITMAP_SAVER_H
   2 #define DALI_ADAPTOR_BITMAP_SAVER_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // EXTERNAL INCLUDES
  21 #include <dali/public-api/images/pixel.h>
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/dali-adaptor-common.h>
  26
  27 namespace Dali
  28 {
  29 static constexpr uint32_t DEFAULT_JPG_QUALITY = 100;
  30
  31 /**
  32  * Store the given pixel data to a file.
  33  * The suffix of the filename determines what type of file will be stored,
  34  * currently only jpeg and png formats are supported.
  35  *
  36  * @param[in] pixelBuffer Pointer to the pixel data
  37  * @param[in] filename    Filename to save
  38  * @param[in] pixelFormat The format of the buffer's pixels
  39  * @param[in] width       The width of the image in pixels
  40  * @param[in] height      The height of the image in pixels
  41  *
  42  * @return true if the file was saved
  43  */
  44 DALI_ADAPTOR_API bool EncodeToFile(const unsigned char* const pixelBuffer,
  45                                    const std::string&         filename,
  46                                    const Pixel::Format        pixelFormat,
  47                                    const std::size_t          width,
  48                                    const std::size_t          height);
  49
  50 /**
  51  * Store the given pixel data to a file.
  52  * The suffix of the filename determines what type of file will be stored,
  53  * currently only jpeg and png formats are supported.
  54  *
  55  * @param[in] pixelBuffer Pointer to the pixel data
  56  * @param[in] filename    Filename to save
  57  * @param[in] pixelFormat The format of the buffer's pixels
  58  * @param[in] width       The width of the image in pixels
  59  * @param[in] height      The height of the image in pixels
  60  * @param[in] quality     The value to control image quality for jpeg file format in the range [1, 100]
  61  *
  62  * @return true if the file was saved
  63  */
  64 DALI_ADAPTOR_API bool EncodeToFile(const unsigned char* const pixelBuffer,
  65                                    const std::string&         filename,
  66                                    const Pixel::Format        pixelFormat,
  67                                    const std::size_t          width,
  68                                    const std::size_t          height,
  69                                    const uint32_t             quality);
  70
  71 } // namespace Dali
  72
  73 #endif // DALI_ADAPTOR_BITMAP_SAVER_H