File: al_fixacos.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (36 lines) | stat: -rw-r--r-- 873 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
.TH al_fixacos 3 "" "Allegro reference manual"
.SH NAME
.PP
al_fixacos \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

al_fixed\ al_fixacos(al_fixed\ x);
\f[]
.fi
.SH DESCRIPTION
.PP
This function finds the inverse cosine of a value using a lookup table.
The input value must be a fixed point radian.
The inverse cosine is defined only in the domain from \-1 to 1.
Outside of this input range, the function will set Allegro\[aq]s errno
to EDOM and return zero.
.PP
Example:
.IP
.nf
\f[C]
\ \ \ \ al_fixed\ result;

\ \ \ \ /*\ Sets\ result\ to\ binary\ angle\ 128.\ */
\ \ \ \ result\ =\ al_fixacos(al_itofix(\-1));
\f[]
.fi
.SH RETURN VALUE
.PP
Returns the inverse sine of a fixed point value, measured as fixed point
binary format angle, or zero if the input was out of range.
All return values of this function will be in the range 0 to 128.