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