AdaptiveIcons

Description

Holds one localized Android adaptive launcher icon per screen density.

An adaptive icon is a background and a foreground layer the operating system composes and masks to whatever shape the launcher uses, so a density needs both layers to be usable. Assign both layers at every density: Unity writes a locale only when the whole set resolves, because mixing a layer from one density with a layer scaled from another distorts the icon, and a partial set would still outrank the Player Settings icons for that locale. Android 8.0 introduced adaptive icons, so populate AppInfo.LegacyIcons as well to cover older devices.

Additional resources: AppInfo, Icons, IconDensity

Assign a localized adaptive icon for one density.

using Unity.Localization;
using Android = Unity.Localization.Android;

namespace Unity.Localization.Samples
{
    public class AndroidAdaptiveIconsExample
    {
        // Both layers at every density, or the locale keeps the icons from the Player Settings.
        static readonly (Android.IconDensity density, string suffix)[] k_Densities =
        {
            (Android.IconDensity.Low, "ldpi"),
            (Android.IconDensity.Medium, "mdpi"),
            (Android.IconDensity.High, "hdpi"),
            (Android.IconDensity.ExtraHigh, "xhdpi"),
            (Android.IconDensity.ExtraExtraHigh, "xxhdpi"),
            (Android.IconDensity.ExtraExtraExtraHigh, "xxxhdpi")
        };

        public void Run(Android.AppInfo appInfo)
        {
            var icons = appInfo.AdaptiveIcons;
            foreach (var (density, suffix) in k_Densities)
            {
                icons.Background.GetIcon(density).SetReference("App Icons", $"Icon Background {suffix}");
                icons.Foreground.GetIcon(density).SetReference("App Icons", $"Icon Foreground {suffix}");
            }
        }
    }
}

Properties

Public Methods