Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(51)

Side by Side Diff: ppapi/api/dev/ppb_var_array_buffer_dev.idl

Issue 9169052: Tweaks to PPB_VarArrayBuffer in preperation for taking out of Dev. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: fixes based on reviews Created 8 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | ppapi/c/dev/ppb_var_array_buffer_dev.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 * Use of this source code is governed by a BSD-style license that can be 2 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file. 3 * found in the LICENSE file.
4 */ 4 */
5 5
6 /** 6 /**
7 * This file defines the <code>PPB_VarArrayBuffer_Dev</code> struct. 7 * This file defines the <code>PPB_VarArrayBuffer_Dev</code> struct.
8 */ 8 */
9 9
10 label Chrome { 10 label Chrome {
11 M17 = 0.1 11 M18 = 0.2
12 }; 12 };
13 13
14 /** 14 /**
15 * PPB_VarArrayBuffer_Dev API. This provides a way to interact with JavaScript 15 * PPB_VarArrayBuffer_Dev API. This provides a way to interact with JavaScript
16 * ArrayBuffers, which represent a contiguous sequence of bytes. To manage the 16 * ArrayBuffers, which represent a contiguous sequence of bytes. To manage the
17 * reference count for a VarArrayBuffer, please see PPB_Var. Note that 17 * reference count for a VarArrayBuffer, please see PPB_Var. Note that
18 * these Vars are not part of the embedding page's DOM, and can only be shared 18 * these Vars are not part of the embedding page's DOM, and can only be shared
19 * with JavaScript via pp::Instance's PostMessage and HandleMessage functions. 19 * with JavaScript via pp::Instance's PostMessage and HandleMessage functions.
20 */ 20 */
21 [macro="PPB_VAR_ARRAY_BUFFER_DEV_INTERFACE"] 21 [macro="PPB_VAR_ARRAY_BUFFER_DEV_INTERFACE"]
22 interface PPB_VarArrayBuffer_Dev { 22 interface PPB_VarArrayBuffer_Dev {
23 /** 23 /**
24 * Create a zero-initialized VarArrayBuffer. 24 * Create a zero-initialized VarArrayBuffer.
25 * 25 *
26 * @param[in] size_in_bytes The size of the array buffer that will be created. 26 * @param[in] size_in_bytes The size of the ArrayBuffer that will be created.
27 * 27 *
28 * @return A PP_Var which represents an VarArrayBuffer of the requested size 28 * @return A PP_Var which represents a VarArrayBuffer of the requested size
29 * with a reference count of 1. 29 * with a reference count of 1.
30 */ 30 */
31 PP_Var Create([in] uint32_t size_in_bytes); 31 PP_Var Create([in] uint32_t size_in_bytes);
32
32 /** 33 /**
33 * Returns the length of the VarArrayBuffer in bytes. 34 * Retrieves the length of the VarArrayBuffer in bytes. On success,
35 * byte_length is set to the length of the given ArrayBuffer var. On failure,
36 * byte_length is unchanged (this could happen, for instance, if the given
37 * PP_Var is not of type PP_VARTYPE_ARRAY_BUFFER). Note that ByteLength() will
38 * successfully retrieve the the size of an ArrayBuffer even if the
39 * ArrayBuffer is not currently mapped.
34 * 40 *
35 * @return The length of the VarArrayBuffer in bytes. 41 * @param[in] array The ArrayBuffer whose length should be returned.
42 *
43 * @param[out] byte_length A variable which is set to the length of the given
44 * ArrayBuffer on success.
45 *
46 * @return PP_TRUE on success, PP_FALSE on failure.
36 */ 47 */
37 uint32_t ByteLength([in] PP_Var array); 48 PP_Bool ByteLength([in] PP_Var array, [out] uint32_t byte_length);
49
38 /** 50 /**
39 * Returns a pointer to the beginning of the buffer for the given array. 51 * Maps the ArrayBuffer in to the module's address space and returns a pointer
52 * to the beginning of the buffer for the given ArrayBuffer PP_Var. Note that
53 * calling Map() can be a relatively expensive operation. Use care when
54 * calling it in performance-critical code. For example, you should call it
55 * only once when looping over an ArrayBuffer:
40 * 56 *
41 * @param[in] array The array whose buffer should be returned. 57 * <code>
58 * char* data = (char*)(array_buffer_if.Map(array_buffer_var));
59 * uint32_t byte_length = 0;
60 * PP_Bool ok = array_buffer_if.ByteLength(array_buffer_var, &byte_length);
61 * if (!ok)
62 * return DoSomethingBecauseMyVarIsNotAnArrayBuffer();
63 * for (uint32_t i = 0; i < byte_length; ++i)
64 * data[i] = 'A';
65 * </code>
42 * 66 *
43 * @return A pointer to the buffer for this array. 67 * @param[in] array The ArrayBuffer whose internal buffer should be returned.
68 *
69 * @return A pointer to the internal buffer for this ArrayBuffer. Returns NULL
70 * if the given PP_Var is not of type PP_VARTYPE_ARRAY_BUFFER.
44 */ 71 */
45 mem_t Map([in] PP_Var array); 72 mem_t Map([in] PP_Var array);
73
74 /**
75 * Unmaps the given ArrayBuffer var from the module address space. Use this if
76 * you want to save memory but might want to Map the buffer again later. The
77 * PP_Var remains valid and should still be released using PPB_Var when you
78 * are done with the ArrayBuffer.
79 *
80 * @param[in] array The ArrayBuffer which should be released.
81 */
82 void Unmap([in] PP_Var array);
46 }; 83 };
47 84
OLDNEW
« no previous file with comments | « no previous file | ppapi/c/dev/ppb_var_array_buffer_dev.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698