-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass_i_layer.html
308 lines (285 loc) · 15.8 KB
/
class_i_layer.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
<!-- 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: ILayer 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="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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_i_layer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ILayer Class Reference<div class="ingroups"><a class="el" href="group___i_graphics_structs.html">IGraphics::Structs</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>An abstraction that is used to store a temporary raster image/framebuffer.
<a href="class_i_layer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a>></code></p>
<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:a588a3a0106992b954bbc06e8c871f452"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_layer.html#a588a3a0106992b954bbc06e8c871f452">ILayer</a> (<a class="el" href="class_a_p_i_bitmap.html">APIBitmap</a> *pBitmap, const <a class="el" href="struct_i_r_e_c_t.html">IRECT</a> &layerRect, <a class="el" href="class_i_control.html">IControl</a> *pControl, const <a class="el" href="struct_i_r_e_c_t.html">IRECT</a> &controlRect)</td></tr>
<tr class="memdesc:a588a3a0106992b954bbc06e8c871f452"><td class="mdescLeft"> </td><td class="mdescRight">Create a layer/offscreen context (used internally) <a href="class_i_layer.html#a588a3a0106992b954bbc06e8c871f452">More...</a><br /></td></tr>
<tr class="separator:a588a3a0106992b954bbc06e8c871f452"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa46fa18f079a05270b6823d5142624a8"><td class="memItemLeft" align="right" valign="top"><a id="aa46fa18f079a05270b6823d5142624a8" name="aa46fa18f079a05270b6823d5142624a8"></a>
 </td><td class="memItemRight" valign="bottom"><b>ILayer</b> (const <a class="el" href="class_i_layer.html">ILayer</a> &)=delete</td></tr>
