Mercurial > molko

annotate doc/docs/dev/api/core/maths.md @ 288:cc0f02ae9005

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: add maths_scale function
author David Demelier <markand@malikania.fr>
date Thu, 07 Jan 2021 15:50:01 +0100
parents c4da052c0def
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 # Module: maths
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 Synopsis
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ```c
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 #include <core/maths.h>
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 ```
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 Basic maths.
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 ## Functions
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ### maths\_is\_boxed
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 Check if the coordinates `px`, `py` are withing the bounding rectangle specified
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 by `x`, `y`, `w` and `h`.
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ```c
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 bool
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 maths_is_boxed(int x, int y, unsigned int w, unsigned int h, int px, int py)
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 ```
288
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
22
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
23 ### maths\_scale
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
24
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
25 Scale a the value `v` from the range `[omin..omax]` to `[nmin..nmax]`.
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
26
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
27 ```c
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
28 float
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
29 maths_scale(float v, float omin, float omax, float nmin, float nmax)
cc0f02ae9005 core: add maths_scale function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
30 ```