Mercurial > molko
annotate libmlk-core/core/image.h @ 243:71b3b7036de7
misc: lot of cleanups,
- prefix libraries with libmlk,
- move assets from source directories closes #2520,
- prefix header guards closes #2519
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 28 Nov 2020 22:37:30 +0100 |
parents | libcore/core/image.h@dd7c8d4321a3 |
children | c4da052c0def |
rev | line source |
---|---|
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * image.h -- basic image management |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
226
diff
changeset
|
19 #ifndef MOLKO_CORE_IMAGE_H |
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
226
diff
changeset
|
20 #define MOLKO_CORE_IMAGE_H |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file image.h |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief Basic image management. |
72
6203e1ac9b18
doc: improve doxygen documentation a lot
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
25 * \ingroup drawing |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 */ |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 |
112 | 28 #include <stdbool.h> |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 #include <stddef.h> |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 struct texture; |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 /** |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 * Open a file from a path. |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 * |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
36 * \pre tex != NULL |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 * \pre path != NULL |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
38 * \param tex the texture to initialize |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 * \param path the path to the file |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
40 * \return False on errors. |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 */ |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
42 bool |
226
dd7c8d4321a3
misc: miscellaneous cleanups
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
43 image_open(struct texture *tex, const char *path); |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 /** |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 * Open a file from a memory buffer. |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 * |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
48 * The buffer must be valid until the image is no longer used. |
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
49 * |
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
50 * \pre tex != NULL |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 * \pre buffer != NULL |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
52 * \param tex the texture to initialize |
22
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
21
diff
changeset
|
53 * \param buffer the memory buffer |
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
21
diff
changeset
|
54 * \param size the memory size |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
55 * \return False on errors. |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 */ |
94
ed72843a7194
core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents:
72
diff
changeset
|
57 bool |
226
dd7c8d4321a3
misc: miscellaneous cleanups
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
58 image_openmem(struct texture *tex, const void *buffer, size_t size); |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
226
diff
changeset
|
60 #endif /* !MOLKO_CORE_IMAGE_H */ |