Mercurial > molko

annotate src/image.h @ 27:607bd90aba63

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: finalize map converter and opener, closes #2448 @6h
author David Demelier <markand@malikania.fr>
date Sun, 12 Jan 2020 21:04:49 +0100
parents 5519ad48822e
children
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.
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
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 #include <stddef.h>
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct texture;
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 /**
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * Open a file from a path.
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 * \pre path != NULL
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 * \param path the path to the file
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * \return the texture or NULL on error
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 */
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 struct texture *
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 image_openf(const char *path);
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 /**
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 * Open a file from a memory buffer.
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 *
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 * \pre buffer != NULL
22
5519ad48822e doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents: 21
diff changeset
45 * \param buffer the memory buffer
5519ad48822e doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents: 21
diff changeset
46 * \param size the memory size
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 * \return the texture or NULL on error
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 */
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 struct texture *
21
63eaec5ceba9 misc: minor cleanups
David Demelier <markand@malikania.fr>
parents: 4
diff changeset
50 image_openb(const void *buffer, size_t size);
4
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
cd58eabb7fb4 core: implement basic images, closes #2441
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 #endif /* !MOLKO_IMAGE_H */