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