# 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)

*** ** * ** ***


```
public final class AugmentedImageDatabaseEntry
```

<br />

*** ** * ** ***

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

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#AugmentedImageDatabaseEntry(android.graphics.Bitmap,androidx.xr.runtime.AugmentedImageDatabaseEntryMode,kotlin.Float)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html bitmap, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntryMode mode, float widthInMeters )` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry` | `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#copy(android.graphics.Bitmap,androidx.xr.runtime.AugmentedImageDatabaseEntryMode,kotlin.Float)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html bitmap, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntryMode mode, float widthInMeters )` |
| `boolean` | `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html` | `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#getBitmap()()` the bitmap of the image in `https://developer.android.com/reference/android/graphics/Bitmap.Config.html#ARGB_8888` format |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntryMode` | `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#getMode()()` the `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntryMode` used to detect the image |
| `final float` | `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#getWidthInMeters()()` the physical width of the image in meters. |
| `int` | `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry#toString()()` Returns a string representation of `https://developer.android.com/reference/androidx/xr/runtime/AugmentedImageDatabaseEntry` for debugging. |

## Public constructors

### AugmentedImageDatabaseEntry

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

```
public AugmentedImageDatabaseEntry(
    @NonNull Bitmap bitmap,
    @NonNull AugmentedImageDatabaseEntryMode mode,
    float widthInMeters
)
```

## Public methods

### copy

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

```
public final @NonNull AugmentedImageDatabaseEntry copy(
    @NonNull Bitmap bitmap,
    @NonNull AugmentedImageDatabaseEntryMode mode,
    float widthInMeters
)
```

### equals

```
public boolean equals(Object other)
```

### getBitmap

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

```
public final @NonNull Bitmap getBitmap()
```

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

### getMode

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

```
public final @NonNull AugmentedImageDatabaseEntryMode getMode()
```

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

### getWidthInMeters

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

```
public final float getWidthInMeters()
```

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/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`

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```

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

Note: Not intended for production use.