File: al_set_physfs_file_interface.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (42 lines) | stat: -rw-r--r-- 1,216 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
37
38
39
40
41
42
.TH "al_set_physfs_file_interface" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_set_physfs_file_interface \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_physfs.h>

void\ al_set_physfs_file_interface(void)
\f[]
.fi
.SH DESCRIPTION
.PP
This function sets \f[I]both\f[] the ALLEGRO_FILE_INTERFACE(3) and
ALLEGRO_FS_INTERFACE(3) for the calling thread.
.PP
Subsequent calls to al_fopen(3) on the calling thread will be handled by
PHYSFS_open().
Operations on the files returned by al_fopen(3) will then be performed
through PhysicsFS.
Calls to the Allegro filesystem functions, such as al_read_directory(3)
or al_create_fs_entry(3), on the calling thread will be diverted to
PhysicsFS.
.PP
To remember and restore another file I/O backend, you can use
al_store_state(3)/al_restore_state(3).
.RS
.PP
\f[I]Note:\f[] due to an oversight, this function differs from
al_set_new_file_interface(3) and al_set_standard_file_interface(3) which
only alter the current ALLEGRO_FILE_INTERFACE(3).
.RE
.RS
.PP
\f[I]Note:\f[] PhysFS does not support the text\-mode reading and
writing, which means that Windows\-style newlines will not be preserved.
.RE
.SH SEE ALSO
.PP
al_set_new_file_interface(3).