updated docs
[sdlgit/SDL-Site.git] / pages / SDL-Version.html-inc
1 <div class="pod">
2 <!-- INDEX START -->
3 <h3 id="TOP">Index</h3>
4
5 <ul><li><a href="#NAME">NAME</a></li>
6 <li><a href="#CATEGORY">CATEGORY</a></li>
7 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
8 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
9 <li><a href="#METHODS">METHODS</a>
10 <ul><li><a href="#major">major</a></li>
11 <li><a href="#minor">minor</a></li>
12 <li><a href="#patch">patch</a></li>
13 </ul>
14 </li>
15 <li><a href="#AUTHORS">AUTHORS</a>
16 </li>
17 </ul><hr />
18 <!-- INDEX END -->
19
20 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
21 <div id="NAME_CONTENT">
22 <p>SDL::Version - SDL Bindings for structure SDL_Version</p>
23
24 </div>
25 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
26 <div id="CATEGORY_CONTENT">
27 <p>Core, Structure</p>
28
29 </div>
30 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
31 <div id="SYNOPSIS_CONTENT">
32 <pre> use SDL;
33  use SDL::Version;
34
35  # print compile-time version
36  printf(&quot;SDL::version is %d.%d.%d\n&quot;, SDL::version-&gt;major,
37                                       SDL::version-&gt;minor,
38                                       SDL::version-&gt;patch);
39
40  # print linked version
41  printf(&quot;SDL::linked_version is %d.%d.%d\n&quot;, SDL::linked_version-&gt;major,
42                                              SDL::linked_version-&gt;minor,
43                                              SDL::linked_version-&gt;patch);
44
45 </pre>
46
47 </div>
48 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
49 <div id="DESCRIPTION_CONTENT">
50 <p>The <code>SDL::Version</code> structure is used by the <code>SDL::linked_version</code> function and the <code>SDL::version</code> macro.
51 The <code>SDL::linked_version</code> function returns the link-time SDL version whereas <code>SDL::version</code> returns the compile-time SDL version.
52 <strong>Note:</strong> This is the SDL version, not the SDL_Perl version.
53 The SDL_Perl version is in <code>$SDL::VERSION</code>.</p>
54
55 </div>
56 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
57 <div id="METHODS_CONTENT">
58
59 </div>
60 <h2 id="major">major</h2>
61 <div id="major_CONTENT">
62 <p>Returns the major version number.</p>
63
64 </div>
65 <h2 id="minor">minor</h2>
66 <div id="minor_CONTENT">
67 <p>Returns the minor version number.</p>
68
69 </div>
70 <h2 id="patch">patch</h2>
71 <div id="patch_CONTENT">
72 <p>Returns the patch version number.</p>
73
74 </div>
75 <h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
76 <div id="AUTHORS_CONTENT">
77 <p>See <b>AUTHORS</b> in <cite>SDL</cite>.</p>
78
79 </div>
80 </div>