メインコンテンツまでスキップ

ライフサイクルとイベント

ライフサイクルフック​

設定モジュールはコンポジター起動時に読み込まれ、編集すると再読み込みされます （ホットリロード）。2つのフックで初期化／後始末のコードを実行でき、リロードを またいで状態を引き継ぐことができます。

COMPOSITOR.onEnable((event) => {
  if (event.isReloading) {
    const saved = event.restore<MyState>('my-state');
    if (saved) applyState(saved);
  }
});

COMPOSITOR.onDisable((event) => {
  if (event.isReloading) {
    event.persist('my-state', snapshotState());
  }
});
  • onEnable(listener) — 設定が適用された後に実行されます。event.isReloading は ホットリロード時に true（新規セッションとの区別）。event.restore<T>(key) で前の バージョンが保存した状態を読めます。
  • onDisable(listener) — 設定が破棄される前に実行されます。event.persist(key, value) で次のバージョンが復元できる状態を保存します。

この persist／restore のペアは、デフォルト設定がウィンドウマネージャのレイアウト （ワークスペース、タイル状態）を編集をまたいでちらつきなく保持するために使っている 仕組みです。どちらも COMPOSITOR.event.onEnable / onDisable のショートハンドです。

デバッグトグル​

COMPOSITOR.debug は本番動作に影響しない開発専用のスイッチを持ちます。

COMPOSITOR.key.bind('fps', 'Super+Shift+F', () => {
  COMPOSITOR.debug.fpsCounter = !COMPOSITOR.debug.fpsCounter;
});
  • fpsCounter: boolean — 各出力の左上に小さな FPS／フレーム時間オーバーレイを 描画します。

イベントバス​

COMPOSITOR.event は、ウィンドウ・入力・出力・レイヤーの動きをカバーする on* 購読のバスです。すべての on* メソッドは解除関数を返します。リスナーは、ウィンドウを レイアウトロジックに結びつける場所です。

COMPOSITOR.event.onOpen((window) => {
  console.log('opened', window.id);
});

COMPOSITOR.event.onFocus((window, focused) => {
  window.animation.start(focusVar, {to: focused ? 1 : 0, duration: ms(120)});
});

ウィンドウのライフサイクル​

イベント発火タイミング
onOpen(window)トップレベルウィンドウが作成されたとき
onFirstCommit(window)最初のバッファをコミットしたとき（表示可能になった）
onFocus(window, focused)キーボードフォーカスを得た／失ったとき
onStartClose(window)閉じるシーケンスが始まったとき（閉じるアニメーションに最適）
onClose(window)ウィンドウが破棄されたとき

ウィンドウからの要求​

クライアントがコンポジターにウィンドウ状態の変更を求めたときに発火します。どう応じるかは あなたのウィンドウマネージャが決めます。

イベント発火タイミング
onWindowResize(event)インタラクティブなリサイズが起きたとき
onWindowMove(event)インタラクティブな移動が起きたとき
onWindowMaximizeRequest(event)クライアントが最大化／解除を要求
onWindowMinimizeRequest(event)クライアントが最小化を要求
onWindowFullscreenRequest(event)クライアントがフルスクリーン／解除を要求
onWindowActivateRequest(event)クライアントがアクティブ化／フォーカスを要求

入力・出力・レイヤー​

イベント発火タイミング
onPointerMoveAsync(event)ポインターが移動したとき（非同期、下記参照）
onGestureSwipeAsync(event)マルチフィンガースワイプが進行したとき
onOutputChange(event)出力が追加／削除／再構成されたとき
onInputDeviceChange(...)入力デバイスのセットが変わったとき（ホットプラグ）
onCreateLayer(...) / onUpdateLayer(...) / onDestroyLayer(...)レイヤーシェルサーフェス（バー／ドック／壁紙）がマップ／更新／アンマップされたとき

非同期リスナー​

ポインター移動とジェスチャーのイベントには非同期版 （onPointerMoveAsync・onGestureSwipeAsync）があります。リスナーは Promise を 返すことができ、コンポジターはそれを await してから処理を続けます。false（または Promise<false>）を返すとそれ以降の処理を抑制します。1イベントごとに重い処理を行う ハンドラでは、入力経路をブロックしないようこちらを使ってください。

COMPOSITOR.event.onPointerMoveAsync((event) => {
  hybridWM.onPointerMove(event);
});