Changeset 24490 in vbox for trunk/src/VBox/Main/idl

Timestamp:

Nov 9, 2009 11:23:35 AM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

54575

Message:

Saved state screenshot API stubs (xTracker 4364).

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -4097 +4097 @@
   <interface
      name="IMachine" extends="$unknown"
-     uuid="e2e5bab4-16ff-4ef4-b9df-f0b4433c1d1b"
+     uuid="25472915-3da2-42f6-82f2-70a3bc74d73c"
      wsmap="managed"
      >
@@ -5762 +5762 @@
       </param>
     </method>
+
+    <method name="querySavedThumbnailSize">
+      <desc>
+        Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
+      </desc>
+      <param name="size" type="unsigned long" dir="out">
+        <desc>
+          Size of buffer required to store the bitmap.
+        </desc>
+      </param>
+      <param name="width" type="unsigned long" dir="out">
+        <desc>
+          Bitmap width.
+        </desc>
+      </param>
+      <param name="height" type="unsigned long" dir="out">
+        <desc>
+          Bitmap height.
+        </desc>
+      </param>
+    </method>
+
+    <method name="readSavedThumbnail">
+      <desc>
+        Reads a saved thumbnail bitmap from saved state.
+        A pixel consists of 4 bytes in order: B, G, R, 0.
+
+        <note>This API can be used only by the COM/XPCOM C++ API as it
+            requires pointer support. Use <link to="#readSavedThumbnailToArray" />
+            with other language bindings.
+        </note>
+      </desc>
+      <param name="address" type="octet" mod="ptr" dir="in">
+        <desc>
+          Buffer allocated by caller. Size must be at least equal
+          to value returned by querySavedThumbnailSize.
+        </desc>
+      </param>
+      <param name="size" type="unsigned long" dir="in">
+        <desc>
+          Size of buffer allocated by caller. If the buffer is too small,
+          the method fails. 
+        </desc>
+      </param>
+    </method>
+
+    <method name="readSavedThumbnailToArray">
+      <desc>
+        Thumbnail is retrieved to an array of bytes in uncompressed 32-bit RGBA format.
+        A pixel consists of 4 bytes in order: R, G, B, 0xFF.
+
+        This API is slow, but could be the only option to get image
+        for scriptable languages not allowed to manipulate with addresses
+        directly.
+      </desc>
+      <param name="width" type="unsigned long" dir="out">
+        <desc>
+          Bitmap width.
+        </desc>
+      </param>
+      <param name="height" type="unsigned long" dir="out">
+        <desc>
+          Bitmap height.
+        </desc>
+      </param>
+      <param name="data" type="octet" dir="return" safearray="yes">
+        <desc>
+          Array with resulting bitmap data.
+        </desc>
+      </param>
+    </method>
+
+    <method name="querySavedScreenshotPNGSize">
+      <desc>
+        Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
+      </desc>
+      <param name="size" type="unsigned long" dir="out">
+        <desc>
+          Size of buffer required to store the PNG binary data.
+        </desc>
+      </param>
+      <param name="width" type="unsigned long" dir="out">
+        <desc>
+          Image width.
+        </desc>
+      </param>
+      <param name="height" type="unsigned long" dir="out">
+        <desc>
+          Image height.
+        </desc>
+      </param>
+    </method>
+
+    <method name="readSavedScreenshotPNG">
+      <desc>
+        Reads a saved screenshot in PNG format from saved state.
+
+        <note>This API can be used only by the COM/XPCOM C++ API as it
+            requires pointer support. Use <link to="#readSavedScreenshotPNGToArray" />
+            with other language bindings.
+        </note>
+      </desc>
+      <param name="address" type="octet" mod="ptr" dir="in">
+        <desc>
+          Buffer allocated by caller. Size must be at least equal
+          to value returned by querySavedScreenshotPNGSize.
+        </desc>
+      </param>
+      <param name="size" type="unsigned long" dir="in">
+        <desc>
+          Size of buffer allocated by caller. If the buffer is too small,
+          the method fails. 
+        </desc>
+      </param>
+    </method>
+
+    <method name="readSavedScreenshotPNGToArray">
+      <desc>
+        Screenshot in PNG format is retrieved to an array of bytes.
+
+        This API is slow, but could be the only option to get image
+        for scriptable languages not allowed to manipulate with addresses
+        directly.
+      </desc>
+      <param name="width" type="unsigned long" dir="out">
+        <desc>
+          Image width.
+        </desc>
+      </param>
+      <param name="height" type="unsigned long" dir="out">
+        <desc>
+          Image height.
+        </desc>
+      </param>
+      <param name="data" type="octet" dir="return" safearray="yes">
+        <desc>
+          Array with resulting PNG data.
+        </desc>
+      </param>
+    </method>
 </interface>