c019ae865f0febdd8479026f3434b73bf7520f47
[platform/core/uifw/dali-adaptor.git] / platform-abstractions / tizen / image-loaders / loader-ktx.h
1 #ifndef __DALI_TIZEN_PLATFORM_LOADER_KTX_H__
2 #define __DALI_TIZEN_PLATFORM_LOADER_KTX_H__
3
4 /*
5  * Copyright (c) 2017 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 <cstdio>
22 #include "image-loader-input.h"
23
24 namespace Dali
25 {
26
27 namespace Integration
28 {
29   class Bitmap;
30 }
31
32 namespace TizenPlatform
33 {
34
35 class ResourceLoadingClient;
36
37 namespace Ktx
38 {
39 const unsigned char MAGIC_BYTE_1 = 0xAB;
40 const unsigned char MAGIC_BYTE_2 = 0x4B;
41 } // namespace Ktx
42
43 /**
44  * Loads a compressed bitmap from a KTX file without decoding it.
45  * This function checks the header first
46  * and if it is not a KTX file, then it returns straight away.
47  * @param[in]  input  Information about the input image (including file pointer)
48  * @param[out] bitmap The bitmap class where the decoded image will be stored
49  * @return  true if file loaded successfully, false otherwise
50  */
51 bool LoadBitmapFromKtx( const ImageLoader::Input& input, Integration::Bitmap& bitmap );
52
53 /**
54  * Loads the header of a KTX file and fills in the width and height appropriately.
55  * @param[in]   fp      Pointer to the Image file
56  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
57  * @param[out]  width   Is set with the width of the image
58  * @param[out]  height  Is set with the height of the image
59  * @return true if the file's header was read successully, false otherwise
60  */
61 bool LoadKtxHeader( const ImageLoader::Input& input, unsigned int& width, unsigned int& height );
62
63 } // namespace TizenPlatform
64
65 } // namespace Dali
66
67 #endif // __DALI_TIZEN_PLATFORM_LOADER_KTX_H__