File: al_is_compatible_bitmap.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 (32 lines) | stat: -rw-r--r-- 1,046 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
.TH al_is_compatible_bitmap 3 "" "Allegro reference manual"
.SH NAME
.PP
al_is_compatible_bitmap \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_is_compatible_bitmap(ALLEGRO_BITMAP\ *bitmap)
\f[]
.fi
.SH DESCRIPTION
.PP
D3D and OpenGL allow sharing a texture in a way so it can be used for
multiple windows.
Each ALLEGRO_BITMAP(3) created with al_create_bitmap(3) however is
usually tied to a single ALLEGRO_DISPLAY.
This function can be used to know if the bitmap is compatible with the
given display, even if it is a different display to the one it was
created with.
It returns true if the bitmap is compatible (things like a cached
texture version can be used) and false otherwise (blitting in the
current display will be slow).
.PP
The only time this function is useful is if you are using multiple
windows and need accelerated blitting of the same bitmaps to both.
.PP
Returns true if the bitmap is compatible with the current display, false
otherwise.
If there is no current display, false is returned.