CarIcon.Builder

Builder(carIcon: CarIcon)

Returns a Builder instance configured with the same data as the given CarIcon instance.

Builder(icon: IconCompat)

Creates a Builder instance using the given IconCompat.

The following types are supported:

• TYPE_BITMAP
• TYPE_RESOURCE
• TYPE_URI

TYPE_URI is only supported in templates that explicitly allow it. In those cases, the appropriate APIs will be documented to indicate this.

For TYPE_URI, the URI's scheme must be SCHEME_CONTENT.

If the icon image is loaded from URI, it may be cached on the host side. Changing the contents of the URI will result in the host showing a stale image.

Note: It is recommended to use createTintedIcon, createOriginalIcon, or Builder to explicitly specify visual styling behavior. This constructor will be deprecated in a future release.

Builder(icon: IconCompat, style: CarIconStyle)

Creates a Builder instance using the given IconCompat and explicit CarIconStyle.

The following types are supported:

• TYPE_BITMAP
• TYPE_RESOURCE
• TYPE_URI

TYPE_URI is only supported in templates that explicitly allow it. In those cases, the appropriate APIs will be documented to indicate this.

For TYPE_URI, the URI's scheme must be SCHEME_CONTENT.

If the icon image is loaded from URI, it may be cached on the host side. Changing the contents of the URI will result in the host showing a stale image.

Select the appropriate style depending on the asset:

• Use TINTED for icons that should be automatically tinted by the vehicle theme or assigned a custom tint via setTint.
• Use ORIGINAL for icons that must retain their original colors without host-side tinting (e.g., user avatars, media album art, photos, or un-tinted logos).

fun build(): CarIcon

Constructs the CarIcon defined by this builder.

fun setStyle(style: CarIconStyle): CarIcon.Builder

Sets the style of the icon to the given CarIconStyle.

Select the appropriate style depending on the asset:

• Use TINTED for icons that should be automatically tinted by the vehicle theme or assigned a custom tint via setTint.
• Use ORIGINAL for icons that must retain their original colors without host-side tinting (e.g., user avatars, media album art, photos, or un-tinted logos).

fun setTint(tint: CarColor): CarIcon.Builder

Sets the tint of the icon to the given CarColor.

This tint overrides the tint set through setTint in the backing IconCompat with a CarColor tint. The tint set through setTint is not guaranteed to be applied if the CarIcon tint is not set.

The tint mode used to blend this color is SRC_IN.

Depending on contrast requirements, capabilities of the vehicle screens, or other factors, the color may be ignored by the host or overridden by the vehicle system.