summaryrefslogtreecommitdiffstats
path: root/core/java/android/hardware
diff options
context:
space:
mode:
authorScott Main <smain@google.com>2013-10-16 16:40:25 -0700
committerAndroid Git Automerger <android-git-automerger@android.com>2013-10-16 16:40:25 -0700
commit842bc9c325879c94fc729103c2f21707c1b6a142 (patch)
tree991685f0a419480ab42a821da50c8097e20fd9d4 /core/java/android/hardware
parent028f771d7bfe351efe7c2fd5d3a81b9d82e897d9 (diff)
parent3d66877b93c037a81f40d896b74b507c57926c54 (diff)
downloadframeworks_base-842bc9c325879c94fc729103c2f21707c1b6a142.zip
frameworks_base-842bc9c325879c94fc729103c2f21707c1b6a142.tar.gz
frameworks_base-842bc9c325879c94fc729103c2f21707c1b6a142.tar.bz2
am 3d66877b: am 0763e156: am 89ec7c78: Merge "some javadoc improvements for virtual display and new meta tag name" into klp-dev
* commit '3d66877b93c037a81f40d896b74b507c57926c54': some javadoc improvements for virtual display and new meta tag name
Diffstat (limited to 'core/java/android/hardware')
-rw-r--r--core/java/android/hardware/display/VirtualDisplay.java8
1 files changed, 7 insertions, 1 deletions
diff --git a/core/java/android/hardware/display/VirtualDisplay.java b/core/java/android/hardware/display/VirtualDisplay.java
index 908aadd..01e5bac 100644
--- a/core/java/android/hardware/display/VirtualDisplay.java
+++ b/core/java/android/hardware/display/VirtualDisplay.java
@@ -19,7 +19,13 @@ import android.os.IBinder;
import android.view.Display;
/**
- * Represents a virtual display.
+ * Represents a virtual display. The content of a virtual display is rendered to a
+ * {@link android.view.Surface} that you must provide to {@link DisplayManager#createVirtualDisplay
+ * createVirtualDisplay()}.
+ * <p>Because a virtual display renders to a surface provided by the application, it will be
+ * released automatically when the process terminates and all remaining windows on it will
+ * be forcibly removed. However, you should also explicitly call {@link #release} when you're
+ * done with it.
*
* @see DisplayManager#createVirtualDisplay
*/