summaryrefslogtreecommitdiffstats
path: root/o3d/plugin/idl/raw_data.idl
diff options
context:
space:
mode:
Diffstat (limited to 'o3d/plugin/idl/raw_data.idl')
-rw-r--r--o3d/plugin/idl/raw_data.idl88
1 files changed, 88 insertions, 0 deletions
diff --git a/o3d/plugin/idl/raw_data.idl b/o3d/plugin/idl/raw_data.idl
new file mode 100644
index 0000000..8089d71
--- /dev/null
+++ b/o3d/plugin/idl/raw_data.idl
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2009, Google Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ * * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace o3d {
+
+%[
+ A RawData object contains raw binary data which could contain
+ image, audio, text, or other information.
+
+ \code
+ var request = g_pack.createArchiveRequest();
+
+ request.onfileavailable = function() {
+ var texture = g_pack.createTextureFromRawData(request.data, true);
+ ...
+ };
+
+ request.send();
+
+ \endcode
+%]
+
+[nocpp, include="import/cross/raw_data.h"] class RawData : ParamObject {
+ %[
+ Returns the raw data as a string. The data must be a valid utf-8 string
+ and the uri must end in .json, .txt, .xml, .ini or .csv
+ %]
+ [getter, userglue_getter, StringValue] String string_value;
+
+ %[
+ The uri of the RawData.
+ %]
+ [getter] String uri;
+
+ %[
+ The length in bytes of the RawData.
+ %]
+ [getter=GetLength] size_t length;
+
+ %[
+ Discards all the resources associated with this data object.
+ %]
+ void Discard();
+
+ %[
+ Flushes the memory resources associated with this data object,
+ but keeps a cache in case the data object is used later.
+ %]
+ void Flush();
+
+ [verbatim=cpp_glue, include="import/cross/raw_data.h"] %{
+ o3d::String userglue_getter_string_value(
+ o3d::RawData* self) {
+ return self->StringValue();
+ }
+ %}
+
+};
+
+} // namespace o3d