Flous de fenêtre

Dans Android 12, des API publiques sont disponibles pour implémenter des effets de floutage de fenêtre, tels que le floutage en arrière-plan et le floutage derrière.

Le floutage de fenêtre ou le floutage entre les fenêtres permet de flouter l'écran derrière une fenêtre donnée. Il existe deux types de floutage de fenêtre, qui peuvent être utilisés pour obtenir différents effets visuels:

  • Le floutage de l'arrière-plan vous permet de créer des fenêtres avec des arrière-plans floutés, ce qui crée un effet de verre dépoli.

  • Flou derrière vous permet de flouter l'intégralité de l'écran derrière une fenêtre (boîte de dialogue), créant ainsi un effet de profondeur de champ.

Les deux effets peuvent être utilisés séparément ou combinés, comme illustré dans la figure suivante:

flou d'arrière-plan uniquement

a

flouter l'arrière uniquement

b

floutage de l'arrière-plan et floutage de l'arrière-plan

c

Figure 1 : Flou d'arrière-plan uniquement (a), flou derrière uniquement (b), flou d'arrière-plan et flou derrière (c)

La fonctionnalité de floutage de fenêtre fonctionne dans toutes les fenêtres, ce qui signifie qu'elle fonctionne également lorsqu'une autre application se trouve derrière votre fenêtre. Cet effet n'est pas le même que l'effet de rendu flou, qui floute le contenu à l'intérieur de la même fenêtre. Le floutage des fenêtres est utile pour les boîtes de dialogue, les bottom sheets et d'autres fenêtres flottantes.

Implémentation

Développeurs d'applications

Les développeurs d'applications doivent fournir un rayon de floutage pour créer un effet de floutage. Le rayon de flou contrôle la densité du flou. Autrement dit, plus le rayon est élevé, plus le flou est dense. Un flou de 0 px signifie qu'il n'y a pas de flou. Pour le floutage en arrière-plan, un rayon de 20 px crée un bon effet de profondeur de champ, tandis qu'un rayon de floutage de l'arrière-plan de 80 px crée un bon effet de verre dépoli. Évitez les rayons de flou supérieurs à 150 px, car cela affectera considérablement les performances.

Pour obtenir l'effet de flou souhaité et améliorer la lisibilité, choisissez une valeur de rayon de flou complétée par une couche de couleur translucide.

Flou d'arrière-plan

Utilisez le floutage de l'arrière-plan sur les fenêtres flottantes pour créer un effet d'arrière-plan de fenêtre, qui est une image floutée du contenu sous-jacent. Pour ajouter un arrière-plan flou à votre fenêtre, procédez comme suit:

  1. Appelez Window#setBackgroundBlurRadius(int) pour définir un rayon de floutage de l'arrière-plan. Vous pouvez également définir R.attr.windowBackgroundBlurRadius dans le thème de la fenêtre.

  2. Définissez R.attr.windowIsTranslucent sur "true" pour rendre la fenêtre transparente. Le flou est dessiné sous la surface de la fenêtre. La fenêtre doit donc être translucide pour que le flou soit visible.

  3. Vous pouvez également appeler Window#setBackgroundDrawableResource(int) pour ajouter un drawable d'arrière-plan de fenêtre rectangulaire avec une couleur translucide. Vous pouvez également définir R.attr.windowBackground dans le thème de la fenêtre.

  4. Pour une fenêtre aux coins arrondis, déterminez les coins arrondis de la zone floutée en définissant un ShapeDrawable avec des coins arrondis comme drawable d'arrière-plan de la fenêtre.

  5. Gérer les états de flou activé et désactivé. Pour en savoir plus, consultez la section Consignes d'utilisation du floutage de fenêtre dans les applications.

Floutage en arrière-plan

Le flou derrière floute l'ensemble de l'écran derrière la fenêtre. Cet effet permet de diriger l'attention de l'utilisateur vers le contenu de la fenêtre en floutant tout ce qui se trouve à l'écran derrière la fenêtre.

