Home > @unseenco/backstage-core > setCoreRafDriver

setCoreRafDriver() function

Sets the rafDriver that Backstage's core uses internally to tick forward.

Call this **before** any other @unseenco/backstage API that would trigger tick creation (e.g. onChange, sequence.play, val). Calling it after the core ticker has already been initialised will throw.

This is the recommended way to drive Backstage from your own requestAnimationFrame loop — for example when integrating with gsap, lenis, or an XR session:

import { createRafDriver, setCoreRafDriver } from '@unseenco/backstage'

const driver = createRafDriver({ name: 'MyRafDriver' })
setCoreRafDriver(driver)

function myLoop(time: number) {
  driver.tick(time)
  requestAnimationFrame(myLoop)
}
requestAnimationFrame(myLoop)

Because you hold the driver reference you created, you do not need a separate getCoreRafDriver() call — just keep the reference around and call driver.tick(time) from your loop.

Signature:

export declare function setCoreRafDriver(driver: IRafDriver): void;

Parameters

Parameter	Type	Description
driver	IRafDriver

Returns:

void