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