-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_i_plug_paths_8h.html
560 lines (525 loc) · 27.6 KB
/
_i_plug_paths_8h.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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
<!-- 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 File 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="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="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">IPlugPaths.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Common paths useful for plug-ins.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="_i_plug_utilities_8h_source.html">IPlugUtilities.h</a>"</code><br />
</div>
<p><a href="_i_plug_paths_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:af15f0498352f27ebb7da102c4b7181bc"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#af15f0498352f27ebb7da102c4b7181bc">PluginIDType</a> = void *</td></tr>
<tr class="separator:af15f0498352f27ebb7da102c4b7181bc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a795b9d00189ed09568cbd90acf1c0f88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#a795b9d00189ed09568cbd90acf1c0f88">HostPath</a> (WDL_String &path, const char *bundleID=0)</td></tr>
<tr class="memdesc:a795b9d00189ed09568cbd90acf1c0f88"><td class="mdescLeft"> </td><td class="mdescRight">Get the path to the host binary. <a href="_i_plug_paths_8h.html#a795b9d00189ed09568cbd90acf1c0f88">More...</a><br /></td></tr>
<tr class="separator:a795b9d00189ed09568cbd90acf1c0f88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69d61644efbb2b4c90b8e5c802eb05f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#a69d61644efbb2b4c90b8e5c802eb05f4">PluginPath</a> (WDL_String &path, PluginIDType pExtra)</td></tr>
<tr class="memdesc:a69d61644efbb2b4c90b8e5c802eb05f4"><td class="mdescLeft"> </td><td class="mdescRight">Get the path to the plug-in binary. <a href="_i_plug_paths_8h.html#a69d61644efbb2b4c90b8e5c802eb05f4">More...</a><br /></td></tr>
<tr class="separator:a69d61644efbb2b4c90b8e5c802eb05f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af14eac4a6241279b7096931f567f4af0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#af14eac4a6241279b7096931f567f4af0">BundleResourcePath</a> (WDL_String &path, PluginIDType pExtra=0)</td></tr>
<tr class="memdesc:af14eac4a6241279b7096931f567f4af0"><td class="mdescLeft"> </td><td class="mdescRight">Get the path to the plug-in bundle resource path. <a href="_i_plug_paths_8h.html#af14eac4a6241279b7096931f567f4af0">More...</a><br /></td></tr>
<tr class="separator:af14eac4a6241279b7096931f567f4af0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75615139c6bf033977de578c31512c2a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#a75615139c6bf033977de578c31512c2a">DesktopPath</a> (WDL_String &path)</td></tr>
<tr class="separator:a75615139c6bf033977de578c31512c2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03a8b65ce1ec3f165019023f43b3dd07"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#a03a8b65ce1ec3f165019023f43b3dd07">UserHomePath</a> (WDL_String &path)</td></tr>
<tr class="separator:a03a8b65ce1ec3f165019023f43b3dd07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc3ebe2c27a9fae07f5fe4bdf22e6f55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#adc3ebe2c27a9fae07f5fe4bdf22e6f55">AppSupportPath</a> (WDL_String &path, bool isSystem=false)</td></tr>
<tr class="separator:adc3ebe2c27a9fae07f5fe4bdf22e6f55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6083eab93c92e02063862624d2d27934"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#a6083eab93c92e02063862624d2d27934">VST3PresetsPath</a> (WDL_String &path, const char *mfrName, const char *pluginName, bool isSystem=true)</td></tr>
<tr class="separator:a6083eab93c92e02063862624d2d27934"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2a34e54254ecf7b55eb09c772e6f558"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#af2a34e54254ecf7b55eb09c772e6f558">INIPath</a> (WDL_String &path, const char *pluginName)</td></tr>
<tr class="memdesc:af2a34e54254ecf7b55eb09c772e6f558"><td class="mdescLeft"> </td><td class="mdescRight">Get the path to the folder where the App's settings.ini file is stored. <a href="_i_plug_paths_8h.html#af2a34e54254ecf7b55eb09c772e6f558">More...</a><br /></td></tr>
<tr class="separator:af2a34e54254ecf7b55eb09c772e6f558"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd1c96003e52f6c8cce65b4fda6797a6"><td class="memItemLeft" align="right" valign="top"><a id="afd1c96003e52f6c8cce65b4fda6797a6" name="afd1c96003e52f6c8cce65b4fda6797a6"></a>
void </td><td class="memItemRight" valign="bottom"><b>WebViewCachePath</b> (WDL_String &path)</td></tr>
<tr class="memdesc:afd1c96003e52f6c8cce65b4fda6797a6"><td class="mdescLeft"> </td><td class="mdescRight">Get the path to the folder where the Plug-in's ICoreWebView2 userdata folder should be (Windows WebView only) <br /></td></tr>
<tr class="separator:afd1c96003e52f6c8cce65b4fda6797a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a219939770dc84d12c583a7c6c5cd1d59"><td class="memItemLeft" align="right" valign="top">EResourceLocation </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#a219939770dc84d12c583a7c6c5cd1d59">LocateResource</a> (const char *fileNameOrResID, const char *type, WDL_String &result, const char *bundleID, void *pHInstance, const char *sharedResourcesSubPath)</td></tr>
<tr class="memdesc:a219939770dc84d12c583a7c6c5cd1d59"><td class="mdescLeft"> </td><td class="mdescRight">Find the absolute path of a resource based on it's file name (e.g. <a href="_i_plug_paths_8h.html#a219939770dc84d12c583a7c6c5cd1d59">More...</a><br /></td></tr>
<tr class="separator:a219939770dc84d12c583a7c6c5cd1d59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0238ef4a2d49efc240321b8b5ce290fe"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="_i_plug_paths_8h.html#a0238ef4a2d49efc240321b8b5ce290fe">LoadWinResource</a> (const char *resID, const char *type, int &sizeInBytes, void *pHInstance)</td></tr>
<tr class="memdesc:a0238ef4a2d49efc240321b8b5ce290fe"><td class="mdescLeft"> </td><td class="mdescRight">Load a resource from the binary (windows only). <a href="_i_plug_paths_8h.html#a0238ef4a2d49efc240321b8b5ce290fe">More...</a><br /></td></tr>
<tr class="separator:a0238ef4a2d49efc240321b8b5ce290fe"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Common paths useful for plug-ins. </p>
<p class="definition">Definition in file <a class="el" href="_i_plug_paths_8h_source.html">IPlugPaths.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="af15f0498352f27ebb7da102c4b7181bc" name="af15f0498352f27ebb7da102c4b7181bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af15f0498352f27ebb7da102c4b7181bc">◆ </a></span>PluginIDType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using PluginIDType = void *</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_i_plug_paths_8h_source.html#l00027">27</a> of file <a class="el" href="_i_plug_paths_8h_source.html">IPlugPaths.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="adc3ebe2c27a9fae07f5fe4bdf22e6f55" name="adc3ebe2c27a9fae07f5fe4bdf22e6f55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc3ebe2c27a9fae07f5fe4bdf22e6f55">◆ </a></span>AppSupportPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppSupportPath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isSystem</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
<tr><td class="paramname">isSystem</td><td>Set <code>true</code> if you want to obtain the system-wide path, otherwise the path will be in the user's home folder </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af14eac4a6241279b7096931f567f4af0" name="af14eac4a6241279b7096931f567f4af0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af14eac4a6241279b7096931f567f4af0">◆ </a></span>BundleResourcePath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BundleResourcePath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PluginIDType </td>
<td class="paramname"><em>pExtra</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the path to the plug-in bundle resource path. </p>
<p >On macOS and iOS if this is called in an AUv3 app extension it will return the bundle of the parent app iOS bundles are flat, so the path is just to the .app where as macOS bundles contain a resources subfolder On Windows this is only useful for VST3 plug-ins which have a "bundle" with a resource path since v3.6 </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
<tr><td class="paramname">pExtra</td><td>This should either be a const char* to bundleID (macOS/iOS) or an HMODULE handle (windows) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a75615139c6bf033977de578c31512c2a" name="a75615139c6bf033977de578c31512c2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75615139c6bf033977de578c31512c2a">◆ </a></span>DesktopPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DesktopPath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a795b9d00189ed09568cbd90acf1c0f88" name="a795b9d00189ed09568cbd90acf1c0f88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a795b9d00189ed09568cbd90acf1c0f88">◆ </a></span>HostPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HostPath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>bundleID</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the path to the host binary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af2a34e54254ecf7b55eb09c772e6f558" name="af2a34e54254ecf7b55eb09c772e6f558"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2a34e54254ecf7b55eb09c772e6f558">◆ </a></span>INIPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void INIPath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pluginName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the path to the folder where the App's settings.ini file is stored. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
<tr><td class="paramname">pluginName</td><td>CString to specify the plug-in name (BUNDLE_NAME from config.h can be used here) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0238ef4a2d49efc240321b8b5ce290fe" name="a0238ef4a2d49efc240321b8b5ce290fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0238ef4a2d49efc240321b8b5ce290fe">◆ </a></span>LoadWinResource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void * LoadWinResource </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>resID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"><em>sizeInBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>pHInstance</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a resource from the binary (windows only). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>The resource type in lower or upper case, e.g. ttf or TTF for a truetype font </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const void pointer to the data if successfull on windows. Returns nullptr if unsuccessfull or on platforms other than windows </dd></dl>
<p class="reference">Referenced by <a class="el" href="_i_graphics_nano_v_g_8cpp_source.html#l00311">IGraphicsNanoVG::LoadAPIBitmap()</a>, <a class="el" href="_i_graphics_skia_8cpp_source.html#l00379">IGraphicsSkia::LoadAPIBitmap()</a>, and <a class="el" href="_i_graphics_8cpp_source.html#l01677">IGraphics::LoadResource()</a>.</p>
</div>
</div>
<a id="a219939770dc84d12c583a7c6c5cd1d59" name="a219939770dc84d12c583a7c6c5cd1d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a219939770dc84d12c583a7c6c5cd1d59">◆ </a></span>LocateResource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EResourceLocation LocateResource </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fileNameOrResID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>bundleID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>pHInstance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sharedResourcesSubPath</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the absolute path of a resource based on it's file name (e.g. </p>
<p >“background.png”) and type (e.g. “png”), or in the case of windows, confirm the existence of a particular resource in the binary. If it fails to find the resource with the binary it will test the fileNameOrResID argument as an absolute path, to see if the file exists in that place. On macOS resources are usually included inside the bundle resources folder. On Windows resources are usually baked into the binary via the resource compiler. In this case the fileName argument is the resource id to look for. The .rc file must include these ids, otherwise you may hit a runtime assertion when you come to load the file. In some cases you may want to provide an absolute path to a file in a shared resources folder here (for example if you want to reduce the disk footprint of multiple bundles, such as when you have multiple plug-in formats installed).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fileNameOrResID</td><td>The filename or resourceID including extension. If no resource is found this argument is tested as an absolute path. </td></tr>
<tr><td class="paramname">type</td><td>The resource type (file extension) in lower or upper case, e.g. ttf or TTF for a truetype font </td></tr>
<tr><td class="paramname">result</td><td>WDL_String which will either contain the full path to the resource on disk, or the full Windows resourceID on success </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success </dd></dl>
<p class="reference">Referenced by <a class="el" href="_i_graphics_8cpp_source.html#l01677">IGraphics::LoadResource()</a>, and <a class="el" href="_i_graphics_8cpp_source.html#l01887">IGraphics::SearchImageResource()</a>.</p>
</div>
</div>
<a id="a69d61644efbb2b4c90b8e5c802eb05f4" name="a69d61644efbb2b4c90b8e5c802eb05f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69d61644efbb2b4c90b8e5c802eb05f4">◆ </a></span>PluginPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PluginPath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PluginIDType </td>
<td class="paramname"><em>pExtra</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the path to the plug-in binary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
<tr><td class="paramname">pExtra</td><td>This should either be a const char* to bundleID (macOS) or an HMODULE handle (windows) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a03a8b65ce1ec3f165019023f43b3dd07" name="a03a8b65ce1ec3f165019023f43b3dd07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03a8b65ce1ec3f165019023f43b3dd07">◆ </a></span>UserHomePath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UserHomePath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6083eab93c92e02063862624d2d27934" name="a6083eab93c92e02063862624d2d27934"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6083eab93c92e02063862624d2d27934">◆ </a></span>VST3PresetsPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VST3PresetsPath </td>
<td>(</td>
<td class="paramtype">WDL_String & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mfrName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pluginName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isSystem</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>WDL_String reference where the path will be put on success or empty string on failure </td></tr>
<tr><td class="paramname">mfrName</td><td>CString to specify the manufacturer name, which will be the top level folder for .vstpreset files for this manufacturer's product </td></tr>
<tr><td class="paramname">pluginName</td><td>CString to specify the plug-in name, which will be the sub folder (beneath mfrName) in which the .vstpreset files are located </td></tr>
<tr><td class="paramname">isSystem</td><td>Set <code>true</code> if you want to obtain the system-wide path, otherwise the path will be in the user's home folder </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>