Pour flouter le contenu derrière votre fenêtre, procédez comme suit:

  1. Ajoutez FLAG_BLUR_BEHIND aux indicateurs de fenêtre pour activer le floutage en arrière-plan. Vous pouvez également définir R.attr.windowBlurBehindEnabled dans le thème de la fenêtre.

  2. Appelez WindowManager.LayoutParams#setBlurBehindRadius pour définir un flou derrière le rayon. Vous pouvez également définir R.attr.windowBlurBehindRadius dans le thème de la fenêtre.

  3. Vous pouvez également choisir un montant de dimension complémentaire.

  4. Gérer les états de flou activé et désactivé. Pour en savoir plus, consultez la section Consignes d'utilisation du floutage de fenêtre dans les applications.

Consignes concernant l'utilisation du floutage de fenêtre dans les applications

La compatibilité avec le floutage des fenêtres dépend des éléments suivants:

  • Version Android: les API de floutage des fenêtres ne sont disponibles que sur Android 12 et versions ultérieures. Vérifiez la version d'Android dans le SDK de l'appareil.

  • Performances graphiques: les appareils équipés de GPU moins performants peuvent choisir de ne pas prendre en charge le floutage des fenêtres.

  • État du système: le serveur système peut désactiver temporairement le floutage des fenêtres au moment de l'exécution, par exemple en mode économie de batterie, lors de la lecture de certains types de contenus vidéo ou en raison d'un forçage par le développeur.

Pour rendre votre application compatible avec les versions d'Android, les appareils et les états système, suivez ces consignes:

  • Ajoutez un écouteur via WindowManager#addCrossWindowBlurEnabledListener pour être informé lorsque le floutage de la fenêtre est activé ou désactivé. De plus, utilisez WindowManager#isCrossWindowBlurEnabled pour déterminer si le floutage des fenêtres est actuellement activé.

  • Implémentez deux versions pour l'arrière-plan de la fenêtre, afin de prendre en charge l'état activé ou désactivé du floutage de la fenêtre.

    Lorsque le floutage est activé, l'arrière-plan de la fenêtre doit être translucide pour que le floutage soit visible. Dans cet état, lorsque les flous sont désactivés, le contenu de la fenêtre se superpose directement au contenu de la fenêtre sous-jacente, ce qui rend la fenêtre superposée moins lisible. Pour éviter un tel effet, lorsque le floutage des fenêtres est désactivé, adaptez l'interface utilisateur de l'application comme suit:

    • Pour le floutage de l'arrière-plan, augmentez l'alpha du drawable d'arrière-plan de la fenêtre, ce qui le rend plus opaque.

    • Pour flouter l'arrière-plan, ajoutez un calque de luminosité avec une valeur de luminosité plus élevée.

Exemple de floutage en arrière-plan et de floutage de l'arrière-plan

Cette section fournit un exemple fonctionnel d'une activité qui utilise à la fois le flou en arrière-plan et le flou d'arrière-plan.

L'exemple suivant de MainActivity.java est une boîte de dialogue avec un rayon de flou derrière de 20 px et un rayon de flou d'arrière-plan de 80 px. Il présente des coins arrondis, définis en XML dans le drawable d'arrière-plan de la fenêtre. Il gère correctement les différentes versions d'Android, les différents appareils (qui ne sont pas forcément compatibles avec le floutage de fenêtre) et les modifications d'activation ou de désactivation du floutage d'exécution. Il garantit que le contenu de la boîte de dialogue est lisible dans toutes ces conditions en ajustant l'alpha du drawable d'arrière-plan de la fenêtre et la luminosité de la fenêtre.

public class MainActivity extends Activity {

    private final int mBackgroundBlurRadius = 80;
    private final int mBlurBehindRadius = 20;

    // We set a different dim amount depending on whether window blur is enabled or disabled
    private final float mDimAmountWithBlur = 0.1f;
    private final float mDimAmountNoBlur = 0.4f;

    // We set a different alpha depending on whether window blur is enabled or disabled
    private final int mWindowBackgroundAlphaWithBlur = 170;
    private final int mWindowBackgroundAlphaNoBlur = 255;