<tr class="separator:aa46fa18f079a05270b6823d5142624a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a694434d310bbab6873664a61c8ff4b32"><td class="memItemLeft" align="right" valign="top"><a id="a694434d310bbab6873664a61c8ff4b32" name="a694434d310bbab6873664a61c8ff4b32"></a>
<a class="el" href="class_i_layer.html">ILayer</a> </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="class_i_layer.html">ILayer</a> &)=delete</td></tr>
<tr class="separator:a694434d310bbab6873664a61c8ff4b32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92a1222ea69da36c20b9cb506623f1cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_layer.html#a92a1222ea69da36c20b9cb506623f1cf">Invalidate</a> ()</td></tr>
<tr class="memdesc:a92a1222ea69da36c20b9cb506623f1cf"><td class="mdescLeft"> </td><td class="mdescRight">Mark the layer as needing its contents redrawn <br />
<a href="class_i_layer.html#a92a1222ea69da36c20b9cb506623f1cf">More...</a><br /></td></tr>
<tr class="separator:a92a1222ea69da36c20b9cb506623f1cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2af8456b1c7a88ad7cc4204aa574e4d9"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_a_p_i_bitmap.html">APIBitmap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_layer.html#a2af8456b1c7a88ad7cc4204aa574e4d9">GetAPIBitmap</a> () const</td></tr>
<tr class="separator:a2af8456b1c7a88ad7cc4204aa574e4d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa77b1e18dab3afa10d1f738963453110"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_i_bitmap.html">IBitmap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_layer.html#aa77b1e18dab3afa10d1f738963453110">GetBitmap</a> () const</td></tr>
<tr class="separator:aa77b1e18dab3afa10d1f738963453110"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a913cc5e66119beb3293d99bfb019b0f6"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_i_r_e_c_t.html">IRECT</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_layer.html#a913cc5e66119beb3293d99bfb019b0f6">Bounds</a> () const</td></tr>
<tr class="separator:a913cc5e66119beb3293d99bfb019b0f6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >An abstraction that is used to store a temporary raster image/framebuffer. </p>
<p >The layer is drawn with a specific offset to the graphics context. ILayers take ownership of the underlying bitmaps In GPU-based backends (NanoVG), this is a texture. </p>
<p class="definition">Definition at line <a class="el" href="_i_graphics_structs_8h_source.html#l02328">2328</a> of file <a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a588a3a0106992b954bbc06e8c871f452" name="a588a3a0106992b954bbc06e8c871f452"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a588a3a0106992b954bbc06e8c871f452">◆ </a></span>ILayer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ILayer::ILayer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_a_p_i_bitmap.html">APIBitmap</a> * </td>
<td class="paramname"><em>pBitmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_i_r_e_c_t.html">IRECT</a> & </td>
<td class="paramname"><em>layerRect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_i_control.html">IControl</a> * </td>
<td class="paramname"><em>pControl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_i_r_e_c_t.html">IRECT</a> & </td>
<td class="paramname"><em>controlRect</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a layer/offscreen context (used internally) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pBitmap</td><td>The <a class="el" href="class_a_p_i_bitmap.html" title="A base class interface for a bitmap abstraction around the different drawing back end bitmap represen...">APIBitmap</a> to use for the layer </td></tr>
<tr><td class="paramname">layerRect</td><td>The bounds of the layer withing the graphics context </td></tr>
<tr><td class="paramname">pControl</td><td>The control that the layer belongs to </td></tr>
<tr><td class="paramname">controlRect</td><td>The bounds of the control </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_i_graphics_structs_8h_source.html#l02338">2338</a> of file <a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a913cc5e66119beb3293d99bfb019b0f6" name="a913cc5e66119beb3293d99bfb019b0f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a913cc5e66119beb3293d99bfb019b0f6">◆ </a></span>Bounds()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_i_r_e_c_t.html">IRECT</a> & ILayer::Bounds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>const <a class="el" href="struct_i_r_e_c_t.html" title="Used to manage a rectangular area, independent of draw class/platform.">IRECT</a>& The bounds of the layer withing the graphics context </dd></dl>
<p class="definition">Definition at line <a class="el" href="_i_graphics_structs_8h_source.html#l02359">2359</a> of file <a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="_i_graphics_8cpp_source.html#l02013">IGraphics::PushLayer()</a>.</p>
</div>
</div>
<a id="a2af8456b1c7a88ad7cc4204aa574e4d9" name="a2af8456b1c7a88ad7cc4204aa574e4d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2af8456b1c7a88ad7cc4204aa574e4d9">◆ </a></span>GetAPIBitmap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_a_p_i_bitmap.html">APIBitmap</a> * ILayer::GetAPIBitmap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>const APIBitmap* The API bitmap for the layer </dd></dl>
<p class="definition">Definition at line <a class="el" href="_i_graphics_structs_8h_source.html#l02353">2353</a> of file <a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a>.</p>
</div>
</div>
<a id="aa77b1e18dab3afa10d1f738963453110" name="aa77b1e18dab3afa10d1f738963453110"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa77b1e18dab3afa10d1f738963453110">◆ </a></span>GetBitmap()</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="class_i_bitmap.html">IBitmap</a> ILayer::GetBitmap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_i_bitmap.html" title="User-facing bitmap abstraction that you use to manage bitmap data, independant of draw class/platform...">IBitmap</a> An <a class="el" href="class_i_bitmap.html" title="User-facing bitmap abstraction that you use to manage bitmap data, independant of draw class/platform...">IBitmap</a> to use the layer directly </dd></dl>
<p class="definition">Definition at line <a class="el" href="_i_graphics_structs_8h_source.html#l02356">2356</a> of file <a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a>.</p>
</div>
</div>
<a id="a92a1222ea69da36c20b9cb506623f1cf" name="a92a1222ea69da36c20b9cb506623f1cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92a1222ea69da36c20b9cb506623f1cf">◆ </a></span>Invalidate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ILayer::Invalidate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Mark the layer as needing its contents redrawn <br />
</p>
<p class="definition">Definition at line <a class="el" href="_i_graphics_structs_8h_source.html#l02350">2350</a> of file <a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_graphics_structs_8h_source.html">IGraphicsStructs.h</a></li>
</ul>
</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>