MemoryUsageMetric.SubMetric

Artifact: androidx.benchmark:benchmark-macro

Added in 1.2.0

Kotlin |Java

public enum MemoryUsageMetric.SubMetric extends Enum

java.lang.Object
↳	kotlin.Enum
	↳	androidx.benchmark.macro.MemoryUsageMetric.SubMetric

Summary

Enum Values
`Gpu`	Measures the amount of GPU-specific memory allocated for the process.
`HeapSize`	Tracks the total size of the Android Runtime (ART) heap.
`RssAnon`	Measures anonymous resident set size memory.
`RssFile`	Measures memory used to map files from disk into the process's address space.
`RssShmem`	Tracks shared memory resident in the process.

Public methods
`final @NonNull EnumEntries<@NonNull MemoryUsageMetric.SubMetric>`	`getEntries()` Returns an immutable `kotlin.enums.EnumEntries` list containing the constants of this enum type, in the order they're declared.
`static final @NonNull MemoryUsageMetric.SubMetric`	`valueOf(@NonNull String value)` Returns the enum constant of this type with the specified name.
`static final @NonNull MemoryUsageMetric.SubMetric[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

Gpu

MemoryUsageMetric.SubMetric MemoryUsageMetric.SubMetric.Gpu

Measures the amount of GPU-specific memory allocated for the process. This is particularly useful for identifying high memory usage related to textures, shaders, or other graphics-heavy components.

HeapSize

MemoryUsageMetric.SubMetric MemoryUsageMetric.SubMetric.HeapSize

Tracks the total size of the Android Runtime (ART) heap. These samples are typically captured immediately after a Garbage Collection (GC) event, providing a look at the "live" set of objects in the application's managed memory.

RssAnon

MemoryUsageMetric.SubMetric MemoryUsageMetric.SubMetric.RssAnon

Measures anonymous resident set size memory. This represents memory allocated directly by the process—such as via malloc or mmap—that is not backed by any file on disk. It is often the primary indicator of the app's dynamic memory consumption.

RssFile

MemoryUsageMetric.SubMetric MemoryUsageMetric.SubMetric.RssFile

Measures memory used to map files from disk into the process's address space. This includes shared libraries, dex files, and other resource assets loaded by the application.

RssShmem

MemoryUsageMetric.SubMetric MemoryUsageMetric.SubMetric.RssShmem

Tracks shared memory resident in the process. This includes memory shared between processes, such as shared buffers or specialized memory regions.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull MemoryUsageMetric.SubMetric> getEntries()

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

valueOf

Added in 1.2.0

public static final @NonNull MemoryUsageMetric.SubMetric 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.2.0

public static final @NonNull MemoryUsageMetric.SubMetric[] 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.

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.