glfs/shareddeps/gfxapi/vk/libvk.xml

<?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 vulkan-loader-download-http "https://github.com/KhronosGroup/Vulkan-Loader/archive/v&vulkan-loader-version;/Vulkan-Loader-&vulkan-loader-version;.tar.gz">
  <!ENTITY vulkan-loader-download-ftp  " ">
]>

<sect1 id="libvk" xreflabel="Vulkan-Loader-&vulkan-loader-version;">
  <?dbhtml filename="libvk.html"?>

  <title>Vulkan-Loader-&vulkan-loader-version;</title>

  <indexterm zone="libvk">
    <primary sortas="a-libvk">Vulkan-Loader</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Vulkan-Loader</title>

    <para>
      The <application>Vulkan-Loader</application> package contains a library
      which provides the Vulkan API and provides core support for graphics
      drivers for Vulkan.
    </para>

    &lfs121_checked;

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&vulkan-loader-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&vulkan-loader-download-ftp;"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Vulkan-loader Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>,
      <xref linkend="vkheaders"/>, and
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="runtime">
	<xref linkend="mesa"/> (runtime: for Vulkan drivers) and
	<xref linkend="wayland"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Vulkan-Loader</title>

    <note>
      <para>
        If this package is being installed on a system where Mesa has already
        been installed previously, please rebuild <!--xref linkend="mesa"/--> Mesa after
        this package to install Vulkan graphics drivers.
      </para>
    </note>

    <para>
      Install <application>Vulkan-Loader</application> by running the following
      commands:
    </para>

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

cmake -D CMAKE_INSTALL_PREFIX=/usr     \
      -D CMAKE_BUILD_TYPE=Release      \
      -D CMAKE_SKIP_INSTALL_RPATH=ON   \
      -G Ninja ..

ninja</userinput></screen>

    <para>
      This package does not come with a working test suite.
    </para>

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

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

  </sect2>

  <sect2>
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../../xincludes/cmake-skip-install-rpath.xml"/>

    <para>
      <parameter>-D BUILD_WSI_WAYLAND_SUPPORT=OFF</parameter>: This
      option allows building the library without Wayland.
    </para>

  </sect2>

  <sect2 role="installation">
    <title>32-bit Installation of Vulkan-Loader</title>

    <para>
	First clean the build directory:
    </para>

<screen><userinput>rm -rf *</userinput></screen>

    <para>
	Install lib32-<application>Vulkan-Loader</application> by running
	the following commands:
    </para>

<screen><userinput>ASFLAGS=--32 CFLAGS=-m32 CXXFLAGS=-m32 \
PKG_CONFIG_PATH=/usr/lib32/pkgconfig   \
cmake -D CMAKE_INSTALL_PREFIX=/usr     \
      -D CMAKE_INSTALL_LIBDIR=lib32    \
      -D CMAKE_BUILD_TYPE=Release      \
      -D CMAKE_SKIP_INSTALL_RPATH=ON   \
      -G Ninja ..

ninja</userinput></screen>

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

<screen role="root"><userinput>DESTDIR=$PWD/DESTDIR ninja install
cp -vr DESTDIR/usr/lib32/* /usr/lib32
rm -rf DESTDIR
ldconfig</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libvulkan.so
        </seg>
        <seg>
          /usr/lib/cmake/VulkanLoader
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libvulkan">
        <term><filename class="libraryfile">libvulkan.so</filename></term>
        <listitem>
          <para>
            provides the Vulkan API and core support for graphics drivers
          </para>
          <indexterm zone="libvk libvulkan">
            <primary sortas="c-libvulkan">libvulkan.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>