[aea89388] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[7def1747] | 7 | <!-- Editors, update this for new releass as needed -->
|
---|
| 8 | <!ENTITY cogl-minor "1.22">
|
---|
| 9 |
|
---|
| 10 | <!ENTITY cogl-download-http "&gnome-download-http;/cogl/&cogl-minor;/cogl-&cogl-version;.tar.xz">
|
---|
| 11 | <!ENTITY cogl-download-ftp "&gnome-download-ftp;/cogl/&cogl-minor;/cogl-&cogl-version;.tar.xz">
|
---|
[ca4f834] | 12 | <!ENTITY cogl-md5sum "d53b708ca7c4af03d7254e46945d6b33">
|
---|
[7ea83d7] | 13 | <!ENTITY cogl-size "1.6 MB">
|
---|
[ca4f834] | 14 | <!ENTITY cogl-buildsize "64 MB">
|
---|
| 15 | <!ENTITY cogl-time "0.8 SBU (additional 0.4 SBU for tests)">
|
---|
[aea89388] | 16 | ]>
|
---|
| 17 |
|
---|
[ff5df153] | 18 | <sect1 id="cogl" xreflabel="Cogl-&cogl-version;">
|
---|
[aea89388] | 19 | <?dbhtml filename="cogl.html"?>
|
---|
| 20 |
|
---|
| 21 | <sect1info>
|
---|
| 22 | <othername>$LastChangedBy$</othername>
|
---|
| 23 | <date>$Date$</date>
|
---|
| 24 | </sect1info>
|
---|
| 25 |
|
---|
[742b99e] | 26 | <title>Cogl-&cogl-version;</title>
|
---|
[aea89388] | 27 |
|
---|
| 28 | <indexterm zone="cogl">
|
---|
[983fc68] | 29 | <primary sortas="a-Cogl">Cogl</primary>
|
---|
[aea89388] | 30 | </indexterm>
|
---|
| 31 |
|
---|
| 32 | <sect2 role="package">
|
---|
[742b99e] | 33 | <title>Introduction to Cogl</title>
|
---|
[aea89388] | 34 |
|
---|
[a2912ff] | 35 | <para>
|
---|
| 36 | <application>Cogl</application> is a modern 3D graphics API with associated
|
---|
| 37 | utility APIs designed to expose the features of 3D graphics hardware using
|
---|
| 38 | a direct state access API design, as opposed to the state-machine style
|
---|
| 39 | of OpenGL.
|
---|
| 40 | </para>
|
---|
[aea89388] | 41 |
|
---|
[82066b8] | 42 | &lfs83_checked;
|
---|
[aea89388] | 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
[a2912ff] | 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&cogl-download-http;"/>
|
---|
| 49 | </para>
|
---|
[aea89388] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[a2912ff] | 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&cogl-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
[aea89388] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[a2912ff] | 57 | <para>
|
---|
| 58 | Download MD5 sum: &cogl-md5sum;
|
---|
| 59 | </para>
|
---|
[aea89388] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[a2912ff] | 62 | <para>
|
---|
| 63 | Download size: &cogl-size;
|
---|
| 64 | </para>
|
---|
[aea89388] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[a2912ff] | 67 | <para>
|
---|
| 68 | Estimated disk space required: &cogl-buildsize;
|
---|
| 69 | </para>
|
---|
[aea89388] | 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
[a2912ff] | 72 | <para>
|
---|
| 73 | Estimated build time: &cogl-time;
|
---|
| 74 | </para>
|
---|
[aea89388] | 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
[742b99e] | 78 | <bridgehead renderas="sect3">Cogl Dependencies</bridgehead>
|
---|
[aea89388] | 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[742b99e] | 81 | <para role="required">
|
---|
[bed608b0] | 82 | <xref linkend="cairo"/>,
|
---|
[742b99e] | 83 | <xref linkend="gdk-pixbuf"/>,
|
---|
[ca4f834] | 84 | <xref linkend="glu"/>,
|
---|
[bdbc7fa1] | 85 | <xref linkend="mesa"/>,<phrase revision="sysv"> and</phrase>
|
---|
| 86 | <xref linkend="pango"/><phrase revision="systemd">, and
|
---|
| 87 | <xref linkend="wayland"/></phrase>
|
---|
[742b99e] | 88 | </para>
|
---|
[aea89388] | 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[742b99e] | 91 | <para role="recommended">
|
---|
| 92 | <xref linkend="gobject-introspection"/>
|
---|
| 93 | </para>
|
---|
[b9a819c8] | 94 |
|
---|
| 95 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[742b99e] | 96 | <para role="optional">
|
---|
[a27a478] | 97 | <xref linkend="gst10-plugins-base"/>,
|
---|
[7ea83d7] | 98 | <xref linkend="gtk-doc"/>,
|
---|
[bdbc7fa1] | 99 | <xref linkend="sdl"/>,<phrase revision="systemd"> and</phrase>
|
---|
| 100 | <xref linkend="sdl2"/><phrase revision="sysv">, and
|
---|
| 101 | <xref linkend="wayland"/></phrase>
|
---|
[742b99e] | 102 | </para>
|
---|
[aea89388] | 103 |
|
---|
| 104 | <para condition="html" role="usernotes">User Notes:
|
---|
[a2912ff] | 105 | <ulink url="&blfs-wiki;/cogl"/>
|
---|
| 106 | </para>
|
---|
[aea89388] | 107 | </sect2>
|
---|
| 108 |
|
---|
| 109 | <sect2 role="installation">
|
---|
[742b99e] | 110 | <title>Installation of Cogl</title>
|
---|
[ea20da9] | 111 | <!--
|
---|
[83d7e276] | 112 | <note>
|
---|
| 113 | <para>
|
---|
| 114 | This package may occasionally fail when building with multiple
|
---|
| 115 | processors. See <xref linkend="parallel-builds"/> for more
|
---|
| 116 | information.
|
---|
| 117 | </para>
|
---|
| 118 | </note>
|
---|
[ea20da9] | 119 | -->
|
---|
[a2912ff] | 120 | <para>
|
---|
| 121 | Install <application>Cogl</application> by running the following
|
---|
| 122 | commands:
|
---|
| 123 | </para>
|
---|
[aea89388] | 124 |
|
---|
[ea20da9] | 125 | ¶llel_issues;
|
---|
| 126 |
|
---|
[bdbc7fa1] | 127 | <screen revision="sysv"><userinput>sed -i 's/^#if COGL/#ifdef COGL/' cogl/winsys/cogl-winsys-egl.c &&
|
---|
[747db59e] | 128 |
|
---|
| 129 | ./configure --prefix=/usr --enable-gles1 --enable-gles2 &&
|
---|
[aea89388] | 130 | make</userinput></screen>
|
---|
| 131 |
|
---|
[bdbc7fa1] | 132 | <screen revision="systemd"><userinput>sed -i 's/^#if COGL/#ifdef COGL/' cogl/winsys/cogl-winsys-egl.c &&
|
---|
| 133 |
|
---|
| 134 | ./configure --prefix=/usr --enable-gles1 --enable-gles2 \
|
---|
| 135 | --enable-{kms,wayland,xlib}-egl-platform \
|
---|
| 136 | --enable-wayland-egl-server &&
|
---|
| 137 | make</userinput></screen>
|
---|
| 138 |
|
---|
[a2912ff] | 139 | <para>
|
---|
[7ea83d7] | 140 | To test the results, issue: <command>make check</command>. The
|
---|
[ff84517] | 141 | tests should be run from an X terminal on the hardware accelerated
|
---|
| 142 | Xorg Server.
|
---|
[a2912ff] | 143 | </para>
|
---|
[aea89388] | 144 |
|
---|
[a2912ff] | 145 | <para>
|
---|
| 146 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 147 | </para>
|
---|
[aea89388] | 148 |
|
---|
| 149 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 150 |
|
---|
| 151 | </sect2>
|
---|
| 152 |
|
---|
[b9a819c8] | 153 | <sect2 role="commands">
|
---|
| 154 | <title>Command Explanations</title>
|
---|
| 155 |
|
---|
[7ea83d7] | 156 | <para>
|
---|
| 157 | <parameter>--enable-gles1</parameter>: This switch enables support
|
---|
| 158 | for OpenGL ES 1.1.
|
---|
| 159 | </para>
|
---|
| 160 |
|
---|
| 161 | <para>
|
---|
| 162 | <parameter>--enable-gles2</parameter>: This switch enables support
|
---|
| 163 | for OpenGL ES 2.0.
|
---|
| 164 | </para>
|
---|
| 165 |
|
---|
[a27a478] | 166 | <para>
|
---|
[bdbc7fa1] | 167 | <phrase revision="sysv">
|
---|
| 168 | <option>--enable-{kms,wayland,xlib}-egl-platform</option>:</phrase>
|
---|
| 169 | <phrase revision="systemd">
|
---|
| 170 | <parameter>--enable-{kms,wayland,xlib}-egl-platform</parameter>:</phrase>
|
---|
| 171 | These switches enable support for KMS, Wayland and Xlib EGL platforms.
|
---|
| 172 | They are required for <application>GNOME</application> Wayland support.
|
---|
[a27a478] | 173 | </para>
|
---|
| 174 |
|
---|
[bed608b0] | 175 | <para>
|
---|
[bdbc7fa1] | 176 | <phrase revision="sysv">
|
---|
| 177 | <option>--enable-wayland-egl-server</option>:</phrase>
|
---|
| 178 | <phrase revision="systemd">
|
---|
| 179 | <parameter>--enable-wayland-egl-server</parameter>:</phrase> This switch
|
---|
| 180 | enables <application>Cogl</application>'s Wayland Server API which is
|
---|
| 181 | required for <application>GNOME</application> Wayland support.
|
---|
[bed608b0] | 182 | </para>
|
---|
| 183 |
|
---|
| 184 | <para>
|
---|
[bdbc7fa1] | 185 | <option>--enable-cogl-gst</option>: This switch enables gstreamer support.
|
---|
[bed608b0] | 186 | </para>
|
---|
| 187 |
|
---|
[b9a819c8] | 188 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[a2912ff] | 189 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[b9a819c8] | 190 |
|
---|
| 191 | </sect2>
|
---|
| 192 |
|
---|
[aea89388] | 193 | <sect2 role="content">
|
---|
| 194 | <title>Contents</title>
|
---|
| 195 |
|
---|
| 196 | <segmentedlist>
|
---|
[7ea83d7] | 197 | <segtitle>Installed Programs</segtitle>
|
---|
[aea89388] | 198 | <segtitle>Installed Libraries</segtitle>
|
---|
[742b99e] | 199 | <segtitle>Installed Directories</segtitle>
|
---|
[aea89388] | 200 |
|
---|
| 201 | <seglistitem>
|
---|
[0913f48] | 202 | <seg>
|
---|
[7ea83d7] | 203 | None
|
---|
| 204 | </seg>
|
---|
| 205 | <seg>
|
---|
[f3429309] | 206 | libcogl-gles2.so,
|
---|
[b9edd3d5] | 207 | libcogl-pango.so,
|
---|
[f3429309] | 208 | libcogl-path.so, and
|
---|
[a27a478] | 209 | libcogl.so, and optional libraries
|
---|
| 210 | libcogl-gst.so and /usr/lib/gstreamer-1.0/libgstcogl.so
|
---|
[0913f48] | 211 | </seg>
|
---|
| 212 | <seg>
|
---|
[983fc68] | 213 | /usr/include/cogl and
|
---|
| 214 | /usr/share/cogl
|
---|
[0913f48] | 215 | </seg>
|
---|
[aea89388] | 216 | </seglistitem>
|
---|
| 217 | </segmentedlist>
|
---|
| 218 |
|
---|
| 219 | <variablelist>
|
---|
| 220 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 221 | <?dbfo list-presentation="list"?>
|
---|
| 222 | <?dbhtml list-presentation="table"?>
|
---|
| 223 |
|
---|
[7ea83d7] | 224 | <varlistentry id="libcogl-gles2">
|
---|
| 225 | <term><filename class="libraryfile">libcogl-gles2.so</filename></term>
|
---|
| 226 | <listitem>
|
---|
| 227 | <para>
|
---|
| 228 | is the OpenGL ES 2.0 integration library for
|
---|
| 229 | <application>Cogl</application>.
|
---|
| 230 | </para>
|
---|
| 231 | <indexterm zone="cogl libcogl-gles2">
|
---|
| 232 | <primary sortas="c-libcogl-gles2">libcogl-gles2.so</primary>
|
---|
| 233 | </indexterm>
|
---|
| 234 | </listitem>
|
---|
| 235 | </varlistentry>
|
---|
| 236 |
|
---|
[aea89388] | 237 | <varlistentry id="libcogl-pango">
|
---|
[948dc10] | 238 | <term><filename class="libraryfile">libcogl-pango.so</filename></term>
|
---|
[aea89388] | 239 | <listitem>
|
---|
[a2912ff] | 240 | <para>
|
---|
| 241 | is the <application>Pango</application> integration library
|
---|
| 242 | for <application>Cogl</application>.
|
---|
| 243 | </para>
|
---|
[aea89388] | 244 | <indexterm zone="cogl libcogl-pango">
|
---|
| 245 | <primary sortas="c-libcogl-pango">libcogl-pango.so</primary>
|
---|
| 246 | </indexterm>
|
---|
| 247 | </listitem>
|
---|
| 248 | </varlistentry>
|
---|
| 249 |
|
---|
| 250 | <varlistentry id="libcogl">
|
---|
[948dc10] | 251 | <term><filename class="libraryfile">libcogl.so</filename></term>
|
---|
[aea89388] | 252 | <listitem>
|
---|
[a2912ff] | 253 | <para>
|
---|
| 254 | is an object oriented GL/GLES Abstraction/Utility Layer library.
|
---|
| 255 | </para>
|
---|
[aea89388] | 256 | <indexterm zone="cogl libcogl">
|
---|
| 257 | <primary sortas="c-libcogl">libcogl.so</primary>
|
---|
| 258 | </indexterm>
|
---|
| 259 | </listitem>
|
---|
| 260 | </varlistentry>
|
---|
| 261 |
|
---|
| 262 | </variablelist>
|
---|
| 263 |
|
---|
| 264 | </sect2>
|
---|
| 265 |
|
---|
| 266 | </sect1>
|
---|