Takt Android Library

To use Takt in your Android project, add mavenCentral() to your repositories and include the following dependencies. It is recommended to use debugImplementation for the full library and releaseImplementation with the no-op version to ensure the FPS overlay does not appear in production builds.

repositories {
  mavenCentral()
}

dependencies {
  releaseImplementation 'jp.wasabeef:takt-no-op:2.1.1'
  debugImplementation 'jp.wasabeef:takt:2.1.1'
}

For a basic setup, call Takt.stock(this) within your Application class's onCreate method. This will start the FPS measurement and display the overlay.

class MyApplication : Application() {
  override fun onCreate() {
    super.onCreate()
    Takt.stock(this)
  }
}

Use the seat() method to position the FPS overlay on the screen. The available Seat constants are:

• TOP_RIGHT, TOP_LEFT, TOP_CENTER
• CENTER
• RIGHT_CENTER, LEFT_CENTER
• BOTTOM_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER

Takt.stock(this)
  .seat(Seat.RIGHT_CENTER)

If you want to monitor FPS via a listener without displaying the visual overlay on the screen, call .hide() during initialization.

Takt.stock(this)
  .hide()
  .listener { fps -> Log.d("Excellent!", fps.toString() + " fps") }

You can customize the FPS overlay using a builder pattern after calling Takt.stock(this).

Available configuration methods:

• seat(Seat seat): Sets the position of the overlay.
• interval(int ms): Sets the measurement interval in milliseconds.
• color(int color): Sets the text color.
• size(int size): Sets the text size.
• alpha(float alpha): Sets the text transparency (alpha).
• listener(Audience audience): Provides a callback to receive FPS updates.
• useCustomControl: Enables manual start/stop (disabled by default).
• showOverlaySetting: Enables/disables showing system overlay settings (enabled by default).

Takt.stock(this)
  .seat(Seat.BOTTOM_RIGHT)
  .interval(250)
  .color(Color.WHITE)
  .size(14f)
  .alpha(.5f)
  .listener { fps ->
    Log.d("Excellent!", fps.toString() + " fps")
  }