[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 |
|
---|
[2fc9e1d] | 7 | <!ENTITY cogl-download-http "&gnome-download-http;/cogl/1.18/cogl-&cogl-version;.tar.xz">
|
---|
| 8 | <!ENTITY cogl-download-ftp "&gnome-download-ftp;/cogl/1.18/cogl-&cogl-version;.tar.xz">
|
---|
[b9edd3d5] | 9 | <!ENTITY cogl-md5sum "952155d526d35f297737266408e842b5">
|
---|
[7ea83d7] | 10 | <!ENTITY cogl-size "1.6 MB">
|
---|
[b9edd3d5] | 11 | <!ENTITY cogl-buildsize "50 MB">
|
---|
| 12 | <!ENTITY cogl-time "0.7 SBU">
|
---|
[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 |
|
---|
[3cd08693] | 39 | &lfs75_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">
|
---|
| 79 | <xref linkend="gdk-pixbuf"/>,
|
---|
[773db87] | 80 | <xref linkend="mesalib"/>, and
|
---|
[742b99e] | 81 | <xref linkend="pango"/>
|
---|
| 82 | </para>
|
---|
[aea89388] | 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[742b99e] | 85 | <para role="recommended">
|
---|
[d8ada13] | 86 | <xref linkend="gobject-introspection"/> and
|
---|
| 87 | <xref linkend="wayland"/>
|
---|
[742b99e] | 88 | </para>
|
---|
[b9a819c8] | 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[742b99e] | 91 | <para role="optional">
|
---|
[a27a478] | 92 | <xref linkend="gst10-plugins-base"/>,
|
---|
[7ea83d7] | 93 | <xref linkend="gtk-doc"/>,
|
---|
[d8ada13] | 94 | <xref linkend="sdl"/>, and
|
---|
| 95 | <ulink url="http://www.libsdl.org/tmp/release/">SDL2</ulink>
|
---|
[742b99e] | 96 | </para>
|
---|
[aea89388] | 97 |
|
---|
| 98 | <para condition="html" role="usernotes">User Notes:
|
---|
[a2912ff] | 99 | <ulink url="&blfs-wiki;/cogl"/>
|
---|
| 100 | </para>
|
---|
[aea89388] | 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2 role="installation">
|
---|
[742b99e] | 104 | <title>Installation of Cogl</title>
|
---|
[aea89388] | 105 |
|
---|
[a2912ff] | 106 | <para>
|
---|
| 107 | Install <application>Cogl</application> by running the following
|
---|
| 108 | commands:
|
---|
| 109 | </para>
|
---|
[aea89388] | 110 |
|
---|
[d8ada13] | 111 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 112 | --enable-gles1 \
|
---|
| 113 | --enable-gles2 \
|
---|
| 114 | --enable-kms-egl-platform \
|
---|
| 115 | --enable-wayland-egl-platform \
|
---|
| 116 | --enable-xlib-egl-platform \
|
---|
| 117 | --enable-wayland-egl-server &&
|
---|
[aea89388] | 118 | make</userinput></screen>
|
---|
| 119 |
|
---|
[a2912ff] | 120 | <para>
|
---|
[7ea83d7] | 121 | To test the results, issue: <command>make check</command>. The
|
---|
[ff84517] | 122 | tests should be run from an X terminal on the hardware accelerated
|
---|
| 123 | Xorg Server.
|
---|
[a2912ff] | 124 | </para>
|
---|
[aea89388] | 125 |
|
---|
[a2912ff] | 126 | <para>
|
---|
| 127 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 128 | </para>
|
---|
[aea89388] | 129 |
|
---|
| 130 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 131 |
|
---|
| 132 | </sect2>
|
---|
| 133 |
|
---|
[b9a819c8] | 134 | <sect2 role="commands">
|
---|
| 135 | <title>Command Explanations</title>
|
---|
| 136 |
|
---|
[7ea83d7] | 137 | <para>
|
---|
| 138 | <parameter>--enable-gles1</parameter>: This switch enables support
|
---|
| 139 | for OpenGL ES 1.1.
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
| 142 | <para>
|
---|
| 143 | <parameter>--enable-gles2</parameter>: This switch enables support
|
---|
| 144 | for OpenGL ES 2.0.
|
---|
| 145 | </para>
|
---|
| 146 |
|
---|
[d8ada13] | 147 | <para>
|
---|
| 148 | <parameter>--enable-*-egl-platform</parameter>: This switch enables
|
---|
| 149 | support for KMS, Wayland and Xlib EGL platforms. They are required
|
---|
| 150 | for <application>GNOME</application> Wayland support.
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | <para>
|
---|
| 154 | <parameter>--enable-wayland-egl-server</parameter>: This switch
|
---|
| 155 | enables <application>Cogl</application>'s Wayland Server API
|
---|
| 156 | which is required for <application>GNOME</application> Wayland
|
---|
| 157 | support.
|
---|
| 158 | </para>
|
---|
| 159 |
|
---|
[a27a478] | 160 | <para>
|
---|
| 161 | <option>--enable-cogl-gst</option>: This switch enables gstreamer support.
|
---|
| 162 | </para>
|
---|
| 163 |
|
---|
[b9a819c8] | 164 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[a2912ff] | 165 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[b9a819c8] | 166 |
|
---|
| 167 | </sect2>
|
---|
| 168 |
|
---|
[aea89388] | 169 | <sect2 role="content">
|
---|
| 170 | <title>Contents</title>
|
---|
| 171 |
|
---|
| 172 | <segmentedlist>
|
---|
[7ea83d7] | 173 | <segtitle>Installed Programs</segtitle>
|
---|
[aea89388] | 174 | <segtitle>Installed Libraries</segtitle>
|
---|
[742b99e] | 175 | <segtitle>Installed Directories</segtitle>
|
---|
[aea89388] | 176 |
|
---|
| 177 | <seglistitem>
|
---|
[0913f48] | 178 | <seg>
|
---|
[7ea83d7] | 179 | None
|
---|
| 180 | </seg>
|
---|
| 181 | <seg>
|
---|
[773db87] | 182 | libcogl-gles2.so,
|
---|
[b9edd3d5] | 183 | libcogl-pango.so,
|
---|
| 184 | libcogl-path.so, and
|
---|
[a27a478] | 185 | libcogl.so, and optional libraries
|
---|
| 186 | libcogl-gst.so and /usr/lib/gstreamer-1.0/libgstcogl.so
|
---|
[0913f48] | 187 | </seg>
|
---|
| 188 | <seg>
|
---|
[983fc68] | 189 | /usr/include/cogl and
|
---|
| 190 | /usr/share/cogl
|
---|
[0913f48] | 191 | </seg>
|
---|
[aea89388] | 192 | </seglistitem>
|
---|
| 193 | </segmentedlist>
|
---|
| 194 |
|
---|
| 195 | <variablelist>
|
---|
| 196 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 197 | <?dbfo list-presentation="list"?>
|
---|
| 198 | <?dbhtml list-presentation="table"?>
|
---|
| 199 |
|
---|
[7ea83d7] | 200 | <varlistentry id="libcogl-gles2">
|
---|
| 201 | <term><filename class="libraryfile">libcogl-gles2.so</filename></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>
|
---|
| 204 | is the OpenGL ES 2.0 integration library for
|
---|
| 205 | <application>Cogl</application>.
|
---|
| 206 | </para>
|
---|
| 207 | <indexterm zone="cogl libcogl-gles2">
|
---|
| 208 | <primary sortas="c-libcogl-gles2">libcogl-gles2.so</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
[aea89388] | 213 | <varlistentry id="libcogl-pango">
|
---|
[948dc10] | 214 | <term><filename class="libraryfile">libcogl-pango.so</filename></term>
|
---|
[aea89388] | 215 | <listitem>
|
---|
[a2912ff] | 216 | <para>
|
---|
| 217 | is the <application>Pango</application> integration library
|
---|
| 218 | for <application>Cogl</application>.
|
---|
| 219 | </para>
|
---|
[aea89388] | 220 | <indexterm zone="cogl libcogl-pango">
|
---|
| 221 | <primary sortas="c-libcogl-pango">libcogl-pango.so</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
| 225 |
|
---|
| 226 | <varlistentry id="libcogl">
|
---|
[948dc10] | 227 | <term><filename class="libraryfile">libcogl.so</filename></term>
|
---|
[aea89388] | 228 | <listitem>
|
---|
[a2912ff] | 229 | <para>
|
---|
| 230 | is an object oriented GL/GLES Abstraction/Utility Layer library.
|
---|
| 231 | </para>
|
---|
[aea89388] | 232 | <indexterm zone="cogl libcogl">
|
---|
| 233 | <primary sortas="c-libcogl">libcogl.so</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 |
|
---|
| 238 | </variablelist>
|
---|
| 239 |
|
---|
| 240 | </sect2>
|
---|
| 241 |
|
---|
| 242 | </sect1>
|
---|