Added in API level 34

VirtualDisplayConfig


class VirtualDisplayConfig : Parcelable
kotlin.Any
   ↳ android.hardware.display.VirtualDisplayConfig

Holds configuration used to create VirtualDisplay instances.

Summary

Nested classes
abstract

Listener for display brightness changes.

A builder for VirtualDisplayConfig.

Inherited constants
Public methods
Int

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

Boolean
equals(other: Any?)

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

Float

Returns the default brightness of the display.

Int

Returns the density of the virtual display in dpi.

Float

Returns the dim brightness of the display.

MutableSet<String!>

Returns the display categories.

Int

Returns the virtual display flags.

Int

Returns the height of the virtual display in pixels.

String

Returns the name of the virtual display.

Float

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?

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

Int

Returns the width of the virtual display in pixels.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<VirtualDisplayConfig!>

Public methods

describeContents

Added in API level 34
fun describeContents(): Int

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(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
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
fun equals(other: Any?): Boolean

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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getDefaultBrightness

Added in API level 36
fun getDefaultBrightness(): Float

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.

Return
Float Value is between 0.0f and 1.0f inclusive

getDensityDpi

Added in API level 34
fun getDensityDpi(): Int

Returns the density of the virtual display in dpi.

getDimBrightness

Added in API level 36
fun getDimBrightness(): Float

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.

Return
Float Value is between 0.0f and 1.0f inclusive

getDisplayCategories

Added in API level 34
fun getDisplayCategories(): MutableSet<String!>

Returns the display categories.

Return
MutableSet<String!> This value cannot be null.

getFlags

Added in API level 34
fun getFlags(): Int

Returns the virtual display flags.

getHeight

Added in API level 34
fun getHeight(): Int

Returns the height of the virtual display in pixels.

getName

Added in API level 34
fun getName(): String

Returns the name of the virtual display.

Return
String This value cannot be null.

getRequestedRefreshRate

Added in API level 34
fun getRequestedRefreshRate(): Float

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.

getSurface

Added in API level 34
fun getSurface(): Surface?

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

Return
Surface? This value may be null.

getWidth

Added in API level 34
fun getWidth(): Int

Returns the width of the virtual display in pixels.

hashCode

Added in API level 34
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

toString

Added in API level 34
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

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_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<VirtualDisplayConfig!>