public enum SmallImageType extends Enum


The type of image being provided.

This is used to guide rendering on the watch face.

Summary

Enum Values

ICON

Type for images that have a transparent background and are expected to be drawn entirely within the space available, such as a launcher image.

PHOTO

Type for images which are photos that are expected to fill the space available.

Public methods

final @NonNull EnumEntries<@NonNull SmallImageType>

The type of image being provided.

final @NonNull SmallImageType

Returns the enum constant of this type with the specified name.

final @NonNull SmallImageType[]

Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

ICON

SmallImageType SmallImageType.ICON

Type for images that have a transparent background and are expected to be drawn entirely within the space available, such as a launcher image. Watch faces may add padding when drawing these images, but should never crop these images. Icons must not be recolored.

PHOTO

SmallImageType SmallImageType.PHOTO

Type for images which are photos that are expected to fill the space available. Images of this style may be cropped to fit the shape of the complication - in particular, the image may be cropped to a circle. Photos must not be recolored.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull SmallImageTypegetEntries()

The type of image being provided.

This is used to guide rendering on the watch face.

valueOf

Added in 1.0.0
public final @NonNull SmallImageType valueOf(@NonNull String value)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

Added in 1.0.0
public final @NonNull SmallImageType[] values()

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.