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/structsf_1_1StencilValue.html

252 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><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><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="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#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="structsf_1_1StencilValue.html">StencilValue</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structsf_1_1StencilValue-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::StencilValue Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Stencil value type (also used as a mask)
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="StencilMode_8hpp_source.html">SFML/Graphics/StencilMode.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8ac79cb138ad833aa99bacf2bbafaffd" id="r_a8ac79cb138ad833aa99bacf2bbafaffd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ac79cb138ad833aa99bacf2bbafaffd">StencilValue</a> (int theValue)</td></tr>
<tr class="memdesc:a8ac79cb138ad833aa99bacf2bbafaffd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a stencil value from a signed integer. <br /></td></tr>
<tr class="separator:a8ac79cb138ad833aa99bacf2bbafaffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e0667c23fc87d91c067cfce4e6d7f39" id="r_a9e0667c23fc87d91c067cfce4e6d7f39"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9e0667c23fc87d91c067cfce4e6d7f39">StencilValue</a> (unsigned int theValue)</td></tr>
<tr class="memdesc:a9e0667c23fc87d91c067cfce4e6d7f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a stencil value from an unsigned integer. <br /></td></tr>
<tr class="separator:a9e0667c23fc87d91c067cfce4e6d7f39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98eb5123c9a5aeff6293b17613cc1eef" id="r_a98eb5123c9a5aeff6293b17613cc1eef"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a98eb5123c9a5aeff6293b17613cc1eef"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a98eb5123c9a5aeff6293b17613cc1eef">StencilValue</a> (T)=delete</td></tr>
<tr class="memdesc:a98eb5123c9a5aeff6293b17613cc1eef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable construction from any other type. <br /></td></tr>
<tr class="separator:a98eb5123c9a5aeff6293b17613cc1eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6c770b37b495d6f2a3ad76a93c8e442b" id="r_a6c770b37b495d6f2a3ad76a93c8e442b"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6c770b37b495d6f2a3ad76a93c8e442b">value</a> {}</td></tr>
<tr class="memdesc:a6c770b37b495d6f2a3ad76a93c8e442b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The stored stencil value. <br /></td></tr>
<tr class="separator:a6c770b37b495d6f2a3ad76a93c8e442b"><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>Stencil value type (also used as a mask) </p>
<p class="definition">Definition at line <a class="el" href="StencilMode_8hpp_source.html#l00074">74</a> of file <a class="el" href="StencilMode_8hpp_source.html">StencilMode.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8ac79cb138ad833aa99bacf2bbafaffd" name="a8ac79cb138ad833aa99bacf2bbafaffd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ac79cb138ad833aa99bacf2bbafaffd">&#9670;&#160;</a></span>StencilValue() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::StencilValue::StencilValue </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>theValue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a stencil value from a signed integer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theValue</td><td>Signed integer value to use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9e0667c23fc87d91c067cfce4e6d7f39" name="a9e0667c23fc87d91c067cfce4e6d7f39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e0667c23fc87d91c067cfce4e6d7f39">&#9670;&#160;</a></span>StencilValue() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::StencilValue::StencilValue </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>theValue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a stencil value from an unsigned integer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theValue</td><td>Unsigned integer value to use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a98eb5123c9a5aeff6293b17613cc1eef" name="a98eb5123c9a5aeff6293b17613cc1eef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98eb5123c9a5aeff6293b17613cc1eef">&#9670;&#160;</a></span>StencilValue() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::StencilValue::StencilValue </td>
<td>(</td>
<td class="paramtype">T</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">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable construction from any other type. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6c770b37b495d6f2a3ad76a93c8e442b" name="a6c770b37b495d6f2a3ad76a93c8e442b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c770b37b495d6f2a3ad76a93c8e442b">&#9670;&#160;</a></span>value</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::StencilValue::value {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>The stored stencil value. </p>
<p class="definition">Definition at line <a class="el" href="StencilMode_8hpp_source.html#l00099">99</a> of file <a class="el" href="StencilMode_8hpp_source.html">StencilMode.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="StencilMode_8hpp_source.html">StencilMode.hpp</a></li>
</ul>
</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