Codefix: Documentation comment in IndustryDirectoryWindow (#13059)
[openttd-github.git] / src / bmp.h
blob0e82aff004a66e89a1de90875deb4d756ce2c515
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file bmp.h Read and write support for bmps. */
10 #ifndef BMP_H
11 #define BMP_H
13 #include "gfx_type.h"
14 #include "random_access_file_type.h"
16 struct BmpInfo {
17 size_t offset; ///< offset of bitmap data from .bmp file beginning
18 uint32_t width; ///< bitmap width
19 uint32_t height; ///< bitmap height
20 bool os2_bmp; ///< true if OS/2 1.x or windows 2.x bitmap
21 uint16_t bpp; ///< bits per pixel
22 uint32_t compression; ///< compression method (0 = none, 1 = 8-bit RLE, 2 = 4-bit RLE)
23 uint32_t palette_size; ///< number of colours in palette
26 struct BmpData {
27 std::vector<Colour> palette;
28 std::vector<uint8_t> bitmap;
31 bool BmpReadHeader(RandomAccessFile &file, BmpInfo &info, BmpData &data);
32 bool BmpReadBitmap(RandomAccessFile &file, BmpInfo &info, BmpData &data);
34 #endif /* BMP_H */