Mercurial > molko

annotate libcore/core/image.h @ 169:eb0a7ab71023

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: extreme cleanup, closes #2506 While here, remove unneeded stuff.
author David Demelier <markand@malikania.fr>
date Tue, 20 Oct 2020 17:39:13 +0200
parents 789b23e01f52
children dd7c8d4321a3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_IMAGE_H
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_IMAGE_H
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
40f22a8188d2 image: set dimensions
David Demelier <markand@malikania.fr>
parents: 94
diff changeset
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
169
eb0a7ab71023 misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
31 #include "plat.h"
eb0a7ab71023 misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
32
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 struct texture;
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 /**
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * Open a file from a path.
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 *
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
38 * \pre tex != NULL
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 * \pre path != NULL
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
40 * \param tex the texture to initialize
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 * \param path the path to the file
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
42 * \return False on errors.
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 */
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
44 bool
169
eb0a7ab71023 misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
45 image_open(struct texture *tex, const char *path) PLAT_NODISCARD;
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 /**
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * Open a file from a memory buffer.
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 *
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
50 * 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
51 *
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
52 * \pre tex != NULL
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 * \pre buffer != NULL
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
54 * \param tex the texture to initialize
22
5519ad48822e doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents: 21
diff changeset
55 * \param buffer the memory buffer
5519ad48822e doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents: 21
diff changeset
56 * \param size the memory size
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
57 * \return False on errors.
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 */
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
59 bool
169
eb0a7ab71023 misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
60 image_openmem(struct texture *tex, const void *buffer, size_t size) PLAT_NODISCARD;
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 #endif /* !MOLKO_IMAGE_H */