1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 | <!ENTITY glslang-download-http "https://github.com/KhronosGroup/glslang/archive/&glslang-version;/glslang-&glslang-version;.tar.gz">
|
---|
8 | <!ENTITY glslang-download-ftp " ">
|
---|
9 | <!ENTITY glslang-md5sum "732b6d4f6ae0bad942ffa820d12b1f4b">
|
---|
10 | <!ENTITY glslang-size "3.7 MB">
|
---|
11 | <!ENTITY glslang-buildsize "165 MB (with tests)">
|
---|
12 | <!ENTITY glslang-time "0.3 SBU (with parallelism=4; with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="glslang" xreflabel="Glslang-&glslang-version;">
|
---|
16 | <?dbhtml filename="glslang.html"?>
|
---|
17 |
|
---|
18 | <title>Glslang-&glslang-version;</title>
|
---|
19 |
|
---|
20 | <indexterm zone="glslang">
|
---|
21 | <primary sortas="a-glslang">Glslang</primary>
|
---|
22 | </indexterm>
|
---|
23 |
|
---|
24 | <sect2 role="package">
|
---|
25 | <title>Introduction to Glslang</title>
|
---|
26 |
|
---|
27 | <para>
|
---|
28 | The <application>Glslang</application> package contains an frontend and
|
---|
29 | validator for OpenGL, OpenGL ES, and Vulkan shaders.
|
---|
30 | </para>
|
---|
31 |
|
---|
32 | &lfs122_checked;
|
---|
33 |
|
---|
34 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
35 | <itemizedlist spacing="compact">
|
---|
36 | <listitem>
|
---|
37 | <para>
|
---|
38 | Download (HTTP): <ulink url="&glslang-download-http;"/>
|
---|
39 | </para>
|
---|
40 | </listitem>
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (FTP): <ulink url="&glslang-download-ftp;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download MD5 sum: &glslang-md5sum;
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download size: &glslang-size;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Estimated disk space required: &glslang-buildsize;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated build time: &glslang-time;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | </itemizedlist>
|
---|
67 |
|
---|
68 | <bridgehead renderas="sect3">Glslang Dependencies</bridgehead>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
71 | <para role="required">
|
---|
72 | <xref linkend="cmake"/> and
|
---|
73 | <xref linkend="spirv-tools"/>
|
---|
74 | </para>
|
---|
75 |
|
---|
76 | </sect2>
|
---|
77 |
|
---|
78 | <sect2 role="installation">
|
---|
79 | <title>Installation of Glslang</title>
|
---|
80 |
|
---|
81 | <para>
|
---|
82 | Install <application>Glslang</application> by running the following
|
---|
83 | commands:
|
---|
84 | </para>
|
---|
85 |
|
---|
86 | <screen><userinput>mkdir build &&
|
---|
87 | cd build &&
|
---|
88 |
|
---|
89 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
90 | -D CMAKE_BUILD_TYPE=Release \
|
---|
91 | -D ALLOW_EXTERNAL_SPIRV_TOOLS=ON \
|
---|
92 | -D BUILD_SHARED_LIBS=ON \
|
---|
93 | -D GLSLANG_TESTS=ON \
|
---|
94 | -G Ninja .. &&
|
---|
95 | ninja</userinput></screen>
|
---|
96 |
|
---|
97 | <para>
|
---|
98 | To test the results, issue: <command>ninja test</command>.
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <para>
|
---|
102 | Now, as the &root; user:
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
106 |
|
---|
107 | </sect2>
|
---|
108 |
|
---|
109 | <sect2 role="commands">
|
---|
110 | <title>Command Explanations</title>
|
---|
111 |
|
---|
112 | <para>
|
---|
113 | <parameter>-D ALLOW_EXTERNAL_SPIRV_TOOLS=ON</parameter>: This switch allows
|
---|
114 | the build system to use the system-installed copy of
|
---|
115 | <xref linkend="spirv-tools" role="nodep"/>, instead of downloading and
|
---|
116 | installing it's own copy.
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <para>
|
---|
120 | <parameter>-D BUILD_SHARED_LIBS=ON</parameter>: This switch builds shared
|
---|
121 | versions of the libraries, and does not install static versions of them.
|
---|
122 | </para>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | <parameter>-D GLSLANG_TESTS=ON</parameter>: This switch builds the
|
---|
126 | tests for the package.
|
---|
127 | </para>
|
---|
128 |
|
---|
129 | </sect2>
|
---|
130 |
|
---|
131 | <sect2 role="content">
|
---|
132 | <title>Contents</title>
|
---|
133 |
|
---|
134 | <segmentedlist>
|
---|
135 | <segtitle>Installed Programs</segtitle>
|
---|
136 | <segtitle>Installed Libraries</segtitle>
|
---|
137 | <segtitle>Installed Directories</segtitle>
|
---|
138 |
|
---|
139 | <seglistitem>
|
---|
140 | <seg>
|
---|
141 | glslang,
|
---|
142 | glslang-validator (symlink to glslang), and
|
---|
143 | spirv-remap
|
---|
144 | </seg>
|
---|
145 | <seg>
|
---|
146 | libglslang.so,
|
---|
147 | libglslang-default-resource-limits.so,
|
---|
148 | libSPIRV.so, and
|
---|
149 | libSPVRemapper.so
|
---|
150 | </seg>
|
---|
151 | <seg>
|
---|
152 | /usr/include/glslang and
|
---|
153 | /usr/lib/cmake/glslang
|
---|
154 | </seg>
|
---|
155 | </seglistitem>
|
---|
156 | </segmentedlist>
|
---|
157 |
|
---|
158 | <variablelist>
|
---|
159 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
160 | <?dbfo list-presentation="list"?>
|
---|
161 | <?dbhtml list-presentation="table"?>
|
---|
162 |
|
---|
163 | <varlistentry id="glslang-prog">
|
---|
164 | <term><command>glslang</command></term>
|
---|
165 | <listitem>
|
---|
166 | <para>
|
---|
167 | provides a front end and validator for OpenGL, OpenGL ES, and
|
---|
168 | Vulkan shaders
|
---|
169 | </para>
|
---|
170 | <indexterm zone="glslang glslang-prog">
|
---|
171 | <primary sortas="b-glslang">glslang</primary>
|
---|
172 | </indexterm>
|
---|
173 | </listitem>
|
---|
174 | </varlistentry>
|
---|
175 |
|
---|
176 | <varlistentry id="libglslang">
|
---|
177 | <term><filename class="libraryfile">libglslang.so</filename></term>
|
---|
178 | <listitem>
|
---|
179 | <para>
|
---|
180 | contains functions that provide a front-end and validator for
|
---|
181 | OpenGL, OpenGL ES, and Vulkan shaders to other programs
|
---|
182 | </para>
|
---|
183 | <indexterm zone="glslang libglslang">
|
---|
184 | <primary sortas="c-libglslang">libglslang.so</primary>
|
---|
185 | </indexterm>
|
---|
186 | </listitem>
|
---|
187 | </varlistentry>
|
---|
188 |
|
---|
189 | <!-- Library removed in glslang-14.0.0
|
---|
190 | <varlistentry id="libHLSL">
|
---|
191 | <term><filename class="libraryfile">libHLSL.so</filename></term>
|
---|
192 | <listitem>
|
---|
193 | <para>
|
---|
194 | provides a front-end for shaders that are in HLSL format
|
---|
195 | </para>
|
---|
196 | <indexterm zone="glslang libHLSL">
|
---|
197 | <primary sortas="c-libHLSL">libHLSL.so</primary>
|
---|
198 | </indexterm>
|
---|
199 | </listitem>
|
---|
200 | </varlistentry>
|
---|
201 | -->
|
---|
202 |
|
---|
203 | <varlistentry id="libSPIRV">
|
---|
204 | <term><filename class="libraryfile">libSPIRV.so</filename></term>
|
---|
205 | <listitem>
|
---|
206 | <para>
|
---|
207 | provides a front-end and generator for SPIR-V binaries
|
---|
208 | </para>
|
---|
209 | <indexterm zone="glslang libSPIRV">
|
---|
210 | <primary sortas="c-libSPIRV">libSPIRV.so</primary>
|
---|
211 | </indexterm>
|
---|
212 | </listitem>
|
---|
213 | </varlistentry>
|
---|
214 |
|
---|
215 | <varlistentry id="libSPVRemapper">
|
---|
216 | <term><filename class="libraryfile">libSPVRemapper.so</filename></term>
|
---|
217 | <listitem>
|
---|
218 | <para>
|
---|
219 | provides a remapper for SPIR-V binaries
|
---|
220 | </para>
|
---|
221 | <indexterm zone="glslang libSPVRemapper">
|
---|
222 | <primary sortas="c-libSPVRemapper">libSPVRemapper.so</primary>
|
---|
223 | </indexterm>
|
---|
224 | </listitem>
|
---|
225 | </varlistentry>
|
---|
226 |
|
---|
227 | </variablelist>
|
---|
228 | </sect2>
|
---|
229 | </sect1>
|
---|