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
|
<!--
SPDX-FileCopyrightText: The WebKit GTK and WPE teams
SPDX-License-Identifier: BSD, LGPL-2.1
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>WPEJavaScriptCore.Value.new_array_buffer</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:title" content="WPEJavaScriptCore.Value.new_array_buffer"/>
<meta property="og:description" content="Reference for WPEJavaScriptCore.Value.new_array_buffer"/>
<meta name="twitter:title" content="WPEJavaScriptCore.Value.new_array_buffer"/>
<meta name="twitter:description" content="Reference for WPEJavaScriptCore.Value.new_array_buffer"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">WPEJavaScriptCore</a></h3>
<p>API Version: 2.0</p>
<p>Library Version: 2.48.6</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Value.html">Value</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="method" href="ctor.Value.new_array.html">new_array</a>
<a class="method current" href="ctor.Value.new_array_buffer.html">new_array_buffer</a>
<a class="method" href="ctor.Value.new_array_from_garray.html">new_array_from_garray</a>
<a class="method" href="ctor.Value.new_array_from_strv.html">new_array_from_strv</a>
<a class="method" href="ctor.Value.new_boolean.html">new_boolean</a>
<a class="method" href="ctor.Value.new_from_json.html">new_from_json</a>
<a class="method" href="ctor.Value.new_function.html">new_function</a>
<a class="method" href="ctor.Value.new_function_variadic.html">new_function_variadic</a>
<a class="method" href="ctor.Value.new_functionv.html">new_functionv</a>
<a class="method" href="ctor.Value.new_null.html">new_null</a>
<a class="method" href="ctor.Value.new_number.html">new_number</a>
<a class="method" href="ctor.Value.new_object.html">new_object</a>
<a class="method" href="ctor.Value.new_promise.html">new_promise</a>
<a class="method" href="ctor.Value.new_string.html">new_string</a>
<a class="method" href="ctor.Value.new_string_from_bytes.html">new_string_from_bytes</a>
<a class="method" href="ctor.Value.new_typed_array.html">new_typed_array</a>
<a class="method" href="ctor.Value.new_undefined.html">new_undefined</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constructor</h3>
<h1><a href="index.html">WPEJavaScriptCore</a><span class="sep"></span><a href="class.Value.html">Value</a><span class="sep"></span>new_array_buffer</h1>
</header>
<section>
<div class="docblock">
<p><span class="emblem available">since: 2.38</span></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/WebKit/WebKit/tree/WebKitBuild/WPE/Release/JavaScriptCoreGLib/DerivedSources/jsc/JSCValue.h#L239">[src]</a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="n">JSCValue</span><span class="o">*</span>
<span class="n">jsc_value_new_array_buffer</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">JSCContext</span><span class="o">*</span><span class="w"> </span><span class="n">context</span><span class="p">,</span>
<span class="w"> </span><span class="n">gpointer</span><span class="w"> </span><span class="n">data</span><span class="p">,</span>
<span class="w"> </span><span class="n">gsize</span><span class="w"> </span><span class="n">size</span><span class="p">,</span>
<span class="w"> </span><span class="n">GDestroyNotify</span><span class="w"> </span><span class="n">destroy_notify</span><span class="p">,</span>
<span class="w"> </span><span class="n">gpointer</span><span class="w"> </span><span class="n">user_data</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/WebKit/WebKit/tree/Source/JavaScriptCore/API/glib/JSCValue.cpp#L1477">[src]</a>
</h4>
<div class="docblock">
<p>Creates a new %ArrayBuffer from existing <code>data</code> in memory.</p>
<p>The <code>data</code> is not copied: while this allows sharing data with JavaScript
efficiently, the caller must ensure that the memory region remains valid
until the newly created object is released by <span class="caps">JSC</span>.</p>
<p>Optionally, a <code>destroy_notify</code> callback can be provided, which will be
invoked with <code>user_data</code> as parameter when the %ArrayBuffer object is
released. This is intended to be used for freeing resources related to
the memory region which contains the data:</p>
<p>|[!<— language=”C” —>
GMappedFile <em>f = g_mapped_file_new (file_path, <span class="caps">TRUE</span>, <span class="caps">NULL</span>);
JSCValue </em>value = jsc_value_new_array_buffer (context,
g_mapped_file_get_contents (f), g_mapped_file_get_length (f),
(GDestroyNotify) g_mapped_file_unref, f); ]|</p>
<p>Note that the <code>user_data</code> can be the same value as <code>data</code>:</p>
<p>|[!<— language=”C” —>
void <em>bytes = g_malloc0 (100);
JSCValue </em>value = jsc_value_new_array_buffer (context, bytes, 100, g_free, bytes); ]|</p>
</div>
<div class="docblock">
<p>Available since: 2.38</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>context</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <a href="class.Context.html"><code>JSCContext</code></a></p>
<p><p>A <code>JSCContext</code>.</p></p>
<table>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>data</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <code>gpointer</code></p>
<p><p>Pointer to a region of memory.</p></p>
<table>
<tr><td>The argument can be <code>NULL</code>.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>size</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <code>gsize</code></p>
<p><p>Size in bytes of the memory region.</p></p>
<table>
</table>
</dd>
<dt class="arg-name"><code>destroy_notify</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <a href="javascript:void(0)" data-link="callback.DestroyNotify.html" data-namespace="GLib" class="external"><code>GDestroyNotify</code></a></p>
<p><p>Destroy notifier for <code>user_data</code>.</p></p>
<table>
<tr><td>The argument can be <code>NULL</code>.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>user_data</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <code>gpointer</code></p>
<p><p>User data.</p></p>
<table>
<tr><td>The argument can be <code>NULL</code>.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em> <a href="class.Value.html"><code>JSCValue</code></a></p>
<p><p>A <code>JSCValue</code>, or <code>NULL</code> in case of exception.</p></p>
</div>
<div>
<table>
<tr><td title="transfer: full">The caller of the function takes ownership of the data, and is responsible for freeing it.</td></tr>
<tr><td>The return value can be <code>NULL</code>.</td></tr>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>
|
