File: al_get_display_mode.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 (29 lines) | stat: -rw-r--r-- 792 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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_get_display_mode" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_get_display_mode \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_DISPLAY_MODE\ *al_get_display_mode(int\ index,\ ALLEGRO_DISPLAY_MODE\ *mode)
\f[]
.fi
.SH DESCRIPTION
.PP
Retrieves a fullscreen mode.
Display parameters should not be changed between a call of
al_get_num_display_modes(3) and al_get_display_mode(3).
index must be between 0 and the number returned from
al_get_num_display_modes\-1.
mode must be an allocated ALLEGRO_DISPLAY_MODE structure.
This function will return NULL on failure, and the mode parameter that
was passed in on success.
.SH SEE ALSO
.PP
ALLEGRO_DISPLAY_MODE(3), al_get_num_display_modes(3)