| OLD | NEW |
|---|
| (Empty) |
| 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 | |
| 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 ArrayBuffer as var, but allows you to | |
| 24 /// access methods specific to VarArrayBuffer_Dev. | |
| 25 /// | |
| 26 /// @param[in] var An ArrayBuffer Var. | |
| 27 explicit VarArrayBuffer_Dev(const Var& var); | |
| 28 | |
| 29 /// Copy constructor. | |
| 30 VarArrayBuffer_Dev(const VarArrayBuffer_Dev& buffer) : Var(buffer) {} | |
| 31 | |
| 32 virtual ~VarArrayBuffer_Dev() {} | |
| 33 | |
| 34 /// This function assigns one VarArrayBuffer to another VarArrayBuffer. | |
| 35 /// | |
| 36 /// @param[in] other The VarArrayBuffer to be assigned. | |
| 37 /// | |
| 38 /// @return The resulting VarArrayBuffer. | |
| 39 VarArrayBuffer_Dev& operator=(const VarArrayBuffer_Dev& other); | |
| 40 | |
| 41 /// This function assigns one VarArrayBuffer to another VarArrayBuffer. Var's | |
| 42 /// assignment operator is overloaded here so that we can check for assigning | |
| 43 /// a non-ArrayBuffer var to a VarArrayBuffer_Dev. | |
| 44 /// | |
| 45 /// @param[in] other The VarArrayBuffer to be assigned. | |
| 46 /// | |
| 47 /// @return The resulting VarArrayBuffer (as a Var&). | |
| 48 virtual Var& operator=(const Var& other); | |
| 49 | |
| 50 /// Construct a new VarArrayBuffer_Dev which is size_in_bytes bytes long and | |
| 51 /// initialized to zero. | |
| 52 /// | |
| 53 /// @param[in] size_in_bytes The size of the constructed ArrayBuffer in bytes. | |
| 54 VarArrayBuffer_Dev(uint32_t size_in_bytes); | |
| 55 | |
| 56 /// Return the length of the VarArrayBuffer_Dev in bytes. | |
| 57 /// | |
| 58 /// @return The length of the VarArrayBuffer_Dev in bytes. | |
| 59 uint32_t ByteLength() const; | |
| 60 | |
| 61 /// Maps the ArrayBuffer in to the module's address space and returns a | |
| 62 /// pointer to the internal buffer for this ArrayBuffer. | |
| 63 /// | |
| 64 /// Note that calling Map() can be a relatively expensive operation. Use care | |
| 65 /// when calling it in performance-critical code. For example, you should call | |
| 66 /// it only once when looping over an ArrayBuffer: | |
| 67 /// | |
| 68 /// <code> | |
| 69 /// char* data = static_cast<char*>(array_buffer_var.Map()); | |
| 70 /// uint32_t byte_length = array_buffer_var.ByteLength(); | |
| 71 /// for (uint32_t i = 0; i < byte_length; ++i) | |
| 72 /// data[i] = 'A'; | |
| 73 /// </code> | |
| 74 /// | |
| 75 /// @return A pointer to the internal buffer for this ArrayBuffer. | |
| 76 void* Map(); | |
| 77 | |
| 78 /// Unmaps this ArrayBuffer var from the module address space. Use this if | |
| 79 /// you want to save memory but might want to Map the buffer again later. | |
| 80 void Unmap(); | |
| 81 }; | |
| 82 | |
| 83 } // namespace pp | |
| 84 | |
| 85 #endif // PPAPI_CPP_DEV_VAR_ARRAY_BUFFER_DEV_H_ | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 9107046:
PPAPI: Move PPB_ArrayBuffer out of Dev. (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src