1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367
|
/*
* Copyright (C) 2006 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.view;
import static android.Manifest.permission.CONFIGURE_DISPLAY_COLOR_MODE;
import static android.Manifest.permission.CONTROL_DISPLAY_BRIGHTNESS;
import android.Manifest;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresPermission;
import android.annotation.SuppressLint;
import android.annotation.TestApi;
import android.app.KeyguardManager;
import android.app.WindowConfiguration;
import android.compat.annotation.UnsupportedAppUsage;
import android.content.res.CompatibilityInfo;
import android.content.res.Configuration;
import android.content.res.Resources;
import android.graphics.ColorSpace;
import android.graphics.PixelFormat;
import android.graphics.Point;
import android.graphics.Rect;
import android.hardware.display.BrightnessInfo;
import android.hardware.display.DeviceProductInfo;
import android.hardware.display.DisplayManager;
import android.hardware.display.DisplayManagerGlobal;
import android.hardware.graphics.common.DisplayDecorationSupport;
import android.os.Build;
import android.os.Parcel;
import android.os.Parcelable;
import android.os.Process;
import android.os.SystemClock;
import android.util.ArraySet;
import android.util.DisplayMetrics;
import android.util.Log;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* Provides information about the size and density of a logical display.
* <p>
* The display area is described in two different ways.
* <ul>
* <li>The application display area specifies the part of the display that may contain
* an application window, excluding the system decorations. The application display area may
* be smaller than the real display area because the system subtracts the space needed
* for decor elements such as the status bar. Use {@link WindowMetrics#getBounds()} to query the
* application window bounds.</li>
* <li>The real display area specifies the part of the display that is accessible to an application
* in the current system state. The real display area may be smaller than the physical size of the
* display in a few scenarios. Use {@link WindowManager#getCurrentWindowMetrics()} to identify the
* current size of the activity window. UI-related work, such as choosing UI layouts, should rely
* upon {@link WindowMetrics#getBounds()}. See {@link #getRealSize} / {@link #getRealMetrics} for
* details.</li>
* </ul>
* </p><p>
* A logical display does not necessarily represent a particular physical display device
* such as the internal display or an external display. The contents of a logical
* display may be presented on one or more physical displays according to the devices
* that are currently attached and whether mirroring has been enabled.
* </p>
*/
public final class Display {
private static final String TAG = "Display";
private static final boolean DEBUG = false;
private final Object mLock = new Object();
private final DisplayManagerGlobal mGlobal;
private final int mDisplayId;
private final int mFlags;
private final int mType;
private final int mOwnerUid;
private final String mOwnerPackageName;
private final Resources mResources;
private DisplayAdjustments mDisplayAdjustments;
@UnsupportedAppUsage
private DisplayInfo mDisplayInfo; // never null
private boolean mIsValid;
// Temporary display metrics structure used for compatibility mode.
private final DisplayMetrics mTempMetrics = new DisplayMetrics();
// We cache the app width and height properties briefly between calls
// to getHeight() and getWidth() to ensure that applications perceive
// consistent results when the size changes (most of the time).
// Applications should now be using WindowMetrics instead.
private static final int CACHED_APP_SIZE_DURATION_MILLIS = 20;
private long mLastCachedAppSizeUpdate;
private int mCachedAppWidthCompat;
private int mCachedAppHeightCompat;
/**
* The default Display id, which is the id of the primary display assuming there is one.
*/
public static final int DEFAULT_DISPLAY = 0;
/**
* Invalid display id.
*/
public static final int INVALID_DISPLAY = -1;
/**
* Invalid resolution width.
* @hide
*/
public static final int INVALID_DISPLAY_WIDTH = -1;
/**
* Invalid resolution height.
* @hide
*/
public static final int INVALID_DISPLAY_HEIGHT = -1;
/**
* Invalid refresh rate.
* @hide
*/
public static final float INVALID_DISPLAY_REFRESH_RATE = 0.0f;
/**
* The default display group id, which is the display group id of the primary display assuming
* there is one.
* @hide
*/
public static final int DEFAULT_DISPLAY_GROUP = 0;
/**
* Invalid display group id.
* @hide
*/
public static final int INVALID_DISPLAY_GROUP = -1;
/**
* Display flag: Indicates that the display supports compositing content
* that is stored in protected graphics buffers.
* <p>
* If this flag is set then the display device supports compositing protected buffers.
* </p><p>
* If this flag is not set then the display device may not support compositing
* protected buffers; the user may see a blank region on the screen instead of
* the protected content.
* </p><p>
* Secure (DRM) video decoders may allocate protected graphics buffers to request that
* a hardware-protected path be provided between the video decoder and the external
* display sink. If a hardware-protected path is not available, then content stored
* in protected graphics buffers may not be composited.
* </p><p>
* An application can use the absence of this flag as a hint that it should not use protected
* buffers for this display because the content may not be visible. For example,
* if the flag is not set then the application may choose not to show content on this
* display, show an informative error message, select an alternate content stream
* or adopt a different strategy for decoding content that does not rely on
* protected buffers.
* </p>
*
* @see #getFlags
*/
public static final int FLAG_SUPPORTS_PROTECTED_BUFFERS = 1 << 0;
/**
* Display flag: Indicates that the display has a secure video output and
* supports compositing secure surfaces.
* <p>
* If this flag is set then the display device has a secure video output
* and is capable of showing secure surfaces. It may also be capable of
* showing {@link #FLAG_SUPPORTS_PROTECTED_BUFFERS protected buffers}.
* </p><p>
* If this flag is not set then the display device may not have a secure video
* output; the user may see a blank region on the screen instead of
* the contents of secure surfaces or protected buffers.
* </p><p>
* Secure surfaces are used to prevent content rendered into those surfaces
* by applications from appearing in screenshots or from being viewed
* on non-secure displays. Protected buffers are used by secure video decoders
* for a similar purpose.
* </p><p>
* An application creates a window with a secure surface by specifying the
* {@link WindowManager.LayoutParams#FLAG_SECURE} window flag.
* Likewise, an application creates a {@link SurfaceView} with a secure surface
* by calling {@link SurfaceView#setSecure} before attaching the secure view to
* its containing window.
* </p><p>
* An application can use the absence of this flag as a hint that it should not create
* secure surfaces or protected buffers on this display because the content may
* not be visible. For example, if the flag is not set then the application may
* choose not to show content on this display, show an informative error message,
* select an alternate content stream or adopt a different strategy for decoding
* content that does not rely on secure surfaces or protected buffers.
* </p>
*
* @see #getFlags
*/
public static final int FLAG_SECURE = 1 << 1;
/**
* Display flag: Indicates that the display is private. Only the application that
* owns the display and apps that are already on the display can create windows on it.
*
* @see #getFlags
*/
public static final int FLAG_PRIVATE = 1 << 2;
/**
* Display flag: Indicates that the display is a presentation display.
* <p>
* This flag identifies secondary displays that are suitable for
* use as presentation displays such as external or wireless displays. Applications
* may automatically project their content to presentation displays to provide
* richer second screen experiences.
* </p>
*
* @see #getFlags
*/
public static final int FLAG_PRESENTATION = 1 << 3;
/**
* Display flag: Indicates that the display has a round shape.
* <p>
* This flag identifies displays that are circular, elliptical or otherwise
* do not permit the user to see all the way to the logical corners of the display.
* </p>
*
* @see #getFlags
*/
public static final int FLAG_ROUND = 1 << 4;
/**
* Display flag: Indicates that the display can show its content when non-secure keyguard is
* shown.
* <p>
* This flag identifies secondary displays that will continue showing content if keyguard can be
* dismissed without entering credentials.
* </p><p>
* An example of usage is a virtual display which content is displayed on external hardware
* display that is not visible to the system directly.
* </p>
*
* @see DisplayManager#VIRTUAL_DISPLAY_FLAG_CAN_SHOW_WITH_INSECURE_KEYGUARD
* @see KeyguardManager#isDeviceSecure()
* @see KeyguardManager#isDeviceLocked()
* @see #getFlags
* @hide
*/
// TODO (b/114338689): Remove the flag and use IWindowManager#shouldShowWithInsecureKeyguard
public static final int FLAG_CAN_SHOW_WITH_INSECURE_KEYGUARD = 1 << 5;
/**
* Display flag: Indicates that the display should show system decorations.
* <p>
* This flag identifies secondary displays that should show system decorations, such as status
* bar, navigation bar, home activity or IME.
* </p>
* <p>Note that this flag doesn't work without {@link #FLAG_TRUSTED}</p>
*
* @see #getFlags()
* @hide
*/
// TODO (b/114338689): Remove the flag and use IWindowManager#setShouldShowSystemDecors
public static final int FLAG_SHOULD_SHOW_SYSTEM_DECORATIONS = 1 << 6;
/**
* Flag: The display is trusted to show system decorations and receive inputs without users'
* touch.
* @see #FLAG_SHOULD_SHOW_SYSTEM_DECORATIONS
*
* @see #getFlags()
* @hide
*/
@TestApi
public static final int FLAG_TRUSTED = 1 << 7;
/**
* Flag: Indicates that the display should not be a part of the default DisplayGroup and
* instead be part of a new DisplayGroup.
*
* @hide
* @see #getFlags()
*/
public static final int FLAG_OWN_DISPLAY_GROUP = 1 << 8;
/**
* Flag: Indicates that the display should always be unlocked. Only valid on virtual displays
* that aren't in the default display group.
*
* @hide
* @see #getFlags()
*/
public static final int FLAG_ALWAYS_UNLOCKED = 1 << 9;
/**
* Flag: Indicates that the display should not play sound effects or perform haptic feedback
* when the user touches the screen.
*
* @hide
* @see #getFlags()
*/
public static final int FLAG_TOUCH_FEEDBACK_DISABLED = 1 << 10;
/**
* Display flag: Indicates that the contents of the display should not be scaled
* to fit the physical screen dimensions. Used for development only to emulate
* devices with smaller physicals screens while preserving density.
*
* @hide
*/
public static final int FLAG_SCALING_DISABLED = 1 << 30;
/**
* Display type: Unknown display type.
* @hide
*/
@UnsupportedAppUsage
@TestApi
public static final int TYPE_UNKNOWN = 0;
/**
* Display type: Physical display connected through an internal port.
* @hide
*/
@TestApi
public static final int TYPE_INTERNAL = 1;
/**
* Display type: Physical display connected through an external port.
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
@TestApi
public static final int TYPE_EXTERNAL = 2;
/**
* Display type: WiFi display.
* @hide
*/
@UnsupportedAppUsage
@TestApi
public static final int TYPE_WIFI = 3;
/**
* Display type: Overlay display.
* @hide
*/
@TestApi
public static final int TYPE_OVERLAY = 4;
/**
* Display type: Virtual display.
* @hide
*/
@UnsupportedAppUsage
@TestApi
public static final int TYPE_VIRTUAL = 5;
/**
* Display state: The display state is unknown.
*
* @see #getState
*/
public static final int STATE_UNKNOWN = ViewProtoEnums.DISPLAY_STATE_UNKNOWN; // 0
/**
* Display state: The display is off.
*
* @see #getState
*/
public static final int STATE_OFF = ViewProtoEnums.DISPLAY_STATE_OFF; // 1
/**
* Display state: The display is on.
*
* @see #getState
*/
public static final int STATE_ON = ViewProtoEnums.DISPLAY_STATE_ON; // 2
/**
* Display state: The display is dozing in a low power state; it is still
* on but is optimized for showing system-provided content while the
* device is non-interactive.
*
* @see #getState
* @see android.os.PowerManager#isInteractive
*/
public static final int STATE_DOZE = ViewProtoEnums.DISPLAY_STATE_DOZE; // 3
/**
* Display state: The display is dozing in a suspended low power state; it is still
* on but the CPU is not updating it. This may be used in one of two ways: to show
* static system-provided content while the device is non-interactive, or to allow
* a "Sidekick" compute resource to update the display. For this reason, the
* CPU must not control the display in this mode.
*
* @see #getState
* @see android.os.PowerManager#isInteractive
*/
public static final int STATE_DOZE_SUSPEND = ViewProtoEnums.DISPLAY_STATE_DOZE_SUSPEND; // 4
/**
* Display state: The display is on and optimized for VR mode.
*
* @see #getState
* @see android.os.PowerManager#isInteractive
*/
public static final int STATE_VR = ViewProtoEnums.DISPLAY_STATE_VR; // 5
/**
* Display state: The display is in a suspended full power state; it is still
* on but the CPU is not updating it. This may be used in one of two ways: to show
* static system-provided content while the device is non-interactive, or to allow
* a "Sidekick" compute resource to update the display. For this reason, the
* CPU must not control the display in this mode.
*
* @see #getState
* @see android.os.PowerManager#isInteractive
*/
public static final int STATE_ON_SUSPEND = ViewProtoEnums.DISPLAY_STATE_ON_SUSPEND; // 6
/* The color mode constants defined below must be kept in sync with the ones in
* system/core/include/system/graphics-base.h */
/**
* Display color mode: The current color mode is unknown or invalid.
* @hide
*/
public static final int COLOR_MODE_INVALID = -1;
/**
* Display color mode: The default or native gamut of the display.
* @hide
*/
public static final int COLOR_MODE_DEFAULT = 0;
/** @hide */
public static final int COLOR_MODE_BT601_625 = 1;
/** @hide */
public static final int COLOR_MODE_BT601_625_UNADJUSTED = 2;
/** @hide */
public static final int COLOR_MODE_BT601_525 = 3;
/** @hide */
public static final int COLOR_MODE_BT601_525_UNADJUSTED = 4;
/** @hide */
public static final int COLOR_MODE_BT709 = 5;
/** @hide */
public static final int COLOR_MODE_DCI_P3 = 6;
/** @hide */
public static final int COLOR_MODE_SRGB = 7;
/** @hide */
public static final int COLOR_MODE_ADOBE_RGB = 8;
/** @hide */
public static final int COLOR_MODE_DISPLAY_P3 = 9;
/** @hide **/
@IntDef(prefix = {"COLOR_MODE_"}, value = {
COLOR_MODE_INVALID,
COLOR_MODE_DEFAULT,
COLOR_MODE_BT601_625,
COLOR_MODE_BT601_625_UNADJUSTED,
COLOR_MODE_BT601_525,
COLOR_MODE_BT601_525_UNADJUSTED,
COLOR_MODE_BT709,
COLOR_MODE_DCI_P3,
COLOR_MODE_SRGB,
COLOR_MODE_ADOBE_RGB,
COLOR_MODE_DISPLAY_P3
})
@Retention(RetentionPolicy.SOURCE)
public @interface ColorMode {}
/**
* Indicates that when display is removed, all its activities will be moved to the primary
* display and the topmost activity should become focused.
*
* @hide
*/
// TODO (b/114338689): Remove the flag and use WindowManager#REMOVE_CONTENT_MODE_MOVE_TO_PRIMARY
public static final int REMOVE_MODE_MOVE_CONTENT_TO_PRIMARY = 0;
/**
* Indicates that when display is removed, all its stacks and tasks will be removed, all
* activities will be destroyed according to the usual lifecycle.
*
* @hide
*/
// TODO (b/114338689): Remove the flag and use WindowManager#REMOVE_CONTENT_MODE_DESTROY
public static final int REMOVE_MODE_DESTROY_CONTENT = 1;
/** @hide */
public static final int DISPLAY_MODE_ID_FOR_FRAME_RATE_OVERRIDE = 0xFF;
/**
* Internal method to create a display.
* The display created with this method will have a static {@link DisplayAdjustments} applied.
* Applications should use {@link android.content.Context#getDisplay} with
* {@link android.app.Activity} or a context associated with a {@link Display} via
* {@link android.content.Context#createDisplayContext(Display)}
* to get a display object associated with a {@link android.app.Context}, or
* {@link android.hardware.display.DisplayManager#getDisplay} to get a display object by id.
*
* @see android.content.Context#getDisplay()
* @see android.content.Context#createDisplayContext(Display)
* @hide
*/
public Display(DisplayManagerGlobal global, int displayId, /*@NotNull*/ DisplayInfo displayInfo,
DisplayAdjustments daj) {
this(global, displayId, displayInfo, daj, null /*res*/);
}
/**
* Internal method to create a display.
* The display created with this method will be adjusted based on the adjustments in the
* supplied {@link Resources}.
*
* @hide
*/
public Display(DisplayManagerGlobal global, int displayId, /*@NotNull*/ DisplayInfo displayInfo,
Resources res) {
this(global, displayId, displayInfo, null /*daj*/, res);
}
private Display(DisplayManagerGlobal global, int displayId,
/*@NotNull*/ DisplayInfo displayInfo, DisplayAdjustments daj, Resources res) {
mGlobal = global;
mDisplayId = displayId;
mDisplayInfo = displayInfo;
mResources = res;
mDisplayAdjustments = mResources != null
? new DisplayAdjustments(mResources.getConfiguration())
: daj != null ? new DisplayAdjustments(daj) : new DisplayAdjustments();
mIsValid = true;
// Cache properties that cannot change as long as the display is valid.
mFlags = displayInfo.flags;
mType = displayInfo.type;
mOwnerUid = displayInfo.ownerUid;
mOwnerPackageName = displayInfo.ownerPackageName;
}
/**
* Gets the display id.
* <p>
* Each logical display has a unique id.
* The default display has id {@link #DEFAULT_DISPLAY}.
* </p>
*/
public int getDisplayId() {
return mDisplayId;
}
/**
* Gets the display unique id.
* <p>
* Unique id is different from display id because physical displays have stable unique id across
* reboots.
*
* @see com.android.service.display.DisplayDevice#hasStableUniqueId().
* @hide
*/
public String getUniqueId() {
return mDisplayInfo.uniqueId;
}
/**
* Returns true if this display is still valid, false if the display has been removed.
*
* If the display is invalid, then the methods of this class will
* continue to report the most recently observed display information.
* However, it is unwise (and rather fruitless) to continue using a
* {@link Display} object after the display's demise.
*
* It's possible for a display that was previously invalid to become
* valid again if a display with the same id is reconnected.
*
* @return True if the display is still valid.
*/
public boolean isValid() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mIsValid;
}
}
/**
* Gets a full copy of the display information.
*
* @param outDisplayInfo The object to receive the copy of the display information.
* @return True if the display is still valid.
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public boolean getDisplayInfo(DisplayInfo outDisplayInfo) {
synchronized (mLock) {
updateDisplayInfoLocked();
outDisplayInfo.copyFrom(mDisplayInfo);
return mIsValid;
}
}
/**
* Gets the display's layer stack.
*
* Each display has its own independent layer stack upon which surfaces
* are placed to be managed by surface flinger.
*
* @return The display's layer stack number.
* @hide
*/
public int getLayerStack() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.layerStack;
}
}
/**
* Returns a combination of flags that describe the capabilities of the display.
*
* @return The display flags.
*
* @see #FLAG_SUPPORTS_PROTECTED_BUFFERS
* @see #FLAG_SECURE
* @see #FLAG_PRIVATE
* @see #FLAG_ROUND
*/
public int getFlags() {
return mFlags;
}
/**
* Gets the display type.
*
* @return The display type.
*
* @see #TYPE_UNKNOWN
* @see #TYPE_INTERNAL
* @see #TYPE_EXTERNAL
* @see #TYPE_WIFI
* @see #TYPE_OVERLAY
* @see #TYPE_VIRTUAL
* @hide
*/
@UnsupportedAppUsage
@TestApi
public int getType() {
return mType;
}
/**
* Gets the display address, or null if none.
* Interpretation varies by display type.
*
* @return The display address.
* @hide
*/
public DisplayAddress getAddress() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.address;
}
}
/**
* Gets the UID of the application that owns this display, or zero if it is
* owned by the system.
* <p>
* If the display is private, then only the owner can use it.
* </p>
*
* @hide
*/
public int getOwnerUid() {
return mOwnerUid;
}
/**
* Gets the package name of the application that owns this display, or null if it is
* owned by the system.
* <p>
* If the display is private, then only the owner can use it.
* </p>
*
* @hide
*/
@UnsupportedAppUsage
public String getOwnerPackageName() {
return mOwnerPackageName;
}
/**
* Gets the compatibility info used by this display instance.
*
* @return The display adjustments holder, or null if none is required.
* @hide
*/
@UnsupportedAppUsage
public DisplayAdjustments getDisplayAdjustments() {
if (mResources != null) {
final DisplayAdjustments currentAdjustments = mResources.getDisplayAdjustments();
if (!mDisplayAdjustments.equals(currentAdjustments)) {
mDisplayAdjustments = new DisplayAdjustments(currentAdjustments);
}
}
return mDisplayAdjustments;
}
/**
* Gets the name of the display.
* <p>
* Note that some displays may be renamed by the user.
* </p>
*
* @return The display's name.
*/
public String getName() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.name;
}
}
/**
* Gets the default brightness configured for the display.
*
* @return Default brightness between 0.0-1.0
* @hide
*/
public float getBrightnessDefault() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.brightnessDefault;
}
}
/**
* @return Brightness information about the display.
* @hide
*/
@RequiresPermission(CONTROL_DISPLAY_BRIGHTNESS)
public @Nullable BrightnessInfo getBrightnessInfo() {
return mGlobal.getBrightnessInfo(mDisplayId);
}
/**
* Gets the size of the display in pixels.
*
* <p>The return value does not necessarily represent the actual size (native resolution) of the
* display. The returned size might be adjusted to exclude certain system decor elements that
* are always visible, or the size might be scaled to provide compatibility with older
* applications that were originally designed for smaller displays.
*
* <p>The returned size can also be different depending on the WindowManager bound to the
* display:
* <ul>
* <li>If size is requested from an activity (either using a WindowManager accessed by
* {@code getWindowManager()} or {@code getSystemService(Context.WINDOW_SERVICE)}), the
* size of the current app window is returned. As a result, in multi-window mode, the
* returned size can be smaller than the size of the device screen.
* <li>If size is requested from a non-activity context (for example, the application
* context, where the WindowManager is accessed by
* {@code getApplicationContext().getSystemService(Context.WINDOW_SERVICE)}), the
* returned size can vary depending on API level:
* <ul>
* <li>API level 29 and below — The size of the entire display (based on
* current rotation) minus system decoration areas is returned.
* <li>API level 30 and above — The size of the top running activity in the
* current process is returned. If the current process has no running
* activities, the size of the device default display, including system
* decoration areas, is returned.
* </ul>
* </ul>
*
* <p>For layout purposes, apps should make a request from an activity context to obtain the
* size of the display area available for app content.
*
* @param outSize A {@link Point} object which receives the display size information.
*
* @deprecated Use {@link WindowMetrics} instead. Obtain a {@code WindowMetrics} instance by
* calling {@link WindowManager#getCurrentWindowMetrics()}, then call
* {@link WindowMetrics#getBounds()} to get the dimensions of the application window.
*/
@Deprecated
public void getSize(Point outSize) {
synchronized (mLock) {
updateDisplayInfoLocked();
mDisplayInfo.getAppMetrics(mTempMetrics, getDisplayAdjustments());
outSize.x = mTempMetrics.widthPixels;
outSize.y = mTempMetrics.heightPixels;
}
}
/**
* Gets the size of the display as a rectangle, in pixels.
*
* @param outSize A {@link Rect} object to receive the size information.
*
* @deprecated Use {@link WindowMetrics#getBounds()} to get the dimensions of the application
* window.
*/
@Deprecated
public void getRectSize(Rect outSize) {
synchronized (mLock) {
updateDisplayInfoLocked();
mDisplayInfo.getAppMetrics(mTempMetrics, getDisplayAdjustments());
outSize.set(0, 0, mTempMetrics.widthPixels, mTempMetrics.heightPixels);
}
}
/**
* Return the range of display sizes an application can expect to encounter
* under normal operation, as long as there is no physical change in screen
* size. This is basically the sizes you will see as the orientation
* changes, taking into account whatever screen decoration there is in
* each rotation. For example, the status bar is always at the top of the
* screen, so it will reduce the height both in landscape and portrait, and
* the smallest height returned here will be the smaller of the two.
*
* This is intended for applications to get an idea of the range of sizes
* they will encounter while going through device rotations, to provide a
* stable UI through rotation. The sizes here take into account all standard
* system decorations that reduce the size actually available to the
* application: the status bar, navigation bar, system bar, etc. It does
* <em>not</em> take into account more transient elements like an IME
* soft keyboard.
*
* @param outSmallestSize Filled in with the smallest width and height
* that the application will encounter, in pixels (not dp units). The x
* (width) dimension here directly corresponds to
* {@link android.content.res.Configuration#smallestScreenWidthDp
* Configuration.smallestScreenWidthDp}, except the value here is in raw
* screen pixels rather than dp units. Your application may of course
* still get smaller space yet if, for example, a soft keyboard is
* being displayed.
* @param outLargestSize Filled in with the largest width and height
* that the application will encounter, in pixels (not dp units). Your
* application may of course still get larger space than this if,
* for example, screen decorations like the status bar are being hidden.
*/
public void getCurrentSizeRange(Point outSmallestSize, Point outLargestSize) {
synchronized (mLock) {
updateDisplayInfoLocked();
outSmallestSize.x = mDisplayInfo.smallestNominalAppWidth;
outSmallestSize.y = mDisplayInfo.smallestNominalAppHeight;
outLargestSize.x = mDisplayInfo.largestNominalAppWidth;
outLargestSize.y = mDisplayInfo.largestNominalAppHeight;
}
}
/**
* Return the maximum screen size dimension that will happen. This is
* mostly for wallpapers.
* @hide
*/
@UnsupportedAppUsage
public int getMaximumSizeDimension() {
synchronized (mLock) {
updateDisplayInfoLocked();
return Math.max(mDisplayInfo.logicalWidth, mDisplayInfo.logicalHeight);
}
}
/**
* @deprecated Use {@link WindowMetrics#getBounds#width()} instead.
*/
@Deprecated
public int getWidth() {
synchronized (mLock) {
updateCachedAppSizeIfNeededLocked();
return mCachedAppWidthCompat;
}
}
/**
* @deprecated Use {@link WindowMetrics#getBounds()#height()} instead.
*/
@Deprecated
public int getHeight() {
synchronized (mLock) {
updateCachedAppSizeIfNeededLocked();
return mCachedAppHeightCompat;
}
}
/**
* Returns the rotation of the screen from its "natural" orientation.
* The returned value may be {@link Surface#ROTATION_0 Surface.ROTATION_0}
* (no rotation), {@link Surface#ROTATION_90 Surface.ROTATION_90},
* {@link Surface#ROTATION_180 Surface.ROTATION_180}, or
* {@link Surface#ROTATION_270 Surface.ROTATION_270}. For
* example, if a device has a naturally tall screen, and the user has
* turned it on its side to go into a landscape orientation, the value
* returned here may be either {@link Surface#ROTATION_90 Surface.ROTATION_90}
* or {@link Surface#ROTATION_270 Surface.ROTATION_270} depending on
* the direction it was turned. The angle is the rotation of the drawn
* graphics on the screen, which is the opposite direction of the physical
* rotation of the device. For example, if the device is rotated 90
* degrees counter-clockwise, to compensate rendering will be rotated by
* 90 degrees clockwise and thus the returned value here will be
* {@link Surface#ROTATION_90 Surface.ROTATION_90}.
*
* This rotation value will match the results of {@link #getMetrics}: this means that the
* rotation value will correspond to the activity if accessed through the activity.
*/
@Surface.Rotation
public int getRotation() {
synchronized (mLock) {
updateDisplayInfoLocked();
return getLocalRotation();
}
}
/**
* Returns the install orientation of the display.
* @hide
*/
@Surface.Rotation
public int getInstallOrientation() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.installOrientation;
}
}
/**
* @deprecated use {@link #getRotation}
* @return orientation of this display.
*/
@Deprecated
@Surface.Rotation
public int getOrientation() {
return getRotation();
}
/**
* Returns the {@link DisplayCutout}, or {@code null} if there is none.
*
* @see DisplayCutout
*/
@Nullable
public DisplayCutout getCutout() {
synchronized (mLock) {
updateDisplayInfoLocked();
if (mResources == null) return mDisplayInfo.displayCutout;
final DisplayCutout localCutout = mDisplayInfo.displayCutout;
if (localCutout == null) return null;
int rotation = getLocalRotation();
if (rotation != mDisplayInfo.rotation) {
return localCutout.getRotated(mDisplayInfo.logicalWidth, mDisplayInfo.logicalHeight,
mDisplayInfo.rotation, rotation);
}
return localCutout;
}
}
/**
* Returns the {@link RoundedCorner} of the given position if there is one.
*
* @param position the position of the rounded corner on the display.
*
* @return the rounded corner of the given position. Returns {@code null} if there is none.
*/
@SuppressLint("VisiblySynchronized")
@Nullable
public RoundedCorner getRoundedCorner(@RoundedCorner.Position int position) {
synchronized (mLock) {
updateDisplayInfoLocked();
final RoundedCorners roundedCorners = mDisplayInfo.roundedCorners;
final @Surface.Rotation int rotation = getLocalRotation();
if (roundedCorners != null && rotation != mDisplayInfo.rotation) {
roundedCorners.rotate(rotation,
mDisplayInfo.logicalWidth, mDisplayInfo.logicalHeight);
}
return roundedCorners == null ? null : roundedCorners.getRoundedCorner(position);
}
}
/**
* Gets the pixel format of the display.
* @return One of the constants defined in {@link android.graphics.PixelFormat}.
*
* @deprecated This method is no longer supported.
* The result is always {@link PixelFormat#RGBA_8888}.
*/
@Deprecated
public int getPixelFormat() {
return PixelFormat.RGBA_8888;
}
/**
* Gets the refresh rate of this display in frames per second.
*/
public float getRefreshRate() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.getRefreshRate();
}
}
/**
* Get the supported refresh rates of this display in frames per second.
* <p>
* This method only returns refresh rates for the display's default modes. For more options, use
* {@link #getSupportedModes()}.
*
* @deprecated use {@link #getSupportedModes()} instead
*/
@Deprecated
public float[] getSupportedRefreshRates() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.getDefaultRefreshRates();
}
}
/**
* Returns the active mode of the display.
*/
public Mode getMode() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.getMode();
}
}
/**
* Returns the default mode of the display.
* @hide
*/
@TestApi
public @NonNull Mode getDefaultMode() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.getDefaultMode();
}
}
/**
* Gets the supported modes of this display.
*/
public Mode[] getSupportedModes() {
synchronized (mLock) {
updateDisplayInfoLocked();
final Display.Mode[] modes = mDisplayInfo.supportedModes;
return Arrays.copyOf(modes, modes.length);
}
}
/**
* <p> Returns true if the connected display can be switched into a mode with minimal
* post processing. </p>
*
* <p> If the Display sink is connected via HDMI, this method will return true if the
* display supports either Auto Low Latency Mode or Game Content Type.
*
* <p> If the Display sink has an internal connection or uses some other protocol than
* HDMI, this method will return true if the sink can be switched into an
* implementation-defined low latency image processing mode. </p>
*
* <p> The ability to switch to a mode with minimal post processing may be disabled
* by a user setting in the system settings menu. In that case, this method returns
* false. </p>
*
* @see android.view.Window#setPreferMinimalPostProcessing
*/
@SuppressLint("VisiblySynchronized")
public boolean isMinimalPostProcessingSupported() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.minimalPostProcessingSupported;
}
}
/**
* Request the display applies a color mode.
* @hide
*/
@RequiresPermission(CONFIGURE_DISPLAY_COLOR_MODE)
public void requestColorMode(int colorMode) {
mGlobal.requestColorMode(mDisplayId, colorMode);
}
/**
* Returns the active color mode of this display
* @hide
*/
public int getColorMode() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.colorMode;
}
}
/**
* @hide
* Get current remove mode of the display - what actions should be performed with the display's
* content when it is removed. Default behavior for public displays in this case is to move all
* activities to the primary display and make it focused. For private display - destroy all
* activities.
*
* @see #REMOVE_MODE_MOVE_CONTENT_TO_PRIMARY
* @see #REMOVE_MODE_DESTROY_CONTENT
*/
// TODO (b/114338689): Remove the method and use IWindowManager#getRemoveContentMode
public int getRemoveMode() {
return mDisplayInfo.removeMode;
}
/**
* Returns the system's preferred display mode. This mode will be used when the user has not
* specified a display-mode preference. This returns null if the boot display mode feature is
* not supported by system.
*
* @hide
*/
@TestApi
@Nullable
public Display.Mode getSystemPreferredDisplayMode() {
return mGlobal.getSystemPreferredDisplayMode(getDisplayId());
}
/**
* Returns the display's HDR capabilities.
*
* @see #isHdr()
*/
public HdrCapabilities getHdrCapabilities() {
synchronized (mLock) {
updateDisplayInfoLocked();
if (mDisplayInfo.userDisabledHdrTypes.length == 0) {
return mDisplayInfo.hdrCapabilities;
}
if (mDisplayInfo.hdrCapabilities == null) {
return null;
}
ArraySet<Integer> enabledTypesSet = new ArraySet<>();
for (int supportedType : mDisplayInfo.hdrCapabilities.getSupportedHdrTypes()) {
boolean typeDisabled = false;
for (int userDisabledType : mDisplayInfo.userDisabledHdrTypes) {
if (supportedType == userDisabledType) {
typeDisabled = true;
break;
}
}
if (!typeDisabled) {
enabledTypesSet.add(supportedType);
}
}
int[] enabledTypes = new int[enabledTypesSet.size()];
int index = 0;
for (int enabledType : enabledTypesSet) {
enabledTypes[index++] = enabledType;
}
return new HdrCapabilities(enabledTypes,
mDisplayInfo.hdrCapabilities.mMaxLuminance,
mDisplayInfo.hdrCapabilities.mMaxAverageLuminance,
mDisplayInfo.hdrCapabilities.mMinLuminance);
}
}
/**
* @hide
* Returns the display's HDR supported types.
*
* @see #isHdr()
* @see HdrCapabilities#getSupportedHdrTypes()
*/
@TestApi
@NonNull
public int[] getReportedHdrTypes() {
synchronized (mLock) {
updateDisplayInfoLocked();
if (mDisplayInfo.hdrCapabilities == null) {
return new int[0];
}
return mDisplayInfo.hdrCapabilities.getSupportedHdrTypes();
}
}
/**
* Returns whether this display supports any HDR type.
*
* @see #getHdrCapabilities()
* @see HdrCapabilities#getSupportedHdrTypes()
*/
public boolean isHdr() {
synchronized (mLock) {
updateDisplayInfoLocked();
HdrCapabilities hdrCapabilities = getHdrCapabilities();
if (hdrCapabilities == null) {
return false;
}
return !(hdrCapabilities.getSupportedHdrTypes().length == 0);
}
}
/**
* Sets the default {@link Display.Mode} to use for the display. The display mode includes
* preference for resolution and refresh rate.
* If the mode specified is not supported by the display, then no mode change occurs.
*
* @param mode The {@link Display.Mode} to set, which can include resolution and/or
* refresh-rate. It is created using {@link Display.Mode.Builder}.
*`
* @hide
*/
@TestApi
@RequiresPermission(Manifest.permission.MODIFY_USER_PREFERRED_DISPLAY_MODE)
public void setUserPreferredDisplayMode(@NonNull Display.Mode mode) {
// Create a new object containing default values for the unused fields like mode ID and
// alternative refresh rates.
Display.Mode preferredMode = new Display.Mode(mode.getPhysicalWidth(),
mode.getPhysicalHeight(), mode.getRefreshRate());
mGlobal.setUserPreferredDisplayMode(mDisplayId, preferredMode);
}
/**
* Removes the display's user preferred display mode.
*
* @hide
*/
@TestApi
@RequiresPermission(Manifest.permission.MODIFY_USER_PREFERRED_DISPLAY_MODE)
public void clearUserPreferredDisplayMode() {
mGlobal.setUserPreferredDisplayMode(mDisplayId, null);
}
/**
* Returns the display's user preferred display mode.
*
* @hide
*/
@TestApi
@Nullable
public Display.Mode getUserPreferredDisplayMode() {
return mGlobal.getUserPreferredDisplayMode(mDisplayId);
}
/**
* Returns whether this display can be used to display wide color gamut content.
* This does not necessarily mean the device itself can render wide color gamut
* content. To ensure wide color gamut content can be produced, refer to
* {@link Configuration#isScreenWideColorGamut()}.
*/
public boolean isWideColorGamut() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.isWideColorGamut();
}
}
/**
* Returns the preferred wide color space of the Display.
* The returned wide gamut color space is based on hardware capability and
* is preferred by the composition pipeline.
* Returns null if the display doesn't support wide color gamut.
* {@link Display#isWideColorGamut()}.
*/
@Nullable
public ColorSpace getPreferredWideGamutColorSpace() {
synchronized (mLock) {
updateDisplayInfoLocked();
if (mDisplayInfo.isWideColorGamut()) {
return mGlobal.getPreferredWideGamutColorSpace();
}
return null;
}
}
/**
* Gets the supported color modes of this device.
* @hide
*/
public int[] getSupportedColorModes() {
synchronized (mLock) {
updateDisplayInfoLocked();
int[] colorModes = mDisplayInfo.supportedColorModes;
return Arrays.copyOf(colorModes, colorModes.length);
}
}
/**
* Gets the supported wide color gamuts of this device.
*
* @return Supported WCG color spaces.
* @hide
*/
@SuppressLint("VisiblySynchronized")
@NonNull
@TestApi
public @ColorMode ColorSpace[] getSupportedWideColorGamut() {
synchronized (mLock) {
final ColorSpace[] defaultColorSpaces = new ColorSpace[0];
updateDisplayInfoLocked();
if (!isWideColorGamut()) {
return defaultColorSpaces;
}
final int[] colorModes = getSupportedColorModes();
final List<ColorSpace> colorSpaces = new ArrayList<>();
for (int colorMode : colorModes) {
// Refer to DisplayInfo#isWideColorGamut.
switch (colorMode) {
case COLOR_MODE_DCI_P3:
colorSpaces.add(ColorSpace.get(ColorSpace.Named.DCI_P3));
break;
case COLOR_MODE_DISPLAY_P3:
colorSpaces.add(ColorSpace.get(ColorSpace.Named.DISPLAY_P3));
break;
}
}
return colorSpaces.toArray(defaultColorSpaces);
}
}
/**
* Gets the app VSYNC offset, in nanoseconds. This is a positive value indicating
* the phase offset of the VSYNC events provided by Choreographer relative to the
* display refresh. For example, if Choreographer reports that the refresh occurred
* at time N, it actually occurred at (N - appVsyncOffset).
* <p>
* Apps generally do not need to be aware of this. It's only useful for fine-grained
* A/V synchronization.
*/
public long getAppVsyncOffsetNanos() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.appVsyncOffsetNanos;
}
}
/**
* This is how far in advance a buffer must be queued for presentation at
* a given time. If you want a buffer to appear on the screen at
* time N, you must submit the buffer before (N - presentationDeadline).
* <p>
* The desired presentation time for GLES rendering may be set with
* {@link android.opengl.EGLExt#eglPresentationTimeANDROID}. For video decoding, use
* {@link android.media.MediaCodec#releaseOutputBuffer(int, long)}. Times are
* expressed in nanoseconds, using the system monotonic clock
* ({@link System#nanoTime}).
*/
public long getPresentationDeadlineNanos() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.presentationDeadlineNanos;
}
}
/**
* Returns the product-specific information about the display or the directly connected
* device on the display chain.
* For example, if the display is transitively connected, this field may contain product
* information about the intermediate device.
* Returns {@code null} if product information is not available.
*/
@Nullable
public DeviceProductInfo getDeviceProductInfo() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mDisplayInfo.deviceProductInfo;
}
}
/**
* Gets the size and density of this display.
*
* <p>The size returned does not necessarily represent the actual size (native resolution) of
* the display. The returned size might be adjusted to exclude certain system decor elements
* that are always visible, or the size might be scaled to provide compatibility with older
* applications that were originally designed for smaller displays.
*
* <p>The returned size can also be different depending on the WindowManager associated with the
* display:
* <ul>
* <li>If metrics are requested from an activity (either using a WindowManager accessed by
* {@code getWindowManager()} or {@code getSystemService(Context.WINDOW_SERVICE)}), the
* returned metrics provide the size of the current app window. As a result, in
* multi-window mode, the returned size can be smaller than the size of the device
* screen.
* <li>If metrics are requested from a non-activity context (for example, the application
* context, where the WindowManager is accessed by
* {@code getApplicationContext().getSystemService(Context.WINDOW_SERVICE)}), the
* returned size can vary depending on API level:
* <ul>
* <li>API level 29 and below — The returned metrics provide the size of the
* entire display (based on current rotation) minus system decoration areas.
* <li>API level 30 and above — The returned metrics provide the size of the
* top running activity in the current process. If the current process has no
* running activities, the metrics provide the size of the default display of
* the device, including system decoration areas.
* </ul>
* </ul>
*
* @param outMetrics A {@link DisplayMetrics} object which receives the display metrics.
*
* @deprecated Use {@link WindowMetrics#getBounds()} to get the dimensions of the application
* window. Use {@link Configuration#densityDpi} to get the display density.
*/
@Deprecated
public void getMetrics(DisplayMetrics outMetrics) {
synchronized (mLock) {
updateDisplayInfoLocked();
mDisplayInfo.getAppMetrics(outMetrics, getDisplayAdjustments());
}
}
/**
* Gets the size of the largest region of the display accessible to an app in the current system
* state, without subtracting any window decor or applying scaling factors.
* <p>
* The size is adjusted based on the current rotation of the display.
* <p></p>
* The returned size will fall into one of these scenarios:
* <ol>
* <li>The device has no partitions on the display. The returned value is the largest region
* of the display accessible to an app in the current system state, regardless of windowing
* mode.</li>
* <li>The device divides a single display into multiple partitions. An application is
* restricted to a portion of the display. This is common in devices where the display changes
* size, such as foldables or large screens. The returned size will match the portion of
* the display the application is restricted to.</li>
* <li>The window manager is emulating a different display size, using {@code adb shell wm
* size}. The returned size will match the emulated display size.</li>
* </ol>
* </p><p>
* The returned value is <b>unsuitable to use when sizing and placing UI elements</b>, since it
* does not reflect the application window size in any of these scenarios.
* {@link WindowManager#getCurrentWindowMetrics()} is an alternative that returns the size
* of the current application window, even if the window is on a device with a partitioned
* display. This helps prevent UI bugs where UI elements are misaligned or placed beyond the
* bounds of the window.
* <p></p>
* Handling multi-window mode correctly is necessary since applications are not always
* fullscreen. A user on a large screen device, such as a tablet or Chrome OS devices, is more
* likely to use multi-window modes.
* <p></p>
* For example, consider a device with a display partitioned into two halves. The user may have
* a fullscreen application open on the first partition. They may have two applications open in
* split screen (an example of multi-window mode) on the second partition, with each application
* consuming half of the partition. In this case,
* {@link WindowManager#getCurrentWindowMetrics()} reports the fullscreen window is half of the
* screen in size, and each split screen window is a quarter of the screen in size. On the other
* hand, {@link #getRealSize} reports half of the screen size for all windows, since the
* application windows are all restricted to their respective partitions.
* </p>
*
* @param outSize Set to the real size of the display.
* @deprecated Use {@link WindowManager#getCurrentWindowMetrics()} to identify the current size
* of the activity window. UI-related work, such as choosing UI layouts, should rely
* upon {@link WindowMetrics#getBounds()}.
*/
@Deprecated
public void getRealSize(Point outSize) {
synchronized (mLock) {
updateDisplayInfoLocked();
if (shouldReportMaxBounds()) {
final Rect bounds = mResources.getConfiguration()
.windowConfiguration.getMaxBounds();
outSize.x = bounds.width();
outSize.y = bounds.height();
if (DEBUG) {
Log.d(TAG, "getRealSize determined from max bounds: " + outSize);
}
// Skip adjusting by fixed rotation, since if it is necessary, the configuration
// should already reflect the expected rotation.
return;
}
outSize.x = mDisplayInfo.logicalWidth;
outSize.y = mDisplayInfo.logicalHeight;
final @Surface.Rotation int rotation = getLocalRotation();
if (rotation != mDisplayInfo.rotation) {
adjustSize(outSize, mDisplayInfo.rotation, rotation);
}
}
}
/**
* Gets the size of the largest region of the display accessible to an app in the current system
* state, without subtracting any window decor or applying scaling factors.
* <p>
* The size is adjusted based on the current rotation of the display.
* <p></p>
* The returned size will fall into one of these scenarios:
* <ol>
* <li>The device has no partitions on the display. The returned value is the largest region
* of the display accessible to an app in the current system state, regardless of windowing
* mode.</li>
* <li>The device divides a single display into multiple partitions. An application is
* restricted to a portion of the display. This is common in devices where the display changes
* size, such as foldables or large screens. The returned size will match the portion of
* the display the application is restricted to.</li>
* <li>The window manager is emulating a different display size, using {@code adb shell wm
* size}. The returned size will match the emulated display size.</li>
* </ol>
* </p><p>
* The returned value is <b>unsuitable to use when sizing and placing UI elements</b>, since it
* does not reflect the application window size in any of these scenarios.
* {@link WindowManager#getCurrentWindowMetrics()} is an alternative that returns the size
* of the current application window, even if the window is on a device with a partitioned
* display. This helps prevent UI bugs where UI elements are misaligned or placed beyond the
* bounds of the window.
* <p></p>
* Handling multi-window mode correctly is necessary since applications are not always
* fullscreen. A user on a large screen device, such as a tablet or Chrome OS devices, is more
* likely to use multi-window modes.
* <p></p>
* For example, consider a device with a display partitioned into two halves. The user may have
* a fullscreen application open on the first partition. They may have two applications open in
* split screen (an example of multi-window mode) on the second partition, with each application
* consuming half of the partition. In this case,
* {@link WindowManager#getCurrentWindowMetrics()} reports the fullscreen window is half of the
* screen in size, and each split screen window is a quarter of the screen in size. On the other
* hand, {@link #getRealMetrics} reports half of the screen size for all windows, since the
* application windows are all restricted to their respective partitions.
* </p>
*
* @param outMetrics A {@link DisplayMetrics} object to receive the metrics.
* @deprecated Use {@link WindowManager#getCurrentWindowMetrics()} to identify the current size
* of the activity window. UI-related work, such as choosing UI layouts, should rely
* upon {@link WindowMetrics#getBounds()}. Use {@link Configuration#densityDpi} to
* get the current density.
*/
@Deprecated
public void getRealMetrics(DisplayMetrics outMetrics) {
synchronized (mLock) {
updateDisplayInfoLocked();
if (shouldReportMaxBounds()) {
mDisplayInfo.getMaxBoundsMetrics(outMetrics,
CompatibilityInfo.DEFAULT_COMPATIBILITY_INFO,
mResources.getConfiguration());
if (DEBUG) {
Log.d(TAG, "getRealMetrics determined from max bounds: " + outMetrics);
}
// Skip adjusting by fixed rotation, since if it is necessary, the configuration
// should already reflect the expected rotation.
return;
}
mDisplayInfo.getLogicalMetrics(outMetrics,
CompatibilityInfo.DEFAULT_COMPATIBILITY_INFO, null);
final @Surface.Rotation int rotation = getLocalRotation();
if (rotation != mDisplayInfo.rotation) {
adjustMetrics(outMetrics, mDisplayInfo.rotation, rotation);
}
}
}
/**
* Determines if {@link WindowConfiguration#getMaxBounds()} should be reported as the
* display dimensions. The max bounds field may be smaller than the logical dimensions
* when apps need to be sandboxed.
*
* Depends upon {@link WindowConfiguration#getMaxBounds()} being set in
* {@link com.android.server.wm.ConfigurationContainer#providesMaxBounds()}. In most cases, this
* value reflects the size of the current DisplayArea.
* @return {@code true} when max bounds should be applied.
*/
private boolean shouldReportMaxBounds() {
if (mResources == null) {
return false;
}
final Configuration config = mResources.getConfiguration();
return config != null && !config.windowConfiguration.getMaxBounds().isEmpty();
}
/**
* Gets the state of the display, such as whether it is on or off.
*
* @return The state of the display: one of {@link #STATE_OFF}, {@link #STATE_ON},
* {@link #STATE_DOZE}, {@link #STATE_DOZE_SUSPEND}, {@link #STATE_ON_SUSPEND}, or
* {@link #STATE_UNKNOWN}.
*/
public int getState() {
synchronized (mLock) {
updateDisplayInfoLocked();
return mIsValid ? mDisplayInfo.state : STATE_UNKNOWN;
}
}
/**
* Returns true if the specified UID has access to this display.
* @hide
*/
@TestApi
public boolean hasAccess(int uid) {
return hasAccess(uid, mFlags, mOwnerUid, mDisplayId);
}
/** @hide */
public static boolean hasAccess(int uid, int flags, int ownerUid, int displayId) {
return (flags & Display.FLAG_PRIVATE) == 0
|| uid == ownerUid
|| uid == Process.SYSTEM_UID
|| uid == 0
// Check if the UID is present on given display.
|| DisplayManagerGlobal.getInstance().isUidPresentOnDisplay(uid, displayId);
}
/**
* Returns true if the display is a public presentation display.
* @hide
*/
public boolean isPublicPresentation() {
return (mFlags & (Display.FLAG_PRIVATE | Display.FLAG_PRESENTATION)) ==
Display.FLAG_PRESENTATION;
}
/**
* @return {@code true} if the display is a trusted display.
*
* @see #FLAG_TRUSTED
* @hide
*/
public boolean isTrusted() {
return (mFlags & FLAG_TRUSTED) == FLAG_TRUSTED;
}
private void updateDisplayInfoLocked() {
// Note: The display manager caches display info objects on our behalf.
DisplayInfo newInfo = mGlobal.getDisplayInfo(mDisplayId);
if (newInfo == null) {
// Preserve the old mDisplayInfo after the display is removed.
if (mIsValid) {
mIsValid = false;
if (DEBUG) {
Log.d(TAG, "Logical display " + mDisplayId + " was removed.");
}
}
} else {
// Use the new display info. (It might be the same object if nothing changed.)
mDisplayInfo = newInfo;
if (!mIsValid) {
mIsValid = true;
if (DEBUG) {
Log.d(TAG, "Logical display " + mDisplayId + " was recreated.");
}
}
}
}
private void updateCachedAppSizeIfNeededLocked() {
long now = SystemClock.uptimeMillis();
if (now > mLastCachedAppSizeUpdate + CACHED_APP_SIZE_DURATION_MILLIS) {
updateDisplayInfoLocked();
mDisplayInfo.getAppMetrics(mTempMetrics, getDisplayAdjustments());
mCachedAppWidthCompat = mTempMetrics.widthPixels;
mCachedAppHeightCompat = mTempMetrics.heightPixels;
mLastCachedAppSizeUpdate = now;
}
}
/** Returns {@code false} if the width and height of display should swap. */
private static boolean noFlip(@Surface.Rotation int realRotation,
@Surface.Rotation int localRotation) {
// Check if the delta is rotated by 90 degrees.
return (realRotation - localRotation + 4) % 2 == 0;
}
/**
* Adjusts the given size by a rotation offset if necessary.
* @hide
*/
private void adjustSize(@NonNull Point size, @Surface.Rotation int realRotation,
@Surface.Rotation int localRotation) {
if (noFlip(realRotation, localRotation)) return;
final int w = size.x;
size.x = size.y;
size.y = w;
}
/**
* Adjusts the given metrics by a rotation offset if necessary.
* @hide
*/
private void adjustMetrics(@NonNull DisplayMetrics metrics,
@Surface.Rotation int realRotation, @Surface.Rotation int localRotation) {
if (noFlip(realRotation, localRotation)) return;
int w = metrics.widthPixels;
metrics.widthPixels = metrics.heightPixels;
metrics.heightPixels = w;
w = metrics.noncompatWidthPixels;
metrics.noncompatWidthPixels = metrics.noncompatHeightPixels;
metrics.noncompatHeightPixels = w;
}
private @Surface.Rotation int getLocalRotation() {
if (mResources == null) return mDisplayInfo.rotation;
final @Surface.Rotation int localRotation =
mResources.getConfiguration().windowConfiguration.getDisplayRotation();
if (localRotation != WindowConfiguration.ROTATION_UNDEFINED) return localRotation;
return mDisplayInfo.rotation;
}
// For debugging purposes
@Override
public String toString() {
synchronized (mLock) {
updateDisplayInfoLocked();
final DisplayAdjustments adjustments = getDisplayAdjustments();
mDisplayInfo.getAppMetrics(mTempMetrics, adjustments);
return "Display id " + mDisplayId + ": " + mDisplayInfo + ", "
+ mTempMetrics + ", isValid=" + mIsValid;
}
}
/**
* @hide
*/
public static String typeToString(int type) {
switch (type) {
case TYPE_UNKNOWN:
return "UNKNOWN";
case TYPE_INTERNAL:
return "INTERNAL";
case TYPE_EXTERNAL:
return "EXTERNAL";
case TYPE_WIFI:
return "WIFI";
case TYPE_OVERLAY:
return "OVERLAY";
case TYPE_VIRTUAL:
return "VIRTUAL";
default:
return Integer.toString(type);
}
}
/**
* @hide
*/
public static String stateToString(int state) {
switch (state) {
case STATE_UNKNOWN:
return "UNKNOWN";
case STATE_OFF:
return "OFF";
case STATE_ON:
return "ON";
case STATE_DOZE:
return "DOZE";
case STATE_DOZE_SUSPEND:
return "DOZE_SUSPEND";
case STATE_VR:
return "VR";
case STATE_ON_SUSPEND:
return "ON_SUSPEND";
default:
return Integer.toString(state);
}
}
/**
* Returns true if display updates may be suspended while in the specified
* display power state. In SUSPEND states, updates are absolutely forbidden.
* @hide
*/
public static boolean isSuspendedState(int state) {
return state == STATE_OFF || state == STATE_DOZE_SUSPEND || state == STATE_ON_SUSPEND;
}
/**
* Returns true if the display may be in a reduced operating mode while in the
* specified display power state.
* @hide
*/
public static boolean isDozeState(int state) {
return state == STATE_DOZE || state == STATE_DOZE_SUSPEND;
}
/**
* Returns true if the display is in active state such as {@link #STATE_ON}
* or {@link #STATE_VR}.
* @hide
*/
public static boolean isActiveState(int state) {
return state == STATE_ON || state == STATE_VR;
}
/**
* Returns true if the display is in an off state such as {@link #STATE_OFF}.
* @hide
*/
public static boolean isOffState(int state) {
return state == STATE_OFF;
}
/**
* Returns true if the display is in an on state such as {@link #STATE_ON}
* or {@link #STATE_VR} or {@link #STATE_ON_SUSPEND}.
* @hide
*/
public static boolean isOnState(int state) {
return state == STATE_ON || state == STATE_VR || state == STATE_ON_SUSPEND;
}
/**
* Returns true if the specified width is valid.
* @hide
*/
public static boolean isWidthValid(int width) {
return width > 0;
}
/**
* Returns true if the specified height is valid.
* @hide
*/
public static boolean isHeightValid(int height) {
return height > 0;
}
/**
* Returns true if the specified refresh-rate is valid.
* @hide
*/
public static boolean isRefreshRateValid(float refreshRate) {
return refreshRate > 0.0f;
}
/**
* Returns whether/how the specified display supports DISPLAY_DECORATION.
*
* Composition.DISPLAY_DECORATION is a special layer type which is used to
* render the screen decorations (i.e. antialiased rounded corners and
* cutouts) while taking advantage of specific hardware.
*
* @hide
*/
public DisplayDecorationSupport getDisplayDecorationSupport() {
return mGlobal.getDisplayDecorationSupport(mDisplayId);
}
/**
* A mode supported by a given display.
*
* @see Display#getSupportedModes()
*/
public static final class Mode implements Parcelable {
/**
* @hide
*/
public static final Mode[] EMPTY_ARRAY = new Mode[0];
/**
* @hide
*/
public static final int INVALID_MODE_ID = -1;
private final int mModeId;
private final int mWidth;
private final int mHeight;
private final float mRefreshRate;
@NonNull
private final float[] mAlternativeRefreshRates;
/**
* @hide
*/
@TestApi
public Mode(int width, int height, float refreshRate) {
this(INVALID_MODE_ID, width, height, refreshRate, new float[0]);
}
/**
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public Mode(int modeId, int width, int height, float refreshRate) {
this(modeId, width, height, refreshRate, new float[0]);
}
/**
* @hide
*/
public Mode(int modeId, int width, int height, float refreshRate,
float[] alternativeRefreshRates) {
mModeId = modeId;
mWidth = width;
mHeight = height;
mRefreshRate = refreshRate;
mAlternativeRefreshRates =
Arrays.copyOf(alternativeRefreshRates, alternativeRefreshRates.length);
Arrays.sort(mAlternativeRefreshRates);
}
/**
* Returns this mode's id.
*/
public int getModeId() {
return mModeId;
}
/**
* Returns the physical width of the display in pixels when configured in this mode's
* resolution.
* <p>
* Note that due to application UI scaling, the number of pixels made available to
* applications when the mode is active (as reported by {@link Display#getWidth()} may
* differ from the mode's actual resolution (as reported by this function).
* <p>
* For example, applications running on a 4K display may have their UI laid out and rendered
* in 1080p and then scaled up. Applications can take advantage of the extra resolution by
* rendering content through a {@link android.view.SurfaceView} using full size buffers.
*/
public int getPhysicalWidth() {
return mWidth;
}
/**
* Returns the physical height of the display in pixels when configured in this mode's
* resolution.
* <p>
* Note that due to application UI scaling, the number of pixels made available to
* applications when the mode is active (as reported by {@link Display#getHeight()} may
* differ from the mode's actual resolution (as reported by this function).
* <p>
* For example, applications running on a 4K display may have their UI laid out and rendered
* in 1080p and then scaled up. Applications can take advantage of the extra resolution by
* rendering content through a {@link android.view.SurfaceView} using full size buffers.
*/
public int getPhysicalHeight() {
return mHeight;
}
/**
* Returns the refresh rate in frames per second.
*/
public float getRefreshRate() {
return mRefreshRate;
}
/**
* Returns an array of refresh rates which can be switched to seamlessly.
* <p>
* A seamless switch is one without visual interruptions, such as a black screen for
* a second or two.
* <p>
* Presence in this list does not guarantee a switch will occur to the desired
* refresh rate, but rather, if a switch does occur to a refresh rate in this list,
* it is guaranteed to be seamless.
* <p>
* The binary relation "refresh rate X is alternative to Y" is non-reflexive,
* symmetric and transitive. For example the mode 1920x1080 60Hz, will never have an
* alternative refresh rate of 60Hz. If 1920x1080 60Hz has an alternative of 50Hz
* then 1920x1080 50Hz will have alternative refresh rate of 60Hz. If 1920x1080 60Hz
* has an alternative of 50Hz and 1920x1080 50Hz has an alternative of 24Hz, then 1920x1080
* 60Hz will also have an alternative of 24Hz.
*
* @see Surface#setFrameRate
* @see SurfaceControl.Transaction#setFrameRate
*/
@NonNull
public float[] getAlternativeRefreshRates() {
return mAlternativeRefreshRates;
}
/**
* Returns {@code true} if this mode matches the given parameters.
*
* @hide
*/
@TestApi
public boolean matches(int width, int height, float refreshRate) {
return mWidth == width &&
mHeight == height &&
Float.floatToIntBits(mRefreshRate) == Float.floatToIntBits(refreshRate);
}
/**
* Returns {@code true} if this mode matches the given parameters, if those parameters are
* valid.<p>
* If resolution (width and height) is valid and refresh-rate is not, the method matches
* only resolution.
* If refresh-rate is valid and resolution (width and height) is not, the method matches
* only refresh-rate.</p>
*
* @hide
*/
public boolean matchesIfValid(int width, int height, float refreshRate) {
if (!isWidthValid(width) && !isHeightValid(height)
&& !isRefreshRateValid(refreshRate)) {
return false;
}
if (isWidthValid(width) != isHeightValid(height)) {
return false;
}
return (!isWidthValid(width) || mWidth == width)
&& (!isHeightValid(height) || mHeight == height)
&& (!isRefreshRateValid(refreshRate)
|| Float.floatToIntBits(mRefreshRate) == Float.floatToIntBits(refreshRate));
}
/**
* Returns {@code true} if this mode equals to the other mode in all parameters except
* the refresh rate.
*
* @hide
*/
public boolean equalsExceptRefreshRate(@Nullable Display.Mode other) {
return mWidth == other.mWidth && mHeight == other.mHeight;
}
/**
* Returns {@code true} if refresh-rate is set for a display mode
*
* @hide
*/
public boolean isRefreshRateSet() {
return mRefreshRate != INVALID_DISPLAY_REFRESH_RATE;
}
/**
* Returns {@code true} if refresh-rate is set for a display mode
*
* @hide
*/
public boolean isResolutionSet() {
return mWidth != INVALID_DISPLAY_WIDTH && mHeight != INVALID_DISPLAY_HEIGHT;
}
@Override
public boolean equals(@Nullable Object other) {
if (this == other) {
return true;
}
if (!(other instanceof Mode)) {
return false;
}
Mode that = (Mode) other;
return mModeId == that.mModeId && matches(that.mWidth, that.mHeight, that.mRefreshRate)
&& Arrays.equals(mAlternativeRefreshRates, that.mAlternativeRefreshRates);
}
@Override
public int hashCode() {
int hash = 1;
hash = hash * 17 + mModeId;
hash = hash * 17 + mWidth;
hash = hash * 17 + mHeight;
hash = hash * 17 + Float.floatToIntBits(mRefreshRate);
hash = hash * 17 + Arrays.hashCode(mAlternativeRefreshRates);
return hash;
}
@Override
public String toString() {
return new StringBuilder("{")
.append("id=").append(mModeId)
.append(", width=").append(mWidth)
.append(", height=").append(mHeight)
.append(", fps=").append(mRefreshRate)
.append(", alternativeRefreshRates=")
.append(Arrays.toString(mAlternativeRefreshRates))
.append("}")
.toString();
}
@Override
public int describeContents() {
return 0;
}
private Mode(Parcel in) {
this(in.readInt(), in.readInt(), in.readInt(), in.readFloat(), in.createFloatArray());
}
@Override
public void writeToParcel(Parcel out, int parcelableFlags) {
out.writeInt(mModeId);
out.writeInt(mWidth);
out.writeInt(mHeight);
out.writeFloat(mRefreshRate);
out.writeFloatArray(mAlternativeRefreshRates);
}
@SuppressWarnings("hiding")
public static final @android.annotation.NonNull Parcelable.Creator<Mode> CREATOR
= new Parcelable.Creator<Mode>() {
@Override
public Mode createFromParcel(Parcel in) {
return new Mode(in);
}
@Override
public Mode[] newArray(int size) {
return new Mode[size];
}
};
/**
* Builder is used to create {@link Display.Mode} objects
*
* @hide
*/
@TestApi
public static final class Builder {
private int mWidth;
private int mHeight;
private float mRefreshRate;
public Builder() {
mWidth = Display.INVALID_DISPLAY_WIDTH;
mHeight = Display.INVALID_DISPLAY_HEIGHT;
mRefreshRate = Display.INVALID_DISPLAY_REFRESH_RATE;
}
/**
* Sets the resolution (width and height) of a {@link Display.Mode}
*
* @return Instance of {@link Builder}
*/
@NonNull
public Builder setResolution(int width, int height) {
if (width > 0 && height > 0) {
mWidth = width;
mHeight = height;
}
return this;
}
/**
* Sets the refresh rate of a {@link Display.Mode}
*
* @return Instance of {@link Builder}
*/
@NonNull
public Builder setRefreshRate(float refreshRate) {
if (refreshRate > 0.0f) {
mRefreshRate = refreshRate;
}
return this;
}
/**
* Creates the {@link Display.Mode} object.
*
* <p>
* If resolution needs to be set, but refresh-rate doesn't matter, create a mode with
* Builder and call setResolution.
* {@code
* Display.Mode mode =
* new Display.Mode.Builder()
* .setResolution(width, height)
* .build();
* }
* </p><p>
* If refresh-rate needs to be set, but resolution doesn't matter, create a mode with
* Builder and call setRefreshRate.
* {@code
* Display.Mode mode =
* new Display.Mode.Builder()
* .setRefreshRate(refreshRate)
* .build();
* }
* </p>
*/
@NonNull
public Mode build() {
Display.Mode mode = new Mode(mWidth, mHeight, mRefreshRate);
return mode;
}
}
}
/**
* Encapsulates the HDR capabilities of a given display.
* For example, what HDR types it supports and details about the desired luminance data.
* <p>You can get an instance for a given {@link Display} object with
* {@link Display#getHdrCapabilities getHdrCapabilities()}.
*/
public static final class HdrCapabilities implements Parcelable {
/**
* Invalid luminance value.
*/
public static final float INVALID_LUMINANCE = -1;
/**
* Dolby Vision high dynamic range (HDR) display.
*/
public static final int HDR_TYPE_DOLBY_VISION = 1;
/**
* HDR10 display.
*/
public static final int HDR_TYPE_HDR10 = 2;
/**
* Hybrid Log-Gamma HDR display.
*/
public static final int HDR_TYPE_HLG = 3;
/**
* HDR10+ display.
*/
public static final int HDR_TYPE_HDR10_PLUS = 4;
/** @hide */
public static final int[] HDR_TYPES = {
HDR_TYPE_DOLBY_VISION,
HDR_TYPE_HDR10,
HDR_TYPE_HLG,
HDR_TYPE_HDR10_PLUS
};
/** @hide */
@IntDef(prefix = { "HDR_TYPE_" }, value = {
HDR_TYPE_DOLBY_VISION,
HDR_TYPE_HDR10,
HDR_TYPE_HLG,
HDR_TYPE_HDR10_PLUS,
})
@Retention(RetentionPolicy.SOURCE)
public @interface HdrType {}
private @HdrType int[] mSupportedHdrTypes = new int[0];
private float mMaxLuminance = INVALID_LUMINANCE;
private float mMaxAverageLuminance = INVALID_LUMINANCE;
private float mMinLuminance = INVALID_LUMINANCE;
/**
* @hide
*/
public HdrCapabilities() {
}
/**
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public HdrCapabilities(int[] supportedHdrTypes, float maxLuminance,
float maxAverageLuminance, float minLuminance) {
mSupportedHdrTypes = supportedHdrTypes;
Arrays.sort(mSupportedHdrTypes);
mMaxLuminance = maxLuminance;
mMaxAverageLuminance = maxAverageLuminance;
mMinLuminance = minLuminance;
}
/**
* Gets the supported HDR types of this display.
* Returns empty array if HDR is not supported by the display.
*/
public @HdrType int[] getSupportedHdrTypes() {
return mSupportedHdrTypes;
}
/**
* Returns the desired content max luminance data in cd/m2 for this display.
*/
public float getDesiredMaxLuminance() {
return mMaxLuminance;
}
/**
* Returns the desired content max frame-average luminance data in cd/m2 for this display.
*/
public float getDesiredMaxAverageLuminance() {
return mMaxAverageLuminance;
}
/**
* Returns the desired content min luminance data in cd/m2 for this display.
*/
public float getDesiredMinLuminance() {
return mMinLuminance;
}
@Override
public boolean equals(@Nullable Object other) {
if (this == other) {
return true;
}
if (!(other instanceof HdrCapabilities)) {
return false;
}
HdrCapabilities that = (HdrCapabilities) other;
return Arrays.equals(mSupportedHdrTypes, that.mSupportedHdrTypes)
&& mMaxLuminance == that.mMaxLuminance
&& mMaxAverageLuminance == that.mMaxAverageLuminance
&& mMinLuminance == that.mMinLuminance;
}
@Override
public int hashCode() {
int hash = 23;
hash = hash * 17 + Arrays.hashCode(mSupportedHdrTypes);
hash = hash * 17 + Float.floatToIntBits(mMaxLuminance);
hash = hash * 17 + Float.floatToIntBits(mMaxAverageLuminance);
hash = hash * 17 + Float.floatToIntBits(mMinLuminance);
return hash;
}
public static final @android.annotation.NonNull Creator<HdrCapabilities> CREATOR = new Creator<HdrCapabilities>() {
@Override
public HdrCapabilities createFromParcel(Parcel source) {
return new HdrCapabilities(source);
}
@Override
public HdrCapabilities[] newArray(int size) {
return new HdrCapabilities[size];
}
};
private HdrCapabilities(Parcel source) {
readFromParcel(source);
}
/**
* @hide
*/
public void readFromParcel(Parcel source) {
int types = source.readInt();
mSupportedHdrTypes = new int[types];
for (int i = 0; i < types; ++i) {
mSupportedHdrTypes[i] = source.readInt();
}
mMaxLuminance = source.readFloat();
mMaxAverageLuminance = source.readFloat();
mMinLuminance = source.readFloat();
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeInt(mSupportedHdrTypes.length);
for (int i = 0; i < mSupportedHdrTypes.length; ++i) {
dest.writeInt(mSupportedHdrTypes[i]);
}
dest.writeFloat(mMaxLuminance);
dest.writeFloat(mMaxAverageLuminance);
dest.writeFloat(mMinLuminance);
}
@Override
public int describeContents() {
return 0;
}
@Override
public String toString() {
return "HdrCapabilities{"
+ "mSupportedHdrTypes=" + Arrays.toString(mSupportedHdrTypes)
+ ", mMaxLuminance=" + mMaxLuminance
+ ", mMaxAverageLuminance=" + mMaxAverageLuminance
+ ", mMinLuminance=" + mMinLuminance + '}';
}
}
}
|