public final class VirtualDisplayConfig
extends Object implements Parcelable


Holds configuration used to create VirtualDisplay instances.

Summary

Nested classes

interface VirtualDisplayConfig.BrightnessListener

Listener for display brightness changes. 

class VirtualDisplayConfig.Builder

A builder for VirtualDisplayConfig. 

Inherited constants

From interface android.os.Parcelable

int CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

int PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields

public static final Creator<VirtualDisplayConfig> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

float getDefaultBrightness()

Returns the default brightness of the display.

int getDensityDpi()

Returns the density of the virtual display in dpi.

float getDimBrightness()

Returns the dim brightness of the display.

Set<String> getDisplayCategories()

Returns the display categories.

int getFlags()

Returns the virtual display flags.

int getHeight()

Returns the height of the virtual display in pixels.

String getName()

Returns the name of the virtual display.

float getRequestedRefreshRate()

Returns the refresh rate of a virtual display in frames per second, or zero if it is using a default refresh rate chosen by the system.

Surface getSurface()

Returns the surface to which the content of the virtual display should be rendered, if any.

int getWidth()

Returns the width of the virtual display in pixels.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface android.os.Parcelable

abstract int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34 

public static final Creator<VirtualDisplayConfig> CREATOR

Public methods

describeContents

Added in API level 34 

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 34 

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getDefaultBrightness

Added in API level 36 

public float getDefaultBrightness ()

Returns the default brightness of the display.

Value of 0.0 indicates the minimum supported brightness and value of 1.0 indicates the maximum supported brightness.

Returns
float Value is between 0.0f and 1.0f inclusive

getDensityDpi

Added in API level 34 

public int getDensityDpi ()

Returns the density of the virtual display in dpi.

Returns
int

getDimBrightness

Added in API level 36 

public float getDimBrightness ()

Returns the dim brightness of the display.

Value of 0.0 indicates the minimum supported brightness and value of 1.0 indicates the maximum supported brightness.

Returns
float Value is between 0.0f and 1.0f inclusive

getDisplayCategories

Added in API level 34 

public Set<String> getDisplayCategories ()

Returns the display categories.

Returns
Set<String> This value cannot be null.

getFlags

Added in API level 34 

public int getFlags ()

Returns the virtual display flags.

Returns
int

See also:

getHeight

Added in API level 34 

public int getHeight ()

Returns the height of the virtual display in pixels.

Returns
int

getName

Added in API level 34 

public String getName ()

Returns the name of the virtual display.

Returns
String This value cannot be null.

getRequestedRefreshRate

Added in API level 34 

public float getRequestedRefreshRate ()

Returns the refresh rate of a virtual display in frames per second, or zero if it is using a default refresh rate chosen by the system.

Returns
float

getSurface

Added in API level 34 

public Surface getSurface ()

Returns the surface to which the content of the virtual display should be rendered, if any.

Returns
Surface This value may be null.

See also:

getWidth

Added in API level 34 

public int getWidth ()

Returns the width of the virtual display in pixels.

Returns
int

hashCode

Added in API level 34 

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns
int a hash code value for this object.

toString

Added in API level 34 

public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

Added in API level 34 

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-02-26 UTC.