# ImageVector

Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/graphics/vector/ImageVector.kt+class:androidx.compose.ui.graphics.vector.ImageVector) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/All
- Cmn

  ```
  class ImageVector
  ```

*** ** * ** ***

Vector graphics object that is generated as a result of `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder` It can be composed and rendered by passing it as an argument to `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/rememberVectorPainter.composable#rememberVectorPainter(androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,kotlin.Float,kotlin.Float,kotlin.String,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.BlendMode,kotlin.Function2)`

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder` Builder used to construct a Vector graphic tree. |
| `object https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Companion` |

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#hashCode()()` | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#autoMirror()` Determines if the vector asset should automatically be mirrored for right to left locales | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#defaultHeight()` Intrinsic height of the vector asset in `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#defaultWidth()` Intrinsic width of the vector asset in `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#name()` Name of the Vector asset | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/VectorGroup` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#root()` Root group of the vector asset that contains all the child groups and paths | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/BlendMode` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#tintBlendMode()` Blend mode used to apply `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#(kotlin.String,androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.vector.VectorGroup,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.BlendMode,kotlin.Boolean,kotlin.Int)` | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#tintColor()` Optional tint color to be applied to the vector graphic | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#viewportHeight()` Used to define the height of the viewport space. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#viewportWidth()` Used to define the width of the viewport space. | Cmn |

| ### Extension functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#(androidx.compose.ui.graphics.vector.ImageVector).toRemoteImageVector()()` Converts a Compose UI `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector` to a `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector`. | android |

## Public functions

### equals

Cmn

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

Cmn

```
open fun hashCode(): Int
```

## Public properties

### autoMirror

Cmn Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.2.0)

```
val autoMirror: Boolean
```

Determines if the vector asset should automatically be mirrored for right to left locales

### defaultHeight

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val defaultHeight: Dp
```

Intrinsic height of the vector asset in `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp`

### defaultWidth

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val defaultWidth: Dp
```

Intrinsic width of the vector asset in `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp`

### name

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val name: String
```

Name of the Vector asset

### root

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val root: VectorGroup
```

Root group of the vector asset that contains all the child groups and paths

### tintBlendMode

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val tintBlendMode: BlendMode
```

Blend mode used to apply `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector#(kotlin.String,androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.vector.VectorGroup,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.BlendMode,kotlin.Boolean,kotlin.Int)`

### tintColor

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val tintColor: Color
```

Optional tint color to be applied to the vector graphic

### viewportHeight

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val viewportHeight: Float
```

Used to define the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.

### viewportWidth

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val viewportWidth: Float
```

Used to define the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.

## Extension functions

### ImageVector.toRemoteImageVector

android Artifact: [androidx.compose.remote:remote-creation-compose](https://developer.android.com/jetpack/androidx/releases/compose-remote) [View Source](https://cs.android.com/search?q=file:androidx/compose/remote/creation/compose/capture/RemoteImageVectorAndroid.kt+function:toRemoteImageVector)

```
fun ImageVector.toRemoteImageVector(): RemoteImageVector
```

Converts a Compose UI `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector` to a `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector`.