aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_CDStatus.3
diff options
context:
space:
mode:
authorSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
committerSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
commita546c7006355a7bd1df4267ee53d0bfa2c017c8c (patch)
tree01be0bf6c0d6968e1468ec9661fd52110f9b05a7 /distrib/sdl-1.2.15/docs/man3/SDL_CDStatus.3
parentbaf3d7830396202df5cc47bd7bcee109c319cdb3 (diff)
parent0f809250987b64f491bd3b4b73c0f0d33036a786 (diff)
downloadexternal_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.zip
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.gz
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.bz2
Merge branch 'jb-mr1-release' of https://android.googlesource.com/platform/external/qemu into mr1-staging
Change-Id: I8a4a71ac65b08e6e17f26c942f67a15b85211115
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_CDStatus.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_CDStatus.359
1 files changed, 59 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_CDStatus.3 b/distrib/sdl-1.2.15/docs/man3/SDL_CDStatus.3
new file mode 100644
index 0000000..77eed72
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_CDStatus.3
@@ -0,0 +1,59 @@
+.TH "SDL_CDStatus" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_CDStatus \- Returns the current status of the given drive\&.
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBCDstatus \fBSDL_CDStatus\fP\fR(\fBSDL_CD *cdrom\fR);
+\fB/* Given a status, returns true if there\&'s a disk in the drive */
+#define CD_INDRIVE(status) ((int)status > 0)
+.SH "DESCRIPTION"
+.PP
+This function returns the current status of the given drive\&. Status is described like so:
+.PP
+.nf
+\f(CWtypedef enum {
+ CD_TRAYEMPTY,
+ CD_STOPPED,
+ CD_PLAYING,
+ CD_PAUSED,
+ CD_ERROR = -1
+} CDstatus;\fR
+.fi
+.PP
+.PP
+If the drive has a CD in it, the table of contents of the CD and current play position of the CD will be stored in the SDL_CD structure\&.
+.PP
+The macro \fBCD_INDRIVE\fP is provided for convenience, and given a status returns true if there\&'s a disk in the drive\&.
+.PP
+.RS
+\fBNote:
+.PP
+\fBSDL_CDStatus\fP also updates the \fI\fBSDL_CD\fR\fR structure passed to it\&.
+.RE
+.SH "EXAMPLE"
+.PP
+.nf
+\f(CWint playTrack(int track)
+{
+ int playing = 0;
+
+ if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) {
+ /* clamp to the actual number of tracks on the CD */
+ if (track >= cdrom->numtracks) {
+ track = cdrom->numtracks-1;
+ }
+
+ if ( SDL_CDPlayTracks(cdrom, track, 0, 1, 0) == 0 ) {
+ playing = 1;
+ }
+ }
+ return playing;
+}\fR
+.fi
+.PP
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_CD\fP\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58