Encoches

Android 9 permet d'implémenter différents types d'encoches sur les appareils. Les encoches d'écran vous permettent de créer des expériences immersives de bout en bout, tout en laissant de la place pour les capteurs importants à l'avant des appareils.

Encoche en haut au centre

Figure 1 : Encoche en haut au centre

Android 9 est compatible avec les types de découpes suivants:

  • En haut au centre: découpe au centre du bord supérieur
  • Haut non centré: la découpe peut se trouver dans un coin ou légèrement décentré
  • Bas: découpe en bas
  • Double: une découpe en haut et une en bas

Exemples et source

Le code du gestionnaire de fenêtres suivant dans PhoneWindowManager.java montre comment les cadres d'affichage sont intégrés à la zone de sécurité lorsque LAYOUT_IN_DISPLAY_CUTOUT_MODE_ALWAYS n'est pas défini.

// Ensure that windows with a DEFAULT or NEVER display cutout mode are laid out in
// the cutout safe zone.
if (cutoutMode != LAYOUT_IN_DISPLAY_CUTOUT_MODE_ALWAYS) {
    final Rect displayCutoutSafeExceptMaybeBars = mTmpDisplayCutoutSafeExceptMaybeBarsRect;
    displayCutoutSafeExceptMaybeBars.set(displayFrames.mDisplayCutoutSafe);
    if (layoutInScreen && layoutInsetDecor && !requestedFullscreen
            && cutoutMode == LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT) {
        // At the top we have the status bar, so apps that are
        // LAYOUT_IN_SCREEN | LAYOUT_INSET_DECOR but not FULLSCREEN
        // already expect that there's an inset there and we don't need to exclude
        // the window from that area.
        displayCutoutSafeExceptMaybeBars.top = Integer.MIN_VALUE;
    }
    if (layoutInScreen && layoutInsetDecor && !requestedHideNavigation
            && cutoutMode == LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT) {
        // Same for the navigation bar.
        switch (mNavigationBarPosition) {
            case NAV_BAR_BOTTOM:
                displayCutoutSafeExceptMaybeBars.bottom = Integer.MAX_VALUE;
                break;
            case NAV_BAR_RIGHT:
                displayCutoutSafeExceptMaybeBars.right = Integer.MAX_VALUE;
                break;
            case NAV_BAR_LEFT:
                displayCutoutSafeExceptMaybeBars.left = Integer.MIN_VALUE;
                break;
        }
    }
    if (type == TYPE_INPUT_METHOD && mNavigationBarPosition == NAV_BAR_BOTTOM) {
        // The IME can always extend under the bottom cutout if the navbar is there.
        displayCutoutSafeExceptMaybeBars.bottom = Integer.MAX_VALUE;
    }
    // Windows that are attached to a parent and laid out in said parent already avoid
    // the cutout according to that parent and don't need to be further constrained.
    // Floating IN_SCREEN windows get what they ask for and lay out in the full screen.
    // They will later be cropped or shifted using the displayFrame in WindowState,
    // which prevents overlap with the DisplayCutout.
    if (!attachedInParent && !floatingInScreenWindow) {
        mTmpRect.set(pf);
        pf.intersectUnchecked(displayCutoutSafeExceptMaybeBars);
        parentFrameWasClippedByDisplayCutout |= !mTmpRect.equals(pf);
    }
    // Make sure that NO_LIMITS windows clipped to the display don't extend under the
    // cutout.
    df.intersectUnchecked(displayCutoutSafeExceptMaybeBars);
}

SystemUI effectue le rendu dans la zone d'encoche et doit déterminer où il peut dessiner. PhoneStatusBarView.java fournit un exemple de vue qui détermine l'emplacement et la taille de l'encoche de l'écran, et si l'encart de la barre de navigation évite ou non la zone de l'encoche.

En remplaçant onApplyWindowInsets(), une vue peut déterminer l'emplacement de la découpe et mettre à jour sa mise en page en conséquence.

@Override
    public WindowInsets onApplyWindowInsets(WindowInsets insets) {
        if (updateOrientationAndCutout(mLastOrientation)) {
            updateLayoutForCutout();
            requestLayout();
        }
        return super.onApplyWindowInsets(insets);
    }

Ces méthodes décrivent comment les découpes sont gérées dans la barre d'état dans tous les cas (c'est-à-dire en haut au centre, en haut sans centre, en bas et en double découpe dans toutes les rotations).

Conditions requises

Pour vous assurer que les applications ne sont pas affectées négativement par les découpes, vous devez vous assurer que:

  • La barre d'état s'étend au moins à la hauteur de la découpe en mode portrait
  • En mode plein écran et paysage, la zone d'encoche doit être au format letterbox

Chaque bord court (haut et bas) de votre appareil peut comporter jusqu'à une encoche.

