OLD | NEW |
| (Empty) |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef PPAPI_CPP_DEV_VAR_ARRAY_BUFFER_DEV_H_ | |
6 #define PPAPI_CPP_DEV_VAR_ARRAY_BUFFER_DEV_H_ | |
7 | |
8 #include "ppapi/cpp/var.h" | |
9 | |
10 /// @file | |
11 /// This file defines the API for interacting with an ArrayBuffer. | |
12 | |
13 namespace pp { | |
14 | |
15 /// VarArrayBuffer_Dev provides a way to interact with JavaScript ArrayBuffers, | |
16 /// which represent a contiguous sequence of bytes. Note that | |
17 /// VarArrayBuffer_Devs are not part of the embedding page's DOM, and can only | |
18 /// be shared with JavaScript via pp::Instance's PostMessage and HandleMessage | |
19 /// functions. | |
20 class VarArrayBuffer_Dev : public Var { | |
21 public: | |
22 /// Contruct a VarArrayBuffer_Dev given a var for which is_array_buffer() is | |
23 /// true. This will refer to the same buffer as var, but allows you to access | |
24 /// methods specific to VarArrayBuffer_Dev. | |
25 /// | |
26 /// @param[in] var An array buffer Var. | |
27 explicit VarArrayBuffer_Dev(const Var& var); | |
28 | |
29 VarArrayBuffer_Dev(const VarArrayBuffer_Dev& buffer) : Var(buffer) {} | |
30 | |
31 /// Construct a new VarArrayBuffer_Dev which is size_in_bytes bytes long and | |
32 /// initialized to zero. | |
33 /// | |
34 /// @param[in] size_in_bytes The size of the constructed array in bytes. | |
35 VarArrayBuffer_Dev(uint32_t size_in_bytes); | |
36 | |
37 /// Return the length of the VarArrayBuffer_Dev in bytes. | |
38 /// | |
39 /// @return The length of the VarArrayBuffer_Dev in bytes. | |
40 uint32_t ByteLength() const; | |
41 | |
42 /// Return a pointer to the buffer associated with this VarArrayBuffer_Dev. | |
43 /// | |
44 /// @return A pointer to the buffer associated with this VarArrayBuffer_Dev. | |
45 void* Map(); | |
46 const void* Map() const; | |
47 | |
48 virtual ~VarArrayBuffer_Dev() {} | |
49 | |
50 private: | |
51 // We cache the buffer so that repeated calls to Map() are quick. | |
52 void* buffer_; | |
53 }; | |
54 | |
55 } // namespace pp | |
56 | |
57 #endif // PPAPI_CPP_DEV_VAR_ARRAY_BUFFER_DEV_H_ | |
OLD | NEW |