wasabeef / Takt

Takt is Android library for measuring the FPS using Choreographer.

Screenshot

How do I use it?

Setup

Dependencies

repositories {
  mavenCentral()
}

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

Functions

There is a simple initialization step which occurs in your Application class:
Simple

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

Options

• seat(Seat seat) is a position
• interval(int ms) is a interval
• color(int color) is a text color.
• size(int size) is a text size
• alpha(float alpha) is a text alpha
• listener(Audience audience) is a Listener
• useCustomControl to manually start/stop Takt (disabled by default)
• showOverlaySetting to enable/disable showing system overlay setting (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")

    // Logcat
    // jp.wasabeef.example.takt D/Excellent!﹕ 59.28853754940712 fps
    // jp.wasabeef.example.takt D/Excellent!﹕ 59.523809523809526 fps
    // jp.wasabeef.example.takt D/Excellent!﹕ 59.05511811023622 fps
    // jp.wasabeef.example.takt D/Excellent!﹕ 55.33596837944664 fps
    // jp.wasabeef.example.takt D/Excellent!﹕ 59.523809523809526 fps
  }

Position

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

  /**
   * TOP_RIGHT,
   * TOP_LEFT,
   * TOP_CENTER,
   *
   * CENTER,
   * RIGHT_CENTER,
   * LEFT_CENTER,
   *
   * BOTTOM_RIGHT,
   * BOTTOM_LEFT,
   * BOTTOM_CENTER
   */

Hide fps label

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

Requirements

Android 4.1+ (using the Choreographer)

Developed By

Daichi Furiya (Wasabeef) - [email protected]

License

Copyright (C) 2020 Wasabeef

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.