source: x/lib/glslang.xml@ 6dd695f7

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY glslang-download-http "https://github.com/KhronosGroup/glslang/archive/refs/tags/&glslang-version;/glslang-&glslang-version;.tar.gz">
  <!ENTITY glslang-download-ftp  " ">
  <!ENTITY glslang-md5sum        "bfbf7fb0d18d00306ef229f289a8d593">
  <!ENTITY glslang-size          "3.6 MB">
  <!ENTITY glslang-buildsize     "161 MB (with tests">
  <!ENTITY glslang-time          "0.2 SBU (with parallelism=8; with tests)">
]>

<sect1 id="glslang" xreflabel="Glslang-&glslang-version;">
  <?dbhtml filename="glslang.html"?>

  <title>Glslang-&glslang-version;</title>

  <indexterm zone="glslang">
    <primary sortas="a-glslang">Glslang</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Glslang</title>

    <para>
      The <application>Glslang</application> package contains an frontend and
      validator for OpenGL, OpenGL ES, and Vulkan shaders.
    </para>

    &lfs120_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&glslang-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&glslang-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &glslang-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &glslang-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &glslang-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &glslang-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Glslang Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/> and
      <xref linkend="spirv-tools"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Glslang</title>

    <para>
      Install <application>Glslang</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr     \
      -DCMAKE_BUILD_TYPE=Release      \
      -DALLOW_EXTERNAL_SPIRV_TOOLS=ON \
      -DBUILD_SHARED_LIBS=ON          \
      -DGLSLANG_TESTS=ON              \
      -G Ninja .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DALLOW_EXTERNAL_SPIRV_TOOLS=ON</parameter>: This switch allows
      the build system to use the system-installed copy of
      <xref linkend="spirv-tools" role="nodep"/>, instead of downloading and
      installing it's own copy.
    </para>

    <para>
      <parameter>-DBUILD_SHARED_LIBS=ON</parameter>: This switch builds shared
      versions of the libraries, and does not install static versions of them.
    </para>

    <para>
      <parameter>-DGLSLANG_TESTS=ON</parameter>: This switch builds the 
      tests for the package.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          glslang,
          glslang-validator (symlink to glslang), and
          spirv-remap
        </seg>
        <seg>
          libglslang.so,
          libglslang-default-resource-limits.so,
          libHLSL.so,
          libSPIRV.so, and
          libSPVRemapper.so
        </seg>
        <seg>
          /usr/include/glslang and
          /usr/lib/cmake/glslang
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <!-- If the program or library name conflicts with (is the same as) the
      package name, add -prog or -lib to the varlistentry entity id
      and the 2nd entry of the indexterm zone entity -->

      <varlistentry id="glslang-prog">
        <term><command>glslang</command></term>
        <listitem>
          <para>
            provides a front end and validator for OpenGL, OpenGL ES, and
            Vulkan shaders
          </para>
          <indexterm zone="glslang glslang-prog">
            <primary sortas="b-glslang">glslang</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libglslang">
        <term><filename class="libraryfile">libglslang.so</filename></term>
        <listitem>
          <para>
            contains functions that provide a front-end and validator for
            OpenGL, OpenGL ES, and Vulkan shaders to other programs
          </para>
          <indexterm zone="glslang libglslang">
            <primary sortas="c-libglslang">libglslang.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libHLSL">
        <term><filename class="libraryfile">libHLSL.so</filename></term>
        <listitem>
          <para>
            provides a front-end for shaders that are in HLSL format
          </para>
          <indexterm zone="glslang libHLSL">
            <primary sortas="c-libHLSL">libHLSL.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libSPIRV">
        <term><filename class="libraryfile">libSPIRV.so</filename></term>
        <listitem>
          <para>
            provides a front-end and generator for SPIR-V binaries
          </para>
          <indexterm zone="glslang libSPIRV">
            <primary sortas="c-libSPIRV">libSPIRV.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libSPVRemapper">
        <term><filename class="libraryfile">libSPVRemapper.so</filename></term>
        <listitem>
          <para>
            provides a remapper for SPIR-V binaries
          </para>
          <indexterm zone="glslang libSPVRemapper">
            <primary sortas="c-libSPVRemapper">libSPVRemapper.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
  </sect2>
</sect1>