Mercurial > molko

annotate libmlk-core/mlk/core/maths.h @ 528:95792046d3d2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: doxygenize maths
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 20:16:03 +0100
parents 6e8f6640e05b
children 3b9f2c82cbae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
106
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * maths.h -- basic maths
ed1a6bb02a78 inventory_dialog: use a small circle as test
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>
106
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
19 #ifndef MLK_CORE_MATHS_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_CORE_MATHS_H
106
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
528
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
22 /**
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
23 * \file maths.h
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
24 * \brief Basic maths
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
25 */
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 288
diff changeset
26
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
27 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
28 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
29 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 288
diff changeset
30
528
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
31 /**
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
32 * Returns non-zero if the coordinates x, y inside the bounding rectangle.
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
33 *
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
34 * \param x the x coordinate
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
35 * \param y the y coordinate
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
36 * \param px rectangle x coordinate
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
37 * \param py rectangle y coordinate
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
38 * \param pw rectangle width
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
39 * \param ph rectangle height
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
40 * \return non-zero if x, y is within pw, ph, px, py
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
41 */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
42 int
528
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
43 mlk_maths_is_boxed(int x, int y, int px, int py, unsigned int pw, unsigned int ph);
106
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
528
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
45 /**
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
46 * Scale a value within two ranges.
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
47 *
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
48 * \param in the value to scale
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
49 * \param old_min old minimum
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
50 * \param old_max old maximum
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
51 * \param new_min new minimum
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
52 * \param new_max new maximum
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
53 * \return scaled value
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
54 */
288
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
55 float
528
95792046d3d2 core: doxygenize maths
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
56 mlk_maths_scale(float in, float old_min, float old_max, float new_min, float new_max);
288
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
57
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
58 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
59 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
60 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 288
diff changeset
61
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
62 #endif /* !MLK_CORE_MATHS_H */