misc/builddeps/win64/sdl/share/man/man3/SDL_CD.3

   1 .TH "SDL_CD" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
   2 .SH "NAME"
   3 SDL_CD \- CDROM Drive Information
   4 .SH "STRUCTURE DEFINITION"
   5 .PP
   6 .nf
   7 \f(CWtypedef struct{
   8   int id;
   9   CDstatus status;
  10   int numtracks;
  11   int cur_track;
  12   int cur_frame;
  13   SDL_CDtrack track[SDL_MAX_TRACKS+1];
  14 } SDL_CD;\fR
  15 .fi
  16 .PP
  17 .SH "STRUCTURE DATA"
  18 .TP 20
  19 \fBid\fR
  20 Private drive identifier
  21 .TP 20
  22 \fBstatus\fR
  23 Drive \fIstatus\fR
  24 .TP 20
  25 \fBnumtracks\fR
  26 Number of tracks on the CD
  27 .TP 20
  28 \fBcur_track\fR
  29 Current track
  30 .TP 20
  31 \fBcur_frame\fR
  32 Current frame offset within the track
  33 .TP 20
  34 \fBtrack\fR[SDL_MAX_TRACKS+1]
  35 Array of track descriptions\&. (see \fI\fBSDL_CDtrack\fR\fR)
  36 .SH "DESCRIPTION"
  37 .PP
  38 An \fBSDL_CD\fR structure is returned by \fI\fBSDL_CDOpen\fP\fR\&. It represents an opened CDROM device and stores information on the layout of the tracks on the disc\&.
  39 .PP
  40 A frame is the base data unit of a CD\&. \fBCD_FPS\fP frames is equal to 1 second of music\&. SDL provides two macros for converting between time and frames: \fBFRAMES_TO_MSF(f, M,S,F)\fP and \fBMSF_TO_FRAMES\fP\&.
  41 .SH "EXAMPLES"
  42 .PP
  43 .nf
  44 \f(CWint min, sec, frame;
  45 int frame_offset;
  46
  47 FRAMES_TO_MSF(cdrom->cur_frame, &min, &sec, &frame);
  48 printf("Current Position: %d minutes, %d seconds, %d frames
  49 ", min, sec, frame);
  50
  51 frame_offset=MSF_TO_FRAMES(min, sec, frame);\fR
  52 .fi
  53 .PP
  54 .SH "SEE ALSO"
  55 .PP
  56 \fI\fBSDL_CDOpen\fP\fR, \fI\fBSDL_CDtrack\fR\fR
  57 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58