Mercurial > molko
annotate libmlk-core/mlk/core/image.h @ 564:e91f37da2992
core: doxygenize window
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 08 Mar 2023 20:09:21 +0100 |
parents | 00e7ad6938ae |
children | d307f93d79af |
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 * |
445
773a082f0b91
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
431
diff
changeset
|
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr> |
4
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 |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
340
diff
changeset
|
19 #ifndef MLK_CORE_IMAGE_H |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
340
diff
changeset
|
20 #define MLK_CORE_IMAGE_H |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
525
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
22 /* |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
23 * \file mlk/core/image.h |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
24 * \brief Basic image management |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
25 */ |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
26 |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 #include <stddef.h> |
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 |
472
bc5483849614
core: texture -> mlk_texture
David Demelier <markand@malikania.fr>
parents:
462
diff
changeset
|
29 struct mlk_texture; |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 |
517
6e8f6640e05b
misc: use extern C manually
David Demelier <markand@malikania.fr>
parents:
472
diff
changeset
|
31 #if defined(__cplusplus) |
6e8f6640e05b
misc: use extern C manually
David Demelier <markand@malikania.fr>
parents:
472
diff
changeset
|
32 extern "C" { |
6e8f6640e05b
misc: use extern C manually
David Demelier <markand@malikania.fr>
parents:
472
diff
changeset
|
33 #endif |
292
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
253
diff
changeset
|
34 |
525
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
35 /** |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
36 * Open an image from the given filesystem path. |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
37 * |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
38 * The texture must be destroyed using ::mlk_texture_finish once no longer |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
39 * needed. |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
40 * |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
41 * \pre texture != NULL |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
42 * \param texture the texture to initialize |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
43 * \param path path to the image file (e.g. .png, .jpeg, etc) |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
44 * \return 0 on success or any error code instead |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
45 */ |
298
196264679079
misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents:
292
diff
changeset
|
46 int |
525
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
47 mlk_image_open(struct mlk_texture *texture, const char *path); |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 |
525
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
49 /** |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
50 * Open an image from a const binary data. |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
51 * |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
52 * The binary data must be kept alive until the texture is no longer used. |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
53 * |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
54 * \pre texture != NULL |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
55 * \param texture the texture to initialize |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
56 * \param data the image content |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
57 * \param datasz the image content length |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
58 * \return 0 on success or any error code instead |
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
59 */ |
298
196264679079
misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents:
292
diff
changeset
|
60 int |
525
00e7ad6938ae
core: doxygenize image
David Demelier <markand@malikania.fr>
parents:
517
diff
changeset
|
61 mlk_image_openmem(struct mlk_texture *texture, const void *data, size_t datasz); |
4
cd58eabb7fb4
core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 |
517
6e8f6640e05b
misc: use extern C manually
David Demelier <markand@malikania.fr>
parents:
472
diff
changeset
|
63 #if defined(__cplusplus) |
6e8f6640e05b
misc: use extern C manually
David Demelier <markand@malikania.fr>
parents:
472
diff
changeset
|
64 } |
6e8f6640e05b
misc: use extern C manually
David Demelier <markand@malikania.fr>
parents:
472
diff
changeset
|
65 #endif |
292
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
253
diff
changeset
|
66 |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
340
diff
changeset
|
67 #endif /* !MLK_CORE_IMAGE_H */ |