Rename GP_Context -> GP_Pixmap
[gfxprim.git] / include / loaders / GP_BMP.h
blobcf140d736643bb322bcf064afc65b0925152d121
1 /*****************************************************************************
2 * This file is part of gfxprim library. *
3 * *
4 * Gfxprim is free software; you can redistribute it and/or *
5 * modify it under the terms of the GNU Lesser General Public *
6 * License as published by the Free Software Foundation; either *
7 * version 2.1 of the License, or (at your option) any later version. *
8 * *
9 * Gfxprim is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
12 * Lesser General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU Lesser General Public *
15 * License along with gfxprim; if not, write to the Free Software *
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, *
17 * Boston, MA 02110-1301 USA *
18 * *
19 * Copyright (C) 2009-2014 Cyril Hrubis <metan@ucw.cz> *
20 * *
21 *****************************************************************************/
23 #ifndef LOADERS_GP_BMP_H
24 #define LOADERS_GP_BMP_H
26 #include "loaders/GP_Loader.h"
28 int GP_ReadBMPEx(GP_IO *io, GP_Pixmap **img, GP_DataStorage *storage,
29 GP_ProgressCallback *callback);
31 int GP_LoadBMPEx(const char *src_path, GP_Pixmap **img,
32 GP_DataStorage *storage, GP_ProgressCallback *callback);
35 * Reads a BMP from an IO stream.
37 GP_Pixmap *GP_ReadBMP(GP_IO *io, GP_ProgressCallback *callback);
41 * Loads a BMP image from a file.
43 GP_Pixmap *GP_LoadBMP(const char *src_path, GP_ProgressCallback *callback);
46 * Writes a BMP to an IO Stream.
48 * Returns zero on success, non-zero on failure and errno is set.
50 int GP_WriteBMP(const GP_Pixmap *src, GP_IO *io,
51 GP_ProgressCallback *callback);
54 * Saves BMP to a file. Zero is returned on succes. Upon failure non-zero is
55 * returned and errno is filled accordingly.
57 int GP_SaveBMP(const GP_Pixmap *src, const char *dst_path,
58 GP_ProgressCallback *callback);
61 * Looks for BMP file signature. Returns non-zero if found.
63 int GP_MatchBMP(const void *buf);
66 extern GP_Loader GP_BMP;
68 #endif /* LOADERS_GP_BMP_H */