Back to Filament

setPaused

docs/android/dokka/filament-android/com.google.android.filament/-engine/set-paused.md

1.75.0727 B
Original Source

//filament-android/com.google.android.filament/Engine/setPaused

setPaused

[main]
open fun setPaused(paused: Boolean)

Pause or resume the rendering thread.

Warning: This is an experimental API. In particular, note the following caveats.

  • Buffer callbacks will never be called as long as the rendering thread is paused. Do not rely on a buffer callback to unpause the thread.
  • While the rendering thread is paused, rendering commands will continue to be queued until the buffer limit is reached. When the limit is reached, the program will abort.