source: general/graphlib/glad.xml@ 2994ba1

<?xml version="1.0" encoding="UTF-8"?>
<!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 glad-download-http "https://github.com/Dav1dde/glad/archive/refs/tags/v&glad-version;/glad-&glad-version;.tar.gz">
  <!ENTITY glad-download-ftp  " ">
  <!ENTITY glad-md5sum        "7bd99cc337608d9cad42b861ccc0e28e">
  <!ENTITY glad-size          "620 KB">
  <!ENTITY glad-buildsize     "36 MB">
  <!ENTITY glad-time          "less than 0.1 SBU">
]>

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

  <title>Glad-&glad-version;</title>

  <indexterm zone="glad">
    <primary sortas="a-glad">Glad</primary>
  </indexterm>

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

    <para>
      The <application>Glad</application> package contains a generator for
      loading Vulkan, OpenGL, EGL, GLES, and GLX contexts.
    </para>

    &lfs121_checked;

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

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

    <!-- Nothing required other than Jinja2, which is in LFS -->
    
    <!-- Tests cannot be run without these dependencies -->
    <bridgehead renderas="sect4">Optional (required to run the tests)</bridgehead>
    <para role="optional">
      <xref linkend="pytest"/>,
      <xref linkend="rust"/>,
      <xref linkend="xorg7-lib"/>,
      <ulink url="https://www.glfw.org/">glfw</ulink>, and
      <ulink url="http://winehq.org/">WINE</ulink>
    </para>

  </sect2>

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

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

&build-wheel;

    <para>
      This package comes with a test suite, but it cannot be run without
      installing the external dependencies listed above.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>&install-wheel; glad2</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          glad
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/lib/python&python3-majorver;/site-packages/glad and
          /usr/lib/python&python3-majorver;/site-packages/glad2-&glad-version;.dist-info
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="glad-prog">
        <term><command>glad</command></term>
        <listitem>
          <para>
            generates loaders for Vulkan, OpenGL, EGL, GLES, and GLX contexts
          </para>
          <indexterm zone="glad glad-prog">
            <primary sortas="b-glad">glad</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>