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 |
|
---|
7 | <!-- Editors, update this for new releases 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">
|
---|
12 | <!ENTITY cogl-md5sum "7dd8b2e24171ef7399f851cea144b569">
|
---|
13 | <!ENTITY cogl-size "1.7 MB">
|
---|
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.-->
|
---|
19 | ]>
|
---|
20 |
|
---|
21 | <sect1 id="cogl" xreflabel="Cogl-&cogl-version;">
|
---|
22 | <?dbhtml filename="cogl.html"?>
|
---|
23 |
|
---|
24 |
|
---|
25 | <title>Cogl-&cogl-version;</title>
|
---|
26 |
|
---|
27 | <indexterm zone="cogl">
|
---|
28 | <primary sortas="a-Cogl">Cogl</primary>
|
---|
29 | </indexterm>
|
---|
30 |
|
---|
31 | <sect2 role="package">
|
---|
32 | <title>Introduction to Cogl</title>
|
---|
33 |
|
---|
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>
|
---|
40 |
|
---|
41 | &lfs120_checked;
|
---|
42 |
|
---|
43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
44 | <itemizedlist spacing="compact">
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download (HTTP): <ulink url="&cogl-download-http;"/>
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download (FTP): <ulink url="&cogl-download-ftp;"/>
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Download MD5 sum: &cogl-md5sum;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Download size: &cogl-size;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Estimated disk space required: &cogl-buildsize;
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>
|
---|
72 | Estimated build time: &cogl-time;
|
---|
73 | </para>
|
---|
74 | </listitem>
|
---|
75 | </itemizedlist>
|
---|
76 |
|
---|
77 | <!-- No longer required with 1.22.8
|
---|
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>
|
---|
87 | -->
|
---|
88 |
|
---|
89 | <bridgehead renderas="sect3">Cogl Dependencies</bridgehead>
|
---|
90 |
|
---|
91 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
92 | <para role="required">
|
---|
93 | <xref linkend="cairo"/>,
|
---|
94 | <xref linkend="gdk-pixbuf"/>,
|
---|
95 | <xref linkend="glu"/>,
|
---|
96 | <xref linkend="mesa"/>,
|
---|
97 | <xref linkend="pango"/>, and
|
---|
98 | <xref linkend="wayland"/>
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
102 | <para role="recommended">
|
---|
103 | <xref linkend="gobject-introspection"/>
|
---|
104 | </para>
|
---|
105 |
|
---|
106 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
107 | <para role="optional">
|
---|
108 | <xref linkend="gst10-plugins-base"/>,
|
---|
109 | <xref linkend="gtk-doc"/>, and
|
---|
110 | <xref linkend="sdl2"/>
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | </sect2>
|
---|
114 |
|
---|
115 | <sect2 role="installation">
|
---|
116 | <title>Installation of Cogl</title>
|
---|
117 |
|
---|
118 | <!--
|
---|
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>
|
---|
124 | -->
|
---|
125 |
|
---|
126 | <para>
|
---|
127 | Install <application>Cogl</application> by running the following
|
---|
128 | commands:
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | ¶llel_issues;
|
---|
132 |
|
---|
133 | <screen><userinput>./configure --prefix=/usr \
|
---|
134 | --enable-gles1 \
|
---|
135 | --enable-gles2 \
|
---|
136 | --enable-{kms,wayland,xlib}-egl-platform \
|
---|
137 | --enable-wayland-egl-server &&
|
---|
138 | make</userinput></screen>
|
---|
139 |
|
---|
140 | <para>
|
---|
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. -->
|
---|
148 | </para>
|
---|
149 |
|
---|
150 | <para>
|
---|
151 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
152 | </para>
|
---|
153 |
|
---|
154 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
155 |
|
---|
156 | </sect2>
|
---|
157 |
|
---|
158 | <sect2 role="commands">
|
---|
159 | <title>Command Explanations</title>
|
---|
160 |
|
---|
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 |
|
---|
171 | <para>
|
---|
172 | <parameter>--enable-{kms,wayland,xlib}-egl-platform</parameter>:
|
---|
173 | These switches enable support for KMS, Wayland and Xlib EGL platforms.
|
---|
174 | They are required for <application>GNOME</application> Wayland support.
|
---|
175 | </para>
|
---|
176 |
|
---|
177 | <para>
|
---|
178 | <parameter>--enable-wayland-egl-server</parameter>: This switch
|
---|
179 | enables <application>Cogl</application>'s Wayland Server API which is
|
---|
180 | required for <application>GNOME</application> Wayland support.
|
---|
181 | </para>
|
---|
182 |
|
---|
183 | <para>
|
---|
184 | <option>--enable-cogl-gst</option>: This switch enables gstreamer support.
|
---|
185 | </para>
|
---|
186 |
|
---|
187 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
188 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
189 |
|
---|
190 | </sect2>
|
---|
191 |
|
---|
192 | <sect2 role="content">
|
---|
193 | <title>Contents</title>
|
---|
194 |
|
---|
195 | <segmentedlist>
|
---|
196 | <segtitle>Installed Programs</segtitle>
|
---|
197 | <segtitle>Installed Libraries</segtitle>
|
---|
198 | <segtitle>Installed Directories</segtitle>
|
---|
199 |
|
---|
200 | <seglistitem>
|
---|
201 | <seg>
|
---|
202 | None
|
---|
203 | </seg>
|
---|
204 | <seg>
|
---|
205 | libcogl-gles2.so,
|
---|
206 | libcogl-pango.so,
|
---|
207 | libcogl-path.so, and
|
---|
208 | libcogl.so, and optional libraries
|
---|
209 | libcogl-gst.so and /usr/lib/gstreamer-1.0/libgstcogl.so
|
---|
210 | </seg>
|
---|
211 | <seg>
|
---|
212 | /usr/include/cogl and
|
---|
213 | /usr/share/cogl
|
---|
214 | </seg>
|
---|
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 |
|
---|
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
|
---|
228 | <application>Cogl</application>
|
---|
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 |
|
---|
236 | <varlistentry id="libcogl-pango">
|
---|
237 | <term><filename class="libraryfile">libcogl-pango.so</filename></term>
|
---|
238 | <listitem>
|
---|
239 | <para>
|
---|
240 | is the <application>Pango</application> integration library
|
---|
241 | for <application>Cogl</application>
|
---|
242 | </para>
|
---|
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">
|
---|
250 | <term><filename class="libraryfile">libcogl.so</filename></term>
|
---|
251 | <listitem>
|
---|
252 | <para>
|
---|
253 | is an object oriented GL/GLES Abstraction/Utility Layer library
|
---|
254 | </para>
|
---|
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>
|
---|