dali/internal/imaging/common/loader-ktx.h

   1 #ifndef DALI_TIZEN_PLATFORM_LOADER_KTX_H
   2 #define DALI_TIZEN_PLATFORM_LOADER_KTX_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 #include <dali/devel-api/adaptor-framework/image-loader-input.h>
  22 #include <cstdio>
  23
  24 namespace Dali
  25 {
  26 namespace Devel
  27 {
  28 class PixelBuffer;
  29 }
  30
  31 namespace TizenPlatform
  32 {
  33 class ResourceLoadingClient;
  34
  35 namespace Ktx
  36 {
  37 const unsigned char MAGIC_BYTE_1 = 0xAB;
  38 const unsigned char MAGIC_BYTE_2 = 0x4B;
  39 } // namespace Ktx
  40
  41 /**
  42  * Loads a compressed bitmap from a KTX file without decoding it.
  43  * This function checks the header first
  44  * and if it is not a KTX file, then it returns straight away.
  45  * @param[in]  input  Information about the input image (including file pointer)
  46  * @param[out] bitmap The bitmap class where the decoded image will be stored
  47  * @return  true if file loaded successfully, false otherwise
  48  */
  49 bool LoadBitmapFromKtx(const Dali::ImageLoader::Input& input, Dali::Devel::PixelBuffer& bitmap);
  50
  51 /**
  52  * Loads the header of a KTX 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 LoadKtxHeader(const Dali::ImageLoader::Input& input, unsigned int& width, unsigned int& height);
  60
  61 } // namespace TizenPlatform
  62
  63 } // namespace Dali
  64
  65 #endif // DALI_TIZEN_PLATFORM_LOADER_KTX_H