[576a230] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[48b7295] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[86698d8] | 6 |
|
---|
[68ad918] | 7 | <!ENTITY sdl-download-http "http://www.libsdl.org/release/SDL-&sdl-version;.tar.gz">
|
---|
| 8 | <!ENTITY sdl-download-ftp " ">
|
---|
[52b1b8c] | 9 | <!ENTITY sdl-md5sum "9d96df8417572a2afb781a7c4c811a85">
|
---|
| 10 | <!ENTITY sdl-size "3.8 MB">
|
---|
| 11 | <!ENTITY sdl-buildsize "40 MB">
|
---|
[10ee44ef] | 12 | <!ENTITY sdl-time "0.6 SBU">
|
---|
[48b7295] | 13 | ]>
|
---|
[4a21942] | 14 |
|
---|
[68ad918] | 15 | <sect1 id="sdl" xreflabel="SDL-&sdl-version;">
|
---|
[576a230] | 16 | <?dbhtml filename="sdl.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>SDL-&sdl-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="sdl">
|
---|
| 26 | <primary sortas="a-SDL">SDL</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to SDL</title>
|
---|
| 31 |
|
---|
[2eeb8695] | 32 | <para>
|
---|
| 33 | The Simple DirectMedia Layer (<application>SDL</application>
|
---|
| 34 | for short) is a cross-platform library designed to make it easy to write
|
---|
| 35 | multimedia software, such as games and emulators.
|
---|
| 36 | </para>
|
---|
[576a230] | 37 |
|
---|
[c0b9aa94] | 38 | &lfs10_checked;
|
---|
[98d5a95] | 39 |
|
---|
[576a230] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[2eeb8695] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&sdl-download-http;"/>
|
---|
| 45 | </para>
|
---|
[576a230] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[2eeb8695] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&sdl-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[576a230] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[2eeb8695] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &sdl-md5sum;
|
---|
| 55 | </para>
|
---|
[576a230] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[2eeb8695] | 58 | <para>
|
---|
| 59 | Download size: &sdl-size;
|
---|
| 60 | </para>
|
---|
[576a230] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[2eeb8695] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &sdl-buildsize;
|
---|
| 65 | </para>
|
---|
[576a230] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[2eeb8695] | 68 | <para>
|
---|
| 69 | Estimated build time: &sdl-time;
|
---|
| 70 | </para>
|
---|
[576a230] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
[93d50f5] | 74 | <bridgehead renderas="sect3">SDL Dependencies</bridgehead>
|
---|
[576a230] | 75 |
|
---|
[f7a7e27] | 76 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 77 | <para role="recommended">
|
---|
| 78 | <xref linkend="xorg7-lib"/> (if they are not present, the corresponding
|
---|
| 79 | modules are not built)
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
[576a230] | 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e2e42c7] | 83 | <para role="optional">
|
---|
[59a6b63] | 84 | <xref linkend="aalib"/>,
|
---|
[e2e42c7] | 85 | <xref linkend="alsa"/>,
|
---|
[8a33d8cd] | 86 | <xref linkend="glu"/>,
|
---|
[59a6b63] | 87 | <xref linkend="nasm"/>,
|
---|
| 88 | <xref linkend="pulseaudio"/>,
|
---|
[e2e42c7] | 89 | <xref linkend="pth"/>,
|
---|
[59a6b63] | 90 | <xref linkend="x-window-system"/>,
|
---|
[077d95b] | 91 | <ulink url="http://pkgs.fedoraproject.org/repo/pkgs/directfb/">DirectFB</ulink>,
|
---|
[59a6b63] | 92 | <ulink url="http://ibiblio.org/ggicore/">GGI</ulink>,
|
---|
| 93 | <ulink url="http://caca.zoy.org/wiki/libcaca">libcaca</ulink>,
|
---|
| 94 | <ulink url="http://picogui.org/">PicoGUI</ulink>, and
|
---|
[973a31d] | 95 | <ulink url="https://www.svgalib.org/">SVGAlib</ulink>
|
---|
[e2e42c7] | 96 | </para>
|
---|
[576a230] | 97 |
|
---|
[0e2aa08] | 98 | <para condition="html" role="usernotes">User Notes:
|
---|
| 99 | <ulink url="&blfs-wiki;/sdl"/></para>
|
---|
| 100 |
|
---|
[576a230] | 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2 role="installation">
|
---|
| 104 | <title>Installation of SDL</title>
|
---|
| 105 |
|
---|
[2eeb8695] | 106 | <para>
|
---|
| 107 | Install <application>SDL</application> by running the
|
---|
| 108 | following commands:
|
---|
| 109 | </para>
|
---|
[576a230] | 110 |
|
---|
[59a6b63] | 111 | <screen><userinput>sed -e '/_XData32/s:register long:register _Xconst long:' \
|
---|
| 112 | -i src/video/x11/SDL_x11sym.h &&
|
---|
| 113 |
|
---|
| 114 | ./configure --prefix=/usr --disable-static &&
|
---|
[cf67717] | 115 |
|
---|
[576a230] | 116 | make</userinput></screen>
|
---|
| 117 |
|
---|
[2eeb8695] | 118 | <para>
|
---|
| 119 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 120 | </para>
|
---|
[576a230] | 121 |
|
---|
| 122 | <screen role="root"><userinput>make install &&
|
---|
[10ee44ef] | 123 |
|
---|
[932b7e2] | 124 | install -v -m755 -d /usr/share/doc/SDL-&sdl-version;/html &&
|
---|
[98d5a95] | 125 | install -v -m644 docs/html/*.html \
|
---|
[10ee44ef] | 126 | /usr/share/doc/SDL-&sdl-version;/html</userinput></screen>
|
---|
[48b7295] | 127 |
|
---|
[576a230] | 128 | </sect2>
|
---|
[48b7295] | 129 |
|
---|
[4f2f35c6] | 130 | <sect2 role="testing">
|
---|
| 131 | <title>Testing SDL</title>
|
---|
[48b7295] | 132 |
|
---|
[2eeb8695] | 133 | <para>
|
---|
| 134 | If you wish to, test the installation of <application>SDL</application>
|
---|
| 135 | using the included test programs. It is not required to install any of
|
---|
| 136 | the resulting binaries to validate the installation. Issue the following
|
---|
| 137 | commands to build the test programs:
|
---|
| 138 | </para>
|
---|
[48c17bf2] | 139 |
|
---|
[e7d4e823] | 140 | <screen remap="test"><userinput>cd test &&
|
---|
[48c17bf2] | 141 | ./configure &&
|
---|
[576a230] | 142 | make</userinput></screen>
|
---|
[48c17bf2] | 143 |
|
---|
[2eeb8695] | 144 | <para>
|
---|
| 145 | You'll need to manually run all the test programs (they are listed in
|
---|
| 146 | the <filename>README</filename> file in this directory). Many of them
|
---|
| 147 | will need to be manually killed, and you'll need to turn your speakers
|
---|
| 148 | on with the volume at a suitable level.
|
---|
| 149 | </para>
|
---|
[5886225] | 150 |
|
---|
| 151 | </sect2>
|
---|
| 152 |
|
---|
| 153 | <sect2 role="commands">
|
---|
| 154 | <title>Command Explanations</title>
|
---|
| 155 |
|
---|
[2eeb8695] | 156 | <para>
|
---|
| 157 | <command>sed -e ...</command>: This command fixes compilation with
|
---|
| 158 | libX11-1.6.0 and later.
|
---|
| 159 | </para>
|
---|
[46efb87] | 160 |
|
---|
[66d82600] | 161 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 162 | href="../../xincludes/static-libraries.xml"/>
|
---|
[576a230] | 163 |
|
---|
[2eeb8695] | 164 | <para>
|
---|
| 165 | <option>--disable-alsa-shared</option>: This switch disables
|
---|
| 166 | dynamically loading ALSA shared libraries.
|
---|
| 167 | </para>
|
---|
[59a6b63] | 168 |
|
---|
[2eeb8695] | 169 | <para>
|
---|
| 170 | <option>--disable-sdl-dlopen</option>: This switch disables using
|
---|
| 171 | dlopen for shared object loading. Loading image backend libraries like
|
---|
| 172 | libpng dynamically on the fly does not work.
|
---|
| 173 | </para>
|
---|
[59a6b63] | 174 |
|
---|
[2eeb8695] | 175 | <para>
|
---|
| 176 | <option>--disable-x11-shared</option>: This switch disables
|
---|
| 177 | dynamically loading X11 shared libraries.
|
---|
| 178 | </para>
|
---|
[9eebf97] | 179 |
|
---|
[576a230] | 180 | </sect2>
|
---|
| 181 |
|
---|
| 182 | <sect2 role="configuration">
|
---|
| 183 | <title>Configuring SDL</title>
|
---|
| 184 |
|
---|
| 185 | <sect3>
|
---|
| 186 | <title>Configuration Information</title>
|
---|
[48c17bf2] | 187 |
|
---|
[e05cd03f] | 188 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[ebabf24] | 189 | href="../../xincludes/lib-config.xml"/>
|
---|
[48b7295] | 190 |
|
---|
[576a230] | 191 | </sect3>
|
---|
[48b7295] | 192 |
|
---|
[576a230] | 193 | </sect2>
|
---|
[48b7295] | 194 |
|
---|
[576a230] | 195 | <sect2 role="content">
|
---|
| 196 | <title>Contents</title>
|
---|
[48b7295] | 197 |
|
---|
[576a230] | 198 | <segmentedlist>
|
---|
| 199 | <segtitle>Installed Program</segtitle>
|
---|
| 200 | <segtitle>Installed Libraries</segtitle>
|
---|
| 201 | <segtitle>Installed Directories</segtitle>
|
---|
[d7ecaa6] | 202 |
|
---|
[576a230] | 203 | <seglistitem>
|
---|
| 204 | <seg>sdl-config</seg>
|
---|
[66d82600] | 205 | <seg>libSDL.so and libSDLmain.a</seg>
|
---|
[576a230] | 206 | <seg>/usr/include/SDL and /usr/share/doc/SDL-&sdl-version;</seg>
|
---|
| 207 | </seglistitem>
|
---|
| 208 | </segmentedlist>
|
---|
[d7ecaa6] | 209 |
|
---|
[576a230] | 210 | <variablelist>
|
---|
| 211 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 212 | <?dbfo list-presentation="list"?>
|
---|
| 213 | <?dbhtml list-presentation="table"?>
|
---|
[d7ecaa6] | 214 |
|
---|
[576a230] | 215 | <varlistentry id="sdl-config">
|
---|
| 216 | <term><command>sdl-config</command></term>
|
---|
| 217 | <listitem>
|
---|
[2eeb8695] | 218 | <para>
|
---|
| 219 | determines the compile and linker flags that should be used to
|
---|
| 220 | compile and link programs that use
|
---|
| 221 | <filename class='libraryfile'>libSDL</filename>.
|
---|
| 222 | </para>
|
---|
[576a230] | 223 | <indexterm zone="sdl sdl-config">
|
---|
| 224 | <primary sortas="b-sdl-config">sdl-config</primary>
|
---|
| 225 | </indexterm>
|
---|
| 226 | </listitem>
|
---|
| 227 | </varlistentry>
|
---|
| 228 |
|
---|
| 229 | <varlistentry id="libsdl">
|
---|
[66d82600] | 230 | <term><filename class='libraryfile'>libSDL.so</filename></term>
|
---|
[576a230] | 231 | <listitem>
|
---|
[2eeb8695] | 232 | <para>
|
---|
| 233 | contains functions that provide low level access to audio,
|
---|
| 234 | keyboard, mouse, joystick, 3D hardware via OpenGL, and
|
---|
| 235 | 2D frame buffer across multiple platforms.
|
---|
| 236 | </para>
|
---|
[576a230] | 237 | <indexterm zone="sdl libsdl">
|
---|
[66d82600] | 238 | <primary sortas="c-libsdl">libSDL.so</primary>
|
---|
[576a230] | 239 | </indexterm>
|
---|
| 240 | </listitem>
|
---|
| 241 | </varlistentry>
|
---|
[d7ecaa6] | 242 |
|
---|
[576a230] | 243 | </variablelist>
|
---|
[48b7295] | 244 |
|
---|
[576a230] | 245 | </sect2>
|
---|
[f45b1953] | 246 |
|
---|
| 247 | </sect1>
|
---|