glfs/general/genlib/spirv-headers.xml
2024-01-19 22:39:35 +01:00

139 lines
3.8 KiB
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 spirv-headers-download-http "https://github.com/KhronosGroup/SPIRV-Headers/archive/refs/tags/vulkan-sdk-&spirv-headers-version;/SPIRV-Headers-&spirv-headers-version;.tar.gz">
<!ENTITY spirv-headers-download-ftp " ">
<!ENTITY spirv-headers-md5sum "f293886617aa816fdbb2b50d5e909681">
<!ENTITY spirv-headers-size "456 KB">
<!ENTITY spirv-headers-buildsize "6.7 MB">
<!ENTITY spirv-headers-time "less than 0.1 SBU">
]>
<sect1 id="spirv-headers" xreflabel="SPIRV-Headers-&spirv-headers-version;">
<?dbhtml filename="spirv-headers.html"?>
<title>SPIRV-Headers-&spirv-headers-version;</title>
<indexterm zone="spirv-headers">
<primary sortas="a-spirv-headers">SPIRV-Headers</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to SPIRV-Headers</title>
<para>
The <application>SPIRV-Headers</application> package contains headers
that allow for applications to the SPIR-V language and instruction set
with Vulkan. SPIR-V is a binary intermediate language for representing
graphical shader stages and compute kernels for multiple Khronos APIs,
including OpenGL and Vulkan.
</para>
&lfs120_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&spirv-headers-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&spirv-headers-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &spirv-headers-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &spirv-headers-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &spirv-headers-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &spirv-headers-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">SPIRV-Headers Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="cmake"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of SPIRV-Headers</title>
<note>
<para>
This tarball
<filename>SPIRV-Headers-&spirv-headers-version;.tar.gz</filename> will
extract to the directory
<filename class="directory">SPIRV-Headers-vulkan-sdk-&spirv-headers-version;</filename>.
</para>
</note>
<para>
Install <application>SPIRV-Headers</application> by running the following
commands:
</para>
<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -DCMAKE_INSTALL_PREFIX=/usr -G Ninja .. &amp;&amp;
ninja</userinput></screen>
<para>
This package does not come with a test suite.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja install</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>
None
</seg>
<seg>
/usr/include/spirv and
/usr/share/cmake/SPIRV-Headers
</seg>
</seglistitem>
</segmentedlist>
</sect2>
</sect1>