home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_CD.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.3 KB  |  90 lines
  1. <!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
  2. <!-- available at http://polyglotman.sourceforge.net/ -->
  3.  
  4. <html>
  5. <head>
  6. <title>"SDL_CD"("3") manual page</title>
  7. </head>
  8. <body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
  9. <a href='#toc'>Table of Contents</a><p>
  10.  
  11. <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12. SDL_CD- CDROM Drive Information 
  13. <h2><a name='sect1' href='#toc1'>Structure Definition</a></h2>
  14. <p>
  15. <br>
  16. <pre>CWtypedef struct{
  17.   int id;
  18.   CDstatus status;
  19.   int numtracks;
  20.   int cur_track;
  21.   int cur_frame;
  22.   SDL_CDtrack track[SDL_MAX_TRACKS+1];
  23. } SDL_CD;
  24. </pre><p>
  25.  
  26. <h2><a name='sect2' href='#toc2'>Structure Data</a></h2>
  27.  
  28. <dl>
  29.  
  30. <dt><b>id</b> </dt>
  31. <dd>Private drive identifier </dd>
  32.  
  33. <dt><b>status</b> </dt>
  34. <dd>Drive <i>status</i> </dd>
  35.  
  36. <dt><b>numtracks</b>
  37. </dt>
  38. <dd>Number of tracks on the CD </dd>
  39.  
  40. <dt><b>cur_track</b> </dt>
  41. <dd>Current track </dd>
  42.  
  43. <dt><b>cur_frame</b> </dt>
  44. <dd>Current frame
  45. offset within the track </dd>
  46.  
  47. <dt><b>track</b>[SDL_MAX_TRACKS+1] </dt>
  48. <dd>Array of track descriptions.
  49. (see <i><b>SDL_CDtrack</b></i>) </dd>
  50. </dl>
  51.  
  52. <h2><a name='sect3' href='#toc3'>Description</a></h2>
  53. <p>
  54. An <b>SDL_CD</b> structure is returned by <i><b>SDL_CDOpen</b></i>.
  55. It represents an opened CDROM device and stores information on the layout
  56. of the tracks on the disc. <p>
  57. A frame is the base data unit of a CD. <b>CD_FPS</b>
  58. frames is equal to 1 second of music. SDL provides two macros for converting
  59. between time and frames: <b>FRAMES_TO_MSF(f, M,S,F)</b> and <b>MSF_TO_FRAMES</b>. 
  60. <h2><a name='sect4' href='#toc4'>Examples</a></h2>
  61. <p>
  62. <br>
  63. <pre>CWint min, sec, frame;
  64. int frame_offset;
  65. FRAMES_TO_MSF(cdrom->cur_frame, &min, &sec, &frame);
  66. printf("Current Position: %d minutes, %d seconds, %d frames
  67. ", min, sec, frame);
  68. frame_offset=MSF_TO_FRAMES(min, sec, frame);
  69. </pre><p>
  70.  
  71. <h2><a name='sect5' href='#toc5'>See Also</a></h2>
  72. <p>
  73. <i><b>SDL_CDOpen</b></i>, <i><b>SDL_CDtrack</b></i> 
  74. <!--
  75.   
  76.  <p>
  77.  
  78. <hr><p>
  79. <a name='toc'><b>Table of Contents</b></a><p>
  80. <ul>
  81. <li><a name='toc0' href='#sect0'>Name</a></li>
  82. <li><a name='toc1' href='#sect1'>Structure Definition</a></li>
  83. <li><a name='toc2' href='#sect2'>Structure Data</a></li>
  84. <li><a name='toc3' href='#sect3'>Description</a></li>
  85. <li><a name='toc4' href='#sect4'>Examples</a></li>
  86. <li><a name='toc5' href='#sect5'>See Also</a></li>
  87. </ul>
  88. </body>
  89. </html>
  90.