This repository was archived by the owner on Jan 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAudioClip_8hpp_source.html
104 lines (102 loc) · 7.37 KB
/
AudioClip_8hpp_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<!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>SPICPRJ Engine: src/Models/AudioClip.hpp Source File</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="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">SPICPRJ Engine
</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&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&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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_36df885461d6bd14211edf06510d126c.html">Models</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">AudioClip.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="AudioClip_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef SPIC_ENGINE_AUDIOCLIP_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define SPIC_ENGINE_AUDIOCLIP_HPP</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "SDL_mixer.h"</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">namespace </span><a class="code" href="namespaceengine.html">engine</a></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classengine_1_1AudioClip.html"> 13</a></span>  <span class="keyword">class </span><a class="code" href="classengine_1_1AudioClip.html">AudioClip</a></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  std::unique_ptr<Mix_Chunk, decltype(&Mix_FreeChunk)> _chunk;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">explicit</span> <a class="code" href="classengine_1_1AudioClip.html#a54cce2e9556f71eb7fbf92f2843141a0">AudioClip</a>(Mix_Chunk* chunk);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  [[nodiscard]] Mix_Chunk* <a class="code" href="classengine_1_1AudioClip.html#afcd4e0b86a35209674499aa9230ade39">Chunk</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  };</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif </span><span class="comment">//SPIC_ENGINE_AUDIOCLIP_HPP</span></div>
<div class="ttc" id="aclassengine_1_1AudioClip_html"><div class="ttname"><a href="classengine_1_1AudioClip.html">engine::AudioClip</a></div><div class="ttdoc">Stores a SDL Mixer Chunk to prevent memory leaks upon shutdown.</div><div class="ttdef"><b>Definition:</b> AudioClip.hpp:14</div></div>
<div class="ttc" id="aclassengine_1_1AudioClip_html_a54cce2e9556f71eb7fbf92f2843141a0"><div class="ttname"><a href="classengine_1_1AudioClip.html#a54cce2e9556f71eb7fbf92f2843141a0">engine::AudioClip::AudioClip</a></div><div class="ttdeci">AudioClip(Mix_Chunk *chunk)</div><div class="ttdoc">Constructs a new AudioClip with a given chunk.</div><div class="ttdef"><b>Definition:</b> AudioClip.cpp:9</div></div>
<div class="ttc" id="aclassengine_1_1AudioClip_html_afcd4e0b86a35209674499aa9230ade39"><div class="ttname"><a href="classengine_1_1AudioClip.html#afcd4e0b86a35209674499aa9230ade39">engine::AudioClip::Chunk</a></div><div class="ttdeci">Mix_Chunk * Chunk() const</div><div class="ttdoc">Access the Mixer Chunk inside the model.</div><div class="ttdef"><b>Definition:</b> AudioClip.cpp:5</div></div>
<div class="ttc" id="anamespaceengine_html"><div class="ttname"><a href="namespaceengine.html">engine</a></div><div class="ttdef"><b>Definition:</b> EngineException.hpp:8</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>