# DrawMode

Artifact: [androidx.wear.watchface:watchface](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/RenderParameters.kt+class:androidx.wear.watchface.DrawMode) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***


```
public enum DrawMode extends Enum<@NonNull DrawMode>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [kotlin.Enum](https://developer.android.com/reference/java/lang/Enum.html)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) [DrawMode](https://developer.android.com/reference/androidx/wear/watchface/DrawMode)\> ||
|   | ↳ | [androidx.wear.watchface.DrawMode](https://developer.android.com/reference/androidx/wear/watchface/DrawMode) |

*** ** * ** ***

> [!CAUTION]
> **This enum is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/androidx/wear/watchface/DrawMode#AMBIENT` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/DrawMode#INTERACTIVE` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/DrawMode#LOW_BATTERY_INTERACTIVE` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/DrawMode#MUTE` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/DrawMode>` | `[getEntries](https://developer.android.com/reference/androidx/wear/watchface/DrawMode#getEntries())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/DrawMode` | `[valueOf](https://developer.android.com/reference/androidx/wear/watchface/DrawMode#valueOf(kotlin.String))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html value)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull DrawMode[]` | `[values](https://developer.android.com/reference/androidx/wear/watchface/DrawMode#values())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Enum Values

### AMBIENT

```
DrawMode DrawMode.AMBIENT
```

> [!CAUTION]
> **This enum value is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

In this mode as few pixels as possible should be turned on, ideally with darker colors.

Typically watch faces switch to a simplified display when in ambient mode. E.g. if the watch face displays seconds, it should hide them in ambient mode.

Note: In ambient mode the watch face will be rendered once per minute.

### INTERACTIVE

```
DrawMode DrawMode.INTERACTIVE
```

> [!CAUTION]
> **This enum value is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

This mode is used when the user is interacting with the watch face.

This is currently the only mode that is supported when editing the watch face.

### LOW_BATTERY_INTERACTIVE

```
DrawMode DrawMode.LOW_BATTERY_INTERACTIVE
```

> [!CAUTION]
> **This enum value is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

This mode is used when the user is interacting with the watch face but the battery is low, the watch face should render fewer pixels, ideally with darker colors.

### MUTE

```
DrawMode DrawMode.MUTE
```

> [!CAUTION]
> **This enum value is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

This mode is used when there's an interruption filter. The watch face should look muted.

## Public methods

### getEntries

```
public final @NonNull EnumEntries<@NonNull DrawMode> [getEntries](https://developer.android.com/reference/androidx/wear/watchface/DrawMode#getEntries())()
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.

### valueOf

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0)

```
public static final @NonNull DrawMode [valueOf](https://developer.android.com/reference/androidx/wear/watchface/DrawMode#valueOf(kotlin.String))(@NonNull String value)
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

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 |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0)

```
public static final @NonNull DrawMode[] [values](https://developer.android.com/reference/androidx/wear/watchface/DrawMode#values())()
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

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.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using `entries` property as a more efficient alternative returning an immutable list of enum entries.