Pour en savoir plus, consultez le Contrat de données.

Implémentation

Pour implémenter des découpes d'écran sur votre appareil, vous devez configurer les valeurs suivantes pour l'UI du système.

Valeur Description
quick_qs_offset_height

Définit la marge supérieure du panneau de configuration rapide. L'horloge et la batterie sont affichées dans l'espace au-dessus du panneau.

Dans le monde des valeurs, définissez la valeur sur status_bar_height_landscape, et en mode portrait, définissez la valeur sur la valeur par défaut de 48 dp ou sur la hauteur de la découpe, la valeur la plus élevée. Peut être plus haut que la découpe si vous le souhaitez.

quick_qs_total_height

Hauteur totale du panneau de réglages rapides (panneau de réglages rapides réduit) lorsque le volet des notifications est développé, y compris l'espace au-dessus du panneau contenant l'horloge.

En raison de la mise en page des paramètres rapides, la hauteur totale du panneau de paramètres rapides (y compris le décalage) doit être connue de manière statique. Par conséquent, cette valeur doit être ajustée par le même delta quick_qs_offset_height. La valeur par défaut de Values-land est 152 dp, tandis que la valeur par défaut en mode portrait est 176 dp.

status_bar_height_portrait

Hauteur par défaut de la barre d'état du point de vue du framework.

Sur la plupart des appareils, cette valeur est définie par défaut sur 24 dp. En cas de découpe, définissez cette valeur sur la hauteur de la découpe. Elle peut éventuellement être plus haute que l'encoche, si vous le souhaitez.

status_bar_height_landscape

Hauteur de la barre d'état en mode Paysage. Les découpes ne sont acceptées que sur les bords courts de l'appareil. La hauteur de la barre d'état sera donc toujours inchangée.

Dans un appareil sans découpe, cela équivaut à status_bar_height_portrait. Lorsqu'une encoche est présente, conservez cette valeur à la hauteur par défaut de la barre d'état.

config_mainBuiltInDisplayCutout

Trajet définissant la forme de l'encoche. Il s'agit d'une chaîne analysable par android.util.PathParser. C'est ainsi que la taille et la forme de la découpe sont définies dans le système.

@dp peut être spécifié sur le chemin d'accès pour émuler une forme ciblant différents appareils. Étant donné que les encoches physiques ont une taille exacte en pixels, n'utilisez pas le spécificateur @dp lorsque vous définissez le chemin d'une encoche matérielle.

config_fillMainBuiltinDisplayCutout

Valeur booléenne qui détermine si le tracé de découpe (défini ci-dessus) doit être dessiné par logiciel. Peut être utilisé pour émuler une découpe ou pour remplir une découpe physique afin d'obtenir un anticrénelage.

Si la valeur est "true", config_mainBuiltInDisplayCutout est rempli en noir.

Pour connaître les définitions par défaut, consultez ces fichiers dimens:

Exemple de superposition pour une découpe émulée:

<resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">

    <!-- The bounding path of the cutout region of the main built-in display.
         Must either be empty if there is no cutout region, or a string that is parsable by
         {@link android.util.PathParser}.

         The path is assumed to be specified in display coordinates with pixel units and in
         the display's native orientation, with the origin of the coordinate system at the
         center top of the display.

         To facilitate writing device-independent emulation overlays, the marker `@dp` can be
         appended after the path string to interpret coordinates in dp instead of px units.
         Note that a physical cutout should be configured in pixels for the best results.
         -->
    <string translatable="false" name="config_mainBuiltInDisplayCutout">
        M 0,0
        L -48, 0
        L -44.3940446283, 36.0595537175
        C -43.5582133885, 44.4178661152 -39.6, 48.0 -31.2, 48.0
        L 31.2, 48.0
        C 39.6, 48.0 43.5582133885, 44.4178661152 44.3940446283, 36.0595537175
        L 48, 0
        Z
        @dp
    </string>

    <!-- Whether the display cutout region of the main built-in display should be forced to
         black in software (to avoid aliasing or emulate a cutout that is not physically existent).
     -->
    <bool name="config_fillMainBuiltInDisplayCutout">true</bool>

    <!-- Height of the status bar -->
    <dimen name="status_bar_height_portrait">48dp</dimen>
    <dimen name="status_bar_height_landscape">28dp</dimen>
    <!-- Height of area above QQS where battery/time go (equal to status bar height if > 48dp) -->
    <dimen name="quick_qs_offset_height">48dp</dimen>
    <!-- Total height of QQS (quick_qs_offset_height + 128) -->
    <dimen name="quick_qs_total_height">176dp</dimen>

</resources>

Validation

Pour valider votre implémentation des découpes d'écran, exécutez les tests CTS à l'adresse tests/framework/base/windowmanager/src/android/server/wm.