lauchmelder/SDLU
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
SDLU/docs/html/class_cursor.html
Robert ab2961cf92 Added documentation
2021-04-24 02:01:36 +02:00

401 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SDL Utility: Cursor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SDL Utility
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_cursor.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="class_cursor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Cursor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_cursor_8hpp_source.html">Cursor.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa99dd82cd449a09a73160d6026654d58"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58">Type</a> { <br />
&#160;&#160;<a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a0f4e1aaabd074689b7d3ead824d1ee8e">Arrow</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a4ca8b47601e7a843e23d0139a8a4ff61">IBeam</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a0f68101772bd5397ef8eb1b632798652">Wait</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a0a7ad1fc7e1bda1d661fc937c4e6eedd">Crosshair</a>
, <br />
&#160;&#160;<a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a437d4d25369ccdb9d2904d2e580690f2">WaitArrow</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a8cfa3f5cbcc23e58611dc92662ddac09">SizeNWSE</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a6f0db7974d460608c90ad08e351619cf">SizeNESW</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a520236df30bebadfd156ccc777bb84cd">SizeWE</a>
, <br />
&#160;&#160;<a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58ad24a7fbad35193c43fb833d4c3b33fb6">SizeNS</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58a6ba8042ceea48823ba6c4c72b9354cea">SizeAll</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58abafd7322c6e97d25b6299b5d6fe8920b">No</a>
, <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58aa78b1ac16c0cd02168097fc9a9bd7604">Hand</a>
<br />
}</td></tr>
<tr class="separator:aa99dd82cd449a09a73160d6026654d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a126c5677653ce46f555eaee0f3881fae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#a126c5677653ce46f555eaee0f3881fae">Cursor</a> ()</td></tr>
<tr class="separator:a126c5677653ce46f555eaee0f3881fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a269e7ae29fa52c4ae8e57e966a97cadd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#a269e7ae29fa52c4ae8e57e966a97cadd">Cursor</a> (<a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58">Type</a> type)</td></tr>
<tr class="separator:a269e7ae29fa52c4ae8e57e966a97cadd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace847a3f319f4393823a5da050dae526"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#ace847a3f319f4393823a5da050dae526">Cursor</a> (const <a class="el" href="class_cursor.html">Cursor</a> &amp;other)=delete</td></tr>
<tr class="separator:ace847a3f319f4393823a5da050dae526"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7353cb11dd1040e498e81a3b7b4c803"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#ab7353cb11dd1040e498e81a3b7b4c803">Cursor</a> (<a class="el" href="class_cursor.html">Cursor</a> &amp;&amp;other) noexcept</td></tr>
<tr class="separator:ab7353cb11dd1040e498e81a3b7b4c803"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a025d505a120236dc61a889bd5b0aef16"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#a025d505a120236dc61a889bd5b0aef16">~Cursor</a> ()</td></tr>
<tr class="separator:a025d505a120236dc61a889bd5b0aef16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa52d3c672d1ff5e824696eb9f6d40df1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#aa52d3c672d1ff5e824696eb9f6d40df1">LoadFromPixels</a> (const <a class="el" href="_util_8hpp.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> *pixels, <a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> size, <a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> hotspot)</td></tr>
<tr class="separator:aa52d3c672d1ff5e824696eb9f6d40df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a888633271180cd0b7d1e3213a1bfee00"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#a888633271180cd0b7d1e3213a1bfee00">LoadFromSurface</a> (SDL_Surface *surface, <a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> hotspot)</td></tr>
<tr class="separator:a888633271180cd0b7d1e3213a1bfee00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae90dcd92936cba7e3aaec98b7261156"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#aae90dcd92936cba7e3aaec98b7261156">LoadFromSystem</a> (<a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58">Type</a> type)</td></tr>
<tr class="separator:aae90dcd92936cba7e3aaec98b7261156"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a553f958a25683445088050a69d3de8e9"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor.html#a553f958a25683445088050a69d3de8e9">Window</a></td></tr>
<tr class="separator:a553f958a25683445088050a69d3de8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aa99dd82cd449a09a73160d6026654d58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa99dd82cd449a09a73160d6026654d58">&#9670;&nbsp;</a></span>Type</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58">Cursor::Type</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a0f4e1aaabd074689b7d3ead824d1ee8e"></a>Arrow&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a4ca8b47601e7a843e23d0139a8a4ff61"></a>IBeam&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a0f68101772bd5397ef8eb1b632798652"></a>Wait&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a0a7ad1fc7e1bda1d661fc937c4e6eedd"></a>Crosshair&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a437d4d25369ccdb9d2904d2e580690f2"></a>WaitArrow&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a8cfa3f5cbcc23e58611dc92662ddac09"></a>SizeNWSE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a6f0db7974d460608c90ad08e351619cf"></a>SizeNESW&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a520236df30bebadfd156ccc777bb84cd"></a>SizeWE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58ad24a7fbad35193c43fb833d4c3b33fb6"></a>SizeNS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58a6ba8042ceea48823ba6c4c72b9354cea"></a>SizeAll&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58abafd7322c6e97d25b6299b5d6fe8920b"></a>No&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa99dd82cd449a09a73160d6026654d58aa78b1ac16c0cd02168097fc9a9bd7604"></a>Hand&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a126c5677653ce46f555eaee0f3881fae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a126c5677653ce46f555eaee0f3881fae">&#9670;&nbsp;</a></span>Cursor() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cursor::Cursor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a269e7ae29fa52c4ae8e57e966a97cadd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a269e7ae29fa52c4ae8e57e966a97cadd">&#9670;&nbsp;</a></span>Cursor() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cursor::Cursor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58">Type</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ace847a3f319f4393823a5da050dae526"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace847a3f319f4393823a5da050dae526">&#9670;&nbsp;</a></span>Cursor() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cursor::Cursor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_cursor.html">Cursor</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></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">
</div>
</div>
<a id="ab7353cb11dd1040e498e81a3b7b4c803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7353cb11dd1040e498e81a3b7b4c803">&#9670;&nbsp;</a></span>Cursor() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cursor::Cursor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_cursor.html">Cursor</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a025d505a120236dc61a889bd5b0aef16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a025d505a120236dc61a889bd5b0aef16">&#9670;&nbsp;</a></span>~Cursor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cursor::~Cursor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa52d3c672d1ff5e824696eb9f6d40df1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa52d3c672d1ff5e824696eb9f6d40df1">&#9670;&nbsp;</a></span>LoadFromPixels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Cursor::LoadFromPixels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="_util_8hpp.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> *&#160;</td>
<td class="paramname"><em>pixels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a>&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a>&#160;</td>
<td class="paramname"><em>hotspot</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a888633271180cd0b7d1e3213a1bfee00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a888633271180cd0b7d1e3213a1bfee00">&#9670;&nbsp;</a></span>LoadFromSurface()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Cursor::LoadFromSurface </td>
<td>(</td>
<td class="paramtype">SDL_Surface *&#160;</td>
<td class="paramname"><em>surface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a>&#160;</td>
<td class="paramname"><em>hotspot</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aae90dcd92936cba7e3aaec98b7261156"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae90dcd92936cba7e3aaec98b7261156">&#9670;&nbsp;</a></span>LoadFromSystem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Cursor::LoadFromSystem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_cursor.html#aa99dd82cd449a09a73160d6026654d58">Type</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a553f958a25683445088050a69d3de8e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a553f958a25683445088050a69d3de8e9">&#9670;&nbsp;</a></span>Window</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="class_window.html">Window</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/Robert/source/repos/SDLU/include/structures/<a class="el" href="_cursor_8hpp_source.html">Cursor.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_cursor.html">Cursor</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink