File: al_fread16le.3

package info (click to toggle)
allegro5 2%3A5.2.6.0-3%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 24,212 kB
  • sloc: ansic: 125,319; cpp: 15,781; objc: 4,579; python: 2,802; java: 2,254; javascript: 1,204; sh: 1,002; makefile: 51; perl: 37; xml: 25; pascal: 24
file content (28 lines) | stat: -rw-r--r-- 606 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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_fread16le" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_fread16le \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

int16_t\ al_fread16le(ALLEGRO_FILE\ *f)
\f[]
.fi
.SH DESCRIPTION
.PP
Reads a 16\-bit word in little\-endian format (LSB first).
.PP
On success, returns the 16\-bit word.
On failure, returns EOF (\-1).
Since \-1 is also a valid return value, use al_feof(3) to check if the
end of the file was reached prematurely, or al_ferror(3) to check if an
error occurred.
.SH SEE ALSO
.PP
al_fread16be(3)