    // Use a rectangular shape drawable for the window background. The outline of this drawable
    // dictates the shape and rounded corners for the window background blur area.
    private Drawable mWindowBackgroundDrawable;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mWindowBackgroundDrawable = getDrawable(R.drawable.window_background);
        getWindow().setBackgroundDrawable(mWindowBackgroundDrawable);

        if (buildIsAtLeastS()) {
            // Enable blur behind. This can also be done in xml with R.attr#windowBlurBehindEnabled
            getWindow().addFlags(WindowManager.LayoutParams.FLAG_BLUR_BEHIND);

            // Register a listener to adjust window UI whenever window blurs are enabled/disabled
            setupWindowBlurListener();
        } else {
            // Window blurs are not available prior to Android S
            updateWindowForBlurs(false /* blursEnabled */);
        }

        // Enable dim. This can also be done in xml, see R.attr#backgroundDimEnabled
        getWindow().addFlags(WindowManager.LayoutParams.FLAG_DIM_BEHIND);
    }

    /**
     * Set up a window blur listener.
     *
     * Window blurs might be disabled at runtime in response to user preferences or system states
     * (e.g. battery saving mode). WindowManager#addCrossWindowBlurEnabledListener allows to
     * listen for when that happens. In that callback we adjust the UI to account for the
     * added/missing window blurs.
     *
     * For the window background blur we adjust the window background drawable alpha:
     *     - lower when window blurs are enabled to make the blur visible through the window
     *       background drawable
     *     - higher when window blurs are disabled to ensure that the window contents are readable
     *
     * For window blur behind we adjust the dim amount:
     *     - higher when window blurs are disabled - the dim creates a depth of field effect,
     *       bringing the user's attention to the dialog window
     *     - lower when window blurs are enabled - no need for a high alpha, the blur behind is
     *       enough to create a depth of field effect
     */
    @RequiresApi(api = Build.VERSION_CODES.S)
    private void setupWindowBlurListener() {
        Consumer<Boolean> windowBlurEnabledListener = this::updateWindowForBlurs;
        getWindow().getDecorView().addOnAttachStateChangeListener(
                new View.OnAttachStateChangeListener() {
                    @Override
                    public void onViewAttachedToWindow(View v) {
                        getWindowManager().addCrossWindowBlurEnabledListener(
                                windowBlurEnabledListener);
                    }

                    @Override
                    public void onViewDetachedFromWindow(View v) {
                        getWindowManager().removeCrossWindowBlurEnabledListener(
                                windowBlurEnabledListener);
                    }
                });
    }

    private void updateWindowForBlurs(boolean blursEnabled) {
        mWindowBackgroundDrawable.setAlpha(blursEnabled && mBackgroundBlurRadius > 0 ?
                mWindowBackgroundAlphaWithBlur : mWindowBackgroundAlphaNoBlur);
        getWindow().setDimAmount(blursEnabled && mBlurBehindRadius > 0 ?
                mDimAmountWithBlur : mDimAmountNoBlur);

        if (buildIsAtLeastS()) {
            // Set the window background blur and blur behind radii
            getWindow().setBackgroundBlurRadius(mBackgroundBlurRadius);
            getWindow().getAttributes().setBlurBehindRadius(mBlurBehindRadius);
            getWindow().setAttributes(getWindow().getAttributes());
        }
    }

    private static boolean buildIsAtLeastS() {
        return Build.VERSION.SDK_INT >= Build.VERSION_CODES.S;
    }
}

Pour créer des coins arrondis pour la fenêtre, nous définissons l'arrière-plan de la fenêtre dans res/drawable/window_background.xml en tant que ShapeDrawable avec des coins arrondis de rayon 20 dp comme suit:

<shape xmlns:android="http://schemas.android.com/apk/res/android" android:shape="rectangle" >
    <corners android:radius="20dp"/>
    <solid android:color="#AAAAAA"/>
</shape>

Le floutage de la fenêtre floute le contenu de la fenêtre sous l'activité. L'image floutée est dessinée sous cette fenêtre d'activité. La fenêtre d'activité doit donc être transparente pour que le floutage soit visible. Pour rendre la fenêtre transparente, nous définissons R.attr.windowIsTranslucent dans le thème de l'activité comme suit:

<style name="Theme.BlurryDialog" parent="Theme.MaterialComponents.Dialog">
    <item name="android:windowIsTranslucent">true</item>
</style>

OEM et partenaires

Pour que le floutage de fenêtre soit disponible sur un appareil, l'OEM doit déclarer que l'appareil est compatible avec le floutage de fenêtre.

Pour vérifier si votre appareil est compatible avec le floutage des fenêtres, procédez comme suit:

  • Assurez-vous que l'appareil peut gérer la charge supplémentaire du GPU. Les appareils d'entrée de gamme ne sont peut-être pas en mesure de gérer la charge supplémentaire, ce qui peut entraîner la perte de frames. N'activez le floutage des fenêtres que sur les appareils testés disposant d'une puissance de GPU suffisante.

  • Si vous disposez d'un moteur de rendu personnalisé, assurez-vous qu'il implémente la logique de floutage. Le moteur de rendu par défaut d'Android 12 implémente la logique de floutage dans BlurFilter.cpp.

Une fois que vous vous êtes assuré que votre appareil est compatible avec le floutage des fenêtres, définissez le flingeur de surface sysprop suivant:

PRODUCT_VENDOR_PROPERTIES += \
       ro.surface_flinger.supports_background_blur=1

Validation

Pour vérifier que la fenêtre de votre application est correctement gérée lors du basculement entre les états de flou activé et de flou désactivé, procédez comme suit:

  1. Ouvrez l'interface utilisateur floutée.

  2. Activez ou désactivez le floutage des fenêtres en activant ou désactivant le floutage des fenêtres.

  3. Vérifiez que l'UI de la fenêtre passe de l'état flou à l'état flou comme prévu.

Activer et désactiver le floutage de la fenêtre

Pour tester l'affichage de l'UI de la fenêtre avec l'effet de floutage de la fenêtre, activez ou désactivez le floutage à l'aide de l'une des méthodes suivantes:

  • Dans les options pour les développeurs:

    Paramètres -> Système -> Options pour les développeurs -> Rendu accéléré par matériel -> Autoriser le flou au niveau de la fenêtre

  • Depuis le terminal d'un appareil en mode root:

    adb shell wm disable-blur 1 # 1 disables window blurs, 0 allows them

Pour vérifier si votre appareil Android 12 ou version ultérieure est compatible avec le floutage des fenêtres et si le floutage des fenêtres est actuellement activé, exécutez adb shell wm disable-blur sur un appareil en mode root.

Dépannage

Utilisez les informations ci-dessous comme guide pour résoudre les problèmes lors de la validation.

Aucun flou dessiné

  • Vérifiez que les flous sont actuellement activés et que votre matériel les prend en charge. Consultez Activer et désactiver le floutage de la fenêtre.

  • Assurez-vous de définir une couleur d'arrière-plan de fenêtre translucide. Une couleur d'arrière-plan de fenêtre opaque masque la zone floutée.

L'appareil de test n'est pas compatible avec le floutage de fenêtre

  • Testez votre application sur l'émulateur Android 12. Pour configurer un émulateur Android, consultez Configurer un émulateur Android. Tout appareil virtuel Android que vous créez avec l'émulateur est compatible avec le floutage de la fenêtre.

Sans coins arrondis

La mise à jour de l'option pour les développeurs n'active pas le floutage

  • Vérifiez si l'appareil est en mode économie de batterie ou s'il utilise le tunneling multimédia. Sur certains téléviseurs, le floutage de la fenêtre peut également être désactivé pendant la lecture d'une vidéo.

Floutage de l'arrière-plan dessiné en plein écran, et non dans les limites de la fenêtre

Les mises à jour de l'écouteur ne sont pas appliquées à l'écran

  • Les mises à jour de l'écouteur sont peut-être appliquées à une ancienne instance de fenêtre. Vérifiez si la fenêtre est détruite et recréée avec la mise à jour de l'écouteur appropriée.