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