| Index: ppapi/api/dev/ppb_var_array_dev.idl
|
| diff --git a/ppapi/api/dev/ppb_var_array_dev.idl b/ppapi/api/dev/ppb_var_array_dev.idl
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..78db3b0e9cb32423c16ee8fc0e554c6ba50d4198
|
| --- /dev/null
|
| +++ b/ppapi/api/dev/ppb_var_array_dev.idl
|
| @@ -0,0 +1,76 @@
|
| +/* Copyright (c) 2013 The Chromium Authors. All rights reserved.
|
| + * Use of this source code is governed by a BSD-style license that can be
|
| + * found in the LICENSE file.
|
| + */
|
| +
|
| +/**
|
| + * This file defines the <code>PPB_VarArray_Dev</code> struct providing
|
| + * a way to interact with array vars.
|
| + */
|
| +
|
| +label Chrome {
|
| + M27 = 0.1
|
| +};
|
| +
|
| +[macro="PPB_VAR_ARRAY_DEV_INTERFACE"]
|
| +interface PPB_VarArray_Dev {
|
| + /**
|
| + * Creates an array var, i.e., a <code>PP_Var</code> with type set to
|
| + * <code>PP_VARTYPE_ARRAY</code>. The array length is set to 0.
|
| + *
|
| + * @return An empty array var, whose reference count is set to 1 on behalf of
|
| + * the caller.
|
| + */
|
| + PP_Var Create();
|
| +
|
| + /**
|
| + * Gets an element from the array.
|
| + *
|
| + * @param[in] array An array var.
|
| + * @param[in] index An index indicating which element to return.
|
| + *
|
| + * @return The element at the specified position. The reference count is
|
| + * incremented on behalf of the caller. If <code>index</code> is larger than
|
| + * or equal to the array length, an undefined var is returned.
|
| + */
|
| + PP_Var Get([in] PP_Var array, [in] uint32_t index);
|
| +
|
| + /**
|
| + * Sets the value of an element in the array.
|
| + *
|
| + * @param[in] array An array var.
|
| + * @param[in] index An index indicating which element to modify. If
|
| + * <code>index</code> is larger than or equal to the array length, the length
|
| + * is updated to be <code>index</code> + 1. Any position in the array that
|
| + * hasn't been set before is set to undefined, i.e., <code>PP_Var</code> of
|
| + * type <code>PP_VARTYPE_UNDEFINED</code>.
|
| + * @param[in] value The value to set. The array holds a reference to it on
|
| + * success.
|
| + *
|
| + * @return A <code>PP_Bool</code> indicating whether the operation succeeds.
|
| + */
|
| + PP_Bool Set([in] PP_Var array, [in] uint32_t index, [in] PP_Var value);
|
| +
|
| + /**
|
| + * Gets the array length.
|
| + *
|
| + * @param[in] array An array var.
|
| + *
|
| + * @return The array length.
|
| + */
|
| + uint32_t GetLength([in] PP_Var array);
|
| +
|
| + /**
|
| + * Sets the array length.
|
| + *
|
| + * @param[in] array An array var.
|
| + * @param[in] length The new array length. If <code>length</code> is smaller
|
| + * than its current value, the array is truncated to the new length; any
|
| + * elements that no longer fit are removed. If <code>length</code> is larger
|
| + * than its current value, undefined vars are appended to increase the array
|
| + * to the specified length.
|
| + *
|
| + * @return A <code>PP_Bool</code> indicating whether the operation succeeds.
|
| + */
|
| + PP_Bool SetLength([in] PP_Var array, [in] uint32_t length);
|
| +};
|
|
|