platform-abstractions/slp/resource-loader/loader-bmp.h

   1 #ifndef __DALI_SLP_PLATFORM_LOADER_BMP_H__
   2 #define __DALI_SLP_PLATFORM_LOADER_BMP_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 #include <cstdio>
  21
  22 namespace Dali
  23 {
  24
  25 namespace Integration
  26 {
  27   class Bitmap;
  28 }
  29
  30 struct ImageAttributes;
  31
  32 namespace SlpPlatform
  33 {
  34
  35 namespace Bmp
  36 {
  37 const unsigned char MAGIC_BYTE_1 = 0x42;
  38 const unsigned char MAGIC_BYTE_2 = 0x4D;
  39 } // namespace Bmp
  40
  41 /**
  42  * Loads the bitmap from an BMP file.  This function checks the header first
  43  * and if it is not a BMP file, then it returns straight away.
  44  * @param[in]  fp      Pointer to the Image file
  45  * @param[in]  bitmap  The bitmap class where the decoded image will be stored
  46  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
  47  * @return  true if file decoded successfully, false otherwise
  48  */
  49 bool LoadBitmapFromBmp(FILE *fp, Integration::Bitmap& bitmap, ImageAttributes& attributes);
  50
  51 /**
  52  * Loads the header of a BMP file and fills in the width and height appropriately.
  53  * @param[in]   fp      Pointer to the Image file
  54  * @param[in]   attributes  Describes the dimensions, pixel format and other details for loading the image data
  55  * @param[out]  width   Is set with the width of the image
  56  * @param[out]  height  Is set with the height of the image
  57  * @return true if the file's header was read successully, false otherwise
  58  */
  59 bool LoadBmpHeader(FILE *fp, const ImageAttributes& attributes, unsigned int &width, unsigned int &height);
  60
  61 } // namespace SlpPlatform
  62
  63 } // namespace Dali
  64
  65 #endif // __DALI_SLP_PLATFORM_LOADER_BMP_H__