glfs/shareddeps/gfxapi/vk/vkheaders.xml
Zeckmathederg a5a5f0f785 Removed all unstable notes on all packages.
Important: Added a section about stability.

Also fixed a build failure with last commit (missing ending para tag).
2024-10-18 12:39:05 -06:00

104 lines
2.7 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 vulkan-headers-download-http "https://github.com/KhronosGroup/Vulkan-Headers/archive/v&vulkan-headers-version;/Vulkan-Headers-&vulkan-headers-version;.tar.gz">
<!ENTITY vulkan-headers-download-ftp " ">
]>
<sect1 id="vkheaders" xreflabel="Vulkan-Headers-&vulkan-headers-version;">
<?dbhtml filename="vkheaders.html"?>
<title>Vulkan-Headers-&vulkan-headers-version;</title>
<indexterm zone="vkheaders">
<primary sortas="a-vkheaders">Vulkan-Headers</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Vulkan-headers</title>
<para>
The <application>Vulkan-Headers</application> package contains a set of
header files necessary to build and link applications against the Vulkan
API.
</para>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&vulkan-headers-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&vulkan-headers-download-ftp;"/>
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Vulkan-Headers Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="cmake"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of Vulkan-Headers</title>
<para>
Install <application>Vulkan-Headers</application> by running the following
commands:
</para>
<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -D CMAKE_INSTALL_PREFIX=/usr -G Ninja .. &amp;&amp;
ninja</userinput></screen>
<para>
To test the results, issue: <command>ninja test</command>.
</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/vk_video,
/usr/include/vulkan,
/usr/share/cmake/VulkanHeaders, and
/usr/share/vulkan
</seg>
</seglistitem>
</segmentedlist>
</sect2>
</sect1>