public
final
class
VirtualDisplay
extends Object
java.lang.Object | |
↳ | android.hardware.display.VirtualDisplay |
Represents a virtual display. The content of a virtual display is rendered to a
Surface
that you must provide to createVirtualDisplay()
.
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 release()
when
you're done with it.
Nested classes | |
---|---|
class |
VirtualDisplay.Callback
Interface for receiving information about a |
Public methods | |
---|---|
Display
|
getDisplay()
Gets the virtual display. |
Surface
|
getSurface()
Gets the surface that backs the virtual display. |
void
|
release()
Releases the virtual display and destroys its underlying surface. |
void
|
resize(int width, int height, int densityDpi)
Asks the virtual display to resize. |
void
|
setSurface(Surface surface)
Sets the surface that backs the virtual display. |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Surface getSurface ()
Gets the surface that backs the virtual display.
Returns | |
---|---|
Surface |
void release ()
Releases the virtual display and destroys its underlying surface.
All remaining windows on the virtual display will be forcibly removed as part of releasing the virtual display.
void resize (int width, int height, int densityDpi)
Asks the virtual display to resize.
This is really just a convenience to allow applications using virtual displays to adapt to changing conditions without having to tear down and recreate the display.
Parameters | |
---|---|
width |
int
|
height |
int
|
densityDpi |
int
|
void setSurface (Surface surface)
Sets the surface that backs the virtual display.
Detaching the surface that backs a virtual display has a similar effect to turning off the screen.
It is still the caller's responsibility to destroy the surface after it has been detached.
Parameters | |
---|---|
surface |
Surface :
The surface to set, or null to detach the surface from the virtual display.
|
String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |