web-ui/src/hooks/useRequestAnimationFrame.ts

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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.
 */

import { useCallback, useEffect, useRef, useState } from "react";

export default function useRequestAnimationFrame(): void {
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  const [_, setCurrentFrame] = useState<number>();
  const animationFrameRequestRef = useRef<number>(null);

  const onAnimationFrameAvailable = useCallback((e: number) => {
    setCurrentFrame(e);
    animationFrameRequestRef.current = requestAnimationFrame(
      onAnimationFrameAvailable
    );
  }, []);

  useEffect(() => {
    animationFrameRequestRef.current = requestAnimationFrame(
      onAnimationFrameAvailable
    );
    return () => cancelAnimationFrame(animationFrameRequestRef.current!);
  }, [onAnimationFrameAvailable]);
}