Rezi
    Preparing search index...

    Interface FrameInspector

    Frame inspector interface for analyzing frame history.

    interface FrameInspector {
        count: number;
        addFrame(record: FrameRecord, timestampUs: bigint): void;
        clear(): void;
        compareFrames(
            a: bigint,
            b: bigint,
        ):
            | Readonly<
                {
                    changed: readonly Readonly<
                        { after: unknown; before: unknown; field: string },
                    >[];
                    frameA: bigint;
                    frameB: bigint;
                },
            >
            | null;
        getFrame(
            frameId: bigint,
        ):
            | Readonly<
                {
                    cols: number;
                    damageRects: number;
                    diffBytesEmitted: number;
                    dirtyCells: number;
                    dirtyLines: number;
                    drawlistBytes: number;
                    drawlistCmds: number;
                    frameId: bigint;
                    rows: number;
                    timestamp: number;
                    usDiff: number;
                    usDrawlist: number;
                    usWrite: number;
                },
            >
            | null;
        getSnapshots(
            last?: number,
        ): readonly Readonly<
            {
                cols: number;
                damageRects: number;
                diffBytesEmitted: number;
                dirtyCells: number;
                dirtyLines: number;
                drawlistBytes: number;
                drawlistCmds: number;
                frameId: bigint;
                rows: number;
                timestamp: number;
                usDiff: number;
                usDrawlist: number;
                usWrite: number;
            },
        >[];
    }
    Index

    Properties

    count

    Methods

    addFrame clear compareFrames getFrame getSnapshots

    Properties

    count: number

    Get the number of stored snapshots.

    Methods

    • Compare two frames and return the differences.

      Parameters

      • a: bigint

        First frame ID

      • b: bigint

        Second frame ID

      Returns
          | Readonly<
              {
                  changed: readonly Readonly<
                      { after: unknown; before: unknown; field: string },
                  >[];
                  frameA: bigint;
                  frameB: bigint;
              },
          >
          | null

    • Get a specific frame by ID.

      Parameters

      • frameId: bigint

        The frame ID to look up

      Returns
          | Readonly<
              {
                  cols: number;
                  damageRects: number;
                  diffBytesEmitted: number;
                  dirtyCells: number;
                  dirtyLines: number;
                  drawlistBytes: number;
                  drawlistCmds: number;
                  frameId: bigint;
                  rows: number;
                  timestamp: number;
                  usDiff: number;
                  usDrawlist: number;
                  usWrite: number;
              },
          >
          | null

    • Get the last N frame snapshots.

      Parameters

      • Optionallast: number

        Number of frames to return (default: all)

      Returns readonly Readonly<
          {
              cols: number;
              damageRects: number;
              diffBytesEmitted: number;
              dirtyCells: number;
              dirtyLines: number;
              drawlistBytes: number;
              drawlistCmds: number;
              frameId: bigint;
              rows: number;
              timestamp: number;
              usDiff: number;
              usDrawlist: number;
              usWrite: number;
          },
      >[]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods