-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_i_plug_paths_8h_source.html
168 lines (166 loc) · 19.2 KB
/
_i_plug_paths_8h_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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!-- HTML header for doxygen 1.8.14-->
<!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>
<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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iPlug 2: IPlugPaths.h 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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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: 80px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">iPlug2 - C++ Audio Plug-in Framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">
<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="dir_a8a4892678035c62db3a4af7d9811050.html">IPlug</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IPlugPaths.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_plug_paths_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. </span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> </span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> See LICENSE.txt for more info.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">*/</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include "<a class="code" href="_i_plug_utilities_8h.html">IPlugUtilities.h</a>"</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>BEGIN_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#if defined OS_MAC || defined OS_IOS</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">using </span>PluginIDType = <span class="keyword">const</span> <span class="keywordtype">char</span> *;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#elif defined OS_WIN</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">using </span>PluginIDType = HMODULE;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">using </span>PluginIDType = <span class="keywordtype">void</span> *;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#a795b9d00189ed09568cbd90acf1c0f88"> 32</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#a795b9d00189ed09568cbd90acf1c0f88">HostPath</a>(WDL_String& path, <span class="keyword">const</span> <span class="keywordtype">char</span>* bundleID = 0);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#a69d61644efbb2b4c90b8e5c802eb05f4"> 37</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#a69d61644efbb2b4c90b8e5c802eb05f4">PluginPath</a>(WDL_String& path, PluginIDType pExtra);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#af14eac4a6241279b7096931f567f4af0"> 44</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#af14eac4a6241279b7096931f567f4af0">BundleResourcePath</a>(WDL_String& path, PluginIDType pExtra = 0);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#a75615139c6bf033977de578c31512c2a"> 47</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#a75615139c6bf033977de578c31512c2a">DesktopPath</a>(WDL_String& path);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#a03a8b65ce1ec3f165019023f43b3dd07"> 50</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#a03a8b65ce1ec3f165019023f43b3dd07">UserHomePath</a>(WDL_String& path);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#adc3ebe2c27a9fae07f5fe4bdf22e6f55"> 54</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#adc3ebe2c27a9fae07f5fe4bdf22e6f55">AppSupportPath</a>(WDL_String& path, <span class="keywordtype">bool</span> isSystem = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#a6083eab93c92e02063862624d2d27934"> 60</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#a6083eab93c92e02063862624d2d27934">VST3PresetsPath</a>(WDL_String& path, <span class="keyword">const</span> <span class="keywordtype">char</span>* mfrName, <span class="keyword">const</span> <span class="keywordtype">char</span>* pluginName, <span class="keywordtype">bool</span> isSystem = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#af2a34e54254ecf7b55eb09c772e6f558"> 65</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#af2a34e54254ecf7b55eb09c772e6f558">INIPath</a>(WDL_String& path, <span class="keyword">const</span> <span class="keywordtype">char</span>* pluginName);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#afd1c96003e52f6c8cce65b4fda6797a6"> 68</a></span><span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code hl_function" href="_i_plug_paths_8h.html#afd1c96003e52f6c8cce65b4fda6797a6">WebViewCachePath</a>(WDL_String& path);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#a219939770dc84d12c583a7c6c5cd1d59"> 83</a></span><span class="keyword">extern</span> EResourceLocation <a class="code hl_function" href="_i_plug_paths_8h.html#a219939770dc84d12c583a7c6c5cd1d59">LocateResource</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fileNameOrResID, <span class="keyword">const</span> <span class="keywordtype">char</span>* type, WDL_String& result, <span class="keyword">const</span> <span class="keywordtype">char</span>* bundleID, <span class="keywordtype">void</span>* pHInstance, <span class="keyword">const</span> <span class="keywordtype">char</span>* sharedResourcesSubPath);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="_i_plug_paths_8h.html#a0238ef4a2d49efc240321b8b5ce290fe"> 88</a></span><span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code hl_function" href="_i_plug_paths_8h.html#a0238ef4a2d49efc240321b8b5ce290fe">LoadWinResource</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* resID, <span class="keyword">const</span> <span class="keywordtype">char</span>* type, <span class="keywordtype">int</span>& sizeInBytes, <span class="keywordtype">void</span>* pHInstance);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#if defined OS_MAC || defined OS_IOS</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keyword">extern</span> <span class="keywordtype">bool</span> AppIsSandboxed();</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="keyword">extern</span> <span class="keywordtype">void</span> AppGroupContainerPath(WDL_String& path, <span class="keyword">const</span> <span class="keywordtype">char</span>* appGroupID);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="keyword">extern</span> <span class="keywordtype">void</span> SharedMusicPath(WDL_String& path);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="keyword">extern</span> <span class="keywordtype">bool</span> IsXPCAuHost();</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="keyword">extern</span> <span class="keywordtype">bool</span> IsOOPAuv3AppExtension();</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>END_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="ttc" id="a_i_plug_paths_8h_html_a0238ef4a2d49efc240321b8b5ce290fe"><div class="ttname"><a href="_i_plug_paths_8h.html#a0238ef4a2d49efc240321b8b5ce290fe">LoadWinResource</a></div><div class="ttdeci">const void * LoadWinResource(const char *resID, const char *type, int &sizeInBytes, void *pHInstance)</div><div class="ttdoc">Load a resource from the binary (windows only).</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_a03a8b65ce1ec3f165019023f43b3dd07"><div class="ttname"><a href="_i_plug_paths_8h.html#a03a8b65ce1ec3f165019023f43b3dd07">UserHomePath</a></div><div class="ttdeci">void UserHomePath(WDL_String &path)</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_a219939770dc84d12c583a7c6c5cd1d59"><div class="ttname"><a href="_i_plug_paths_8h.html#a219939770dc84d12c583a7c6c5cd1d59">LocateResource</a></div><div class="ttdeci">EResourceLocation LocateResource(const char *fileNameOrResID, const char *type, WDL_String &result, const char *bundleID, void *pHInstance, const char *sharedResourcesSubPath)</div><div class="ttdoc">Find the absolute path of a resource based on it's file name (e.g.</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_a6083eab93c92e02063862624d2d27934"><div class="ttname"><a href="_i_plug_paths_8h.html#a6083eab93c92e02063862624d2d27934">VST3PresetsPath</a></div><div class="ttdeci">void VST3PresetsPath(WDL_String &path, const char *mfrName, const char *pluginName, bool isSystem=true)</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_a69d61644efbb2b4c90b8e5c802eb05f4"><div class="ttname"><a href="_i_plug_paths_8h.html#a69d61644efbb2b4c90b8e5c802eb05f4">PluginPath</a></div><div class="ttdeci">void PluginPath(WDL_String &path, PluginIDType pExtra)</div><div class="ttdoc">Get the path to the plug-in binary.</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_a75615139c6bf033977de578c31512c2a"><div class="ttname"><a href="_i_plug_paths_8h.html#a75615139c6bf033977de578c31512c2a">DesktopPath</a></div><div class="ttdeci">void DesktopPath(WDL_String &path)</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_a795b9d00189ed09568cbd90acf1c0f88"><div class="ttname"><a href="_i_plug_paths_8h.html#a795b9d00189ed09568cbd90acf1c0f88">HostPath</a></div><div class="ttdeci">void HostPath(WDL_String &path, const char *bundleID=0)</div><div class="ttdoc">Get the path to the host binary.</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_adc3ebe2c27a9fae07f5fe4bdf22e6f55"><div class="ttname"><a href="_i_plug_paths_8h.html#adc3ebe2c27a9fae07f5fe4bdf22e6f55">AppSupportPath</a></div><div class="ttdeci">void AppSupportPath(WDL_String &path, bool isSystem=false)</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_af14eac4a6241279b7096931f567f4af0"><div class="ttname"><a href="_i_plug_paths_8h.html#af14eac4a6241279b7096931f567f4af0">BundleResourcePath</a></div><div class="ttdeci">void BundleResourcePath(WDL_String &path, PluginIDType pExtra=0)</div><div class="ttdoc">Get the path to the plug-in bundle resource path.</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_af2a34e54254ecf7b55eb09c772e6f558"><div class="ttname"><a href="_i_plug_paths_8h.html#af2a34e54254ecf7b55eb09c772e6f558">INIPath</a></div><div class="ttdeci">void INIPath(WDL_String &path, const char *pluginName)</div><div class="ttdoc">Get the path to the folder where the App's settings.ini file is stored.</div></div>
<div class="ttc" id="a_i_plug_paths_8h_html_afd1c96003e52f6c8cce65b4fda6797a6"><div class="ttname"><a href="_i_plug_paths_8h.html#afd1c96003e52f6c8cce65b4fda6797a6">WebViewCachePath</a></div><div class="ttdeci">void WebViewCachePath(WDL_String &path)</div><div class="ttdoc">Get the path to the folder where the Plug-in's ICoreWebView2 userdata folder should be (Windows WebVi...</div></div>
<div class="ttc" id="a_i_plug_utilities_8h_html"><div class="ttname"><a href="_i_plug_utilities_8h.html">IPlugUtilities.h</a></div><div class="ttdoc">Utility functions and macros.</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.5
</small></address>
</body>
</html>