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

305 lines
16 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="classsf_1_1AudioResource.html">AudioResource</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="#pro-methods">Protected Member Functions</a> &#124;
<a href="classsf_1_1AudioResource-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::AudioResource Class Reference<div class="ingroups"><a class="el" href="group__audio.html">Audio module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for classes that require an audio device.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="AudioResource_8hpp_source.html">SFML/Audio/AudioResource.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sf::AudioResource:</div>
<div class="dyncontent">
<div class="center">
<img src="classsf_1_1AudioResource.png" usemap="#sf::AudioResource_map" alt=""/>
<map id="sf::AudioResource_map" name="sf::AudioResource_map">
<area href="classsf_1_1SoundSource.html" title="Base class defining a sound&#39;s properties." alt="sf::SoundSource" shape="rect" coords="62,56,177,80"/>
<area href="classsf_1_1Sound.html" title="Regular sound that can be played in the audio environment." alt="sf::Sound" shape="rect" coords="0,112,115,136"/>
<area href="classsf_1_1SoundStream.html" title="Abstract base class for streamed audio sources." alt="sf::SoundStream" shape="rect" coords="125,112,240,136"/>
<area href="classsf_1_1Music.html" title="Streamed music played from an audio file." alt="sf::Music" shape="rect" coords="125,168,240,192"/>
</map>
</div></div>
<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:a18cd9db0051286196dd97ec12a4e4b48" id="r_a18cd9db0051286196dd97ec12a4e4b48"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18cd9db0051286196dd97ec12a4e4b48">AudioResource</a> (const <a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;)=default</td></tr>
<tr class="memdesc:a18cd9db0051286196dd97ec12a4e4b48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a18cd9db0051286196dd97ec12a4e4b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1ea5824a8c7a83998e5962790a5512a" id="r_aa1ea5824a8c7a83998e5962790a5512a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa1ea5824a8c7a83998e5962790a5512a">operator=</a> (const <a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;)=default</td></tr>
<tr class="memdesc:aa1ea5824a8c7a83998e5962790a5512a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy assignment. <br /></td></tr>
<tr class="separator:aa1ea5824a8c7a83998e5962790a5512a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68d51ea98040c6e756af5970cb0b4ac0" id="r_a68d51ea98040c6e756af5970cb0b4ac0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a68d51ea98040c6e756af5970cb0b4ac0">AudioResource</a> (<a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:a68d51ea98040c6e756af5970cb0b4ac0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:a68d51ea98040c6e756af5970cb0b4ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b034852fc3be42497d04f69ebad328c" id="r_a3b034852fc3be42497d04f69ebad328c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b034852fc3be42497d04f69ebad328c">operator=</a> (<a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:a3b034852fc3be42497d04f69ebad328c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment. <br /></td></tr>
<tr class="separator:a3b034852fc3be42497d04f69ebad328c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:acdff57800064eb0d6ca5ce1773182705" id="r_acdff57800064eb0d6ca5ce1773182705"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acdff57800064eb0d6ca5ce1773182705">AudioResource</a> ()</td></tr>
<tr class="memdesc:acdff57800064eb0d6ca5ce1773182705"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:acdff57800064eb0d6ca5ce1773182705"><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>Base class for classes that require an audio device. </p>
<p>This class is for internal use only, it must be the base of every class that requires a valid audio device in order to work. </p>
<p class="definition">Definition at line <a class="el" href="AudioResource_8hpp_source.html#l00041">41</a> of file <a class="el" href="AudioResource_8hpp_source.html">AudioResource.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a18cd9db0051286196dd97ec12a4e4b48" name="a18cd9db0051286196dd97ec12a4e4b48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18cd9db0051286196dd97ec12a4e4b48">&#9670;&#160;</a></span>AudioResource() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::AudioResource::AudioResource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;</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">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
</div>
</div>
<a id="a68d51ea98040c6e756af5970cb0b4ac0" name="a68d51ea98040c6e756af5970cb0b4ac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68d51ea98040c6e756af5970cb0b4ac0">&#9670;&#160;</a></span>AudioResource() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::AudioResource::AudioResource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;&amp;</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">default</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
</div>
</div>
<a id="acdff57800064eb0d6ca5ce1773182705" name="acdff57800064eb0d6ca5ce1773182705"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdff57800064eb0d6ca5ce1773182705">&#9670;&#160;</a></span>AudioResource() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::AudioResource::AudioResource </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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3b034852fc3be42497d04f69ebad328c" name="a3b034852fc3be42497d04f69ebad328c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b034852fc3be42497d04f69ebad328c">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></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="classsf_1_1AudioResource.html">AudioResource</a> &amp; sf::AudioResource::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;&amp;</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">default</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment. </p>
</div>
</div>
<a id="aa1ea5824a8c7a83998e5962790a5512a" name="aa1ea5824a8c7a83998e5962790a5512a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1ea5824a8c7a83998e5962790a5512a">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></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="classsf_1_1AudioResource.html">AudioResource</a> &amp; sf::AudioResource::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1AudioResource.html">AudioResource</a> &amp;</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">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy assignment. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AudioResource_8hpp_source.html">AudioResource.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