# AugmentedImageDatabaseEntry

Artifact: [androidx.xr.runtime:runtime](https://developer.android.com/jetpack/androidx/releases/xr-runtime) [View Source](https://cs.android.com/search?q=file:androidx/xr/runtime/AugmentedImageDatabaseEntry.kt+class:androidx.xr.runtime.AugmentedImageDatabaseEntry) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-runtime#1.0.0)

*** ** * ** ***


```
class AugmentedImageDatabaseEntry
```

<br />

*** ** * ** ***

Entry in an `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabase`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#AugmentedImageDatabaseEntry(android.graphics.Bitmap,androidx.xr.runtime.AugmentedImageDatabaseEntryMode,kotlin.Float)( bitmap: https://developer.android.com/reference/android/graphics/Bitmap.html, mode: https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntryMode, widthInMeters: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html )` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#copy(android.graphics.Bitmap,androidx.xr.runtime.AugmentedImageDatabaseEntryMode,kotlin.Float)( bitmap: https://developer.android.com/reference/android/graphics/Bitmap.html, mode: https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntryMode, widthInMeters: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html )` |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#toString()()` Returns a string representation of `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry` for debugging. |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/android/graphics/Bitmap.html` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#bitmap()` the bitmap of the image in `https://developer.android.com/reference/android/graphics/Bitmap.Config.html#ARGB_8888` format |
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntryMode` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#mode()` the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntryMode` used to detect the image |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry#widthInMeters()` the physical width of the image in meters. |

## Public constructors

### AugmentedImageDatabaseEntry

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

```
AugmentedImageDatabaseEntry(
    bitmap: Bitmap,
    mode: AugmentedImageDatabaseEntryMode = AugmentedImageDatabaseEntryMode.DYNAMIC,
    widthInMeters: Float = 0.0f
)
```

## Public functions

### copy

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

```
fun copy(
    bitmap: Bitmap = this.bitmap,
    mode: AugmentedImageDatabaseEntryMode = this.mode,
    widthInMeters: Float = this.widthInMeters
): AugmentedImageDatabaseEntry
```

### equals

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

### hashCode

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

### toString

```
open fun toString(): String
```

Returns a string representation of `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntry` for debugging.

Note: Not intended for production use.

## Public properties

### bitmap

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

```
val bitmap: Bitmap
```

the bitmap of the image in `https://developer.android.com/reference/android/graphics/Bitmap.Config.html#ARGB_8888` format

### mode

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

```
val mode: AugmentedImageDatabaseEntryMode
```

the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/AugmentedImageDatabaseEntryMode` used to detect the image

### widthInMeters

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

```
val widthInMeters: Float
```

the physical width of the image in meters. If zero, the physical width will be estimated if the device supports it. If physical size estimation is not supported, configuring the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session` adding an entry with widthInMeters being 0f or lower will throw an `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html`