File: al_get_display_mode.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 (26 lines) | stat: -rw-r--r-- 730 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
.TH al_get_display_mode 3 "" "Allegro reference manual"
.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)