joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/namespacesf_1_1Vulkan.html

235 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="namespacesf_1_1Vulkan.html">Vulkan</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sf::Vulkan Namespace Reference<div class="ingroups"><a class="el" href="group__window.html">Window module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> helper functions.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7ef19fe70cf7164f8a3fc47f78fab5a1" id="r_a7ef19fe70cf7164f8a3fc47f78fab5a1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ef19fe70cf7164f8a3fc47f78fab5a1">isAvailable</a> (bool requireGraphics=true)</td></tr>
<tr class="memdesc:a7ef19fe70cf7164f8a3fc47f78fab5a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell whether or not the system supports <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a>. <br /></td></tr>
<tr class="separator:a7ef19fe70cf7164f8a3fc47f78fab5a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ef0f8740c571e50ce66e110e9acee26" id="r_a1ef0f8740c571e50ce66e110e9acee26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#a6e179664399fe764916147b2326a3c0e">VulkanFunctionPointer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1ef0f8740c571e50ce66e110e9acee26">getFunction</a> (const char *name)</td></tr>
<tr class="memdesc:a1ef0f8740c571e50ce66e110e9acee26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the address of a <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> function. <br /></td></tr>
<tr class="separator:a1ef0f8740c571e50ce66e110e9acee26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f0cbedc28688be11208afef83fe1c1f" id="r_a3f0cbedc28688be11208afef83fe1c1f"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; const char * &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f0cbedc28688be11208afef83fe1c1f">getGraphicsRequiredInstanceExtensions</a> ()</td></tr>
<tr class="memdesc:a3f0cbedc28688be11208afef83fe1c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> instance extensions required for graphics. <br /></td></tr>
<tr class="separator:a3f0cbedc28688be11208afef83fe1c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> helper functions. </p>
<p>This namespace contains functions to help you use SFML for windowing and write your own <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> code for graphics. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a1ef0f8740c571e50ce66e110e9acee26" name="a1ef0f8740c571e50ce66e110e9acee26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ef0f8740c571e50ce66e110e9acee26">&#9670;&#160;</a></span>getFunction()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacesf.html#a6e179664399fe764916147b2326a3c0e">VulkanFunctionPointer</a> sf::Vulkan::getFunction </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the address of a <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the function to get the address of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of the <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> function, 0 on failure </dd></dl>
</div>
</div>
<a id="a3f0cbedc28688be11208afef83fe1c1f" name="a3f0cbedc28688be11208afef83fe1c1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f0cbedc28688be11208afef83fe1c1f">&#9670;&#160;</a></span>getGraphicsRequiredInstanceExtensions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; const char * &gt; &amp; sf::Vulkan::getGraphicsRequiredInstanceExtensions </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> instance extensions required for graphics. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> instance extensions required for graphics </dd></dl>
</div>
</div>
<a id="a7ef19fe70cf7164f8a3fc47f78fab5a1" name="a7ef19fe70cf7164f8a3fc47f78fab5a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef19fe70cf7164f8a3fc47f78fab5a1">&#9670;&#160;</a></span>isAvailable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::Vulkan::isAvailable </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>requireGraphics</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell whether or not the system supports <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a>. </p>
<p>This function should always be called before using the <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> features. If it returns <code>false</code>, then any attempt to use <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> will fail.</p>
<p>If only compute is required, set <code>requireGraphics</code> to <code>false</code> to skip checking for the extensions necessary for graphics rendering.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">requireGraphics</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <a class="el" href="namespacesf_1_1Vulkan.html" title="Vulkan helper functions.">Vulkan</a> is supported, <code>false</code> otherwise </dd></dl>
</div>
</div>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink