跳至内容

useCesiumFps

响应式获取Cesium的帧率

Usage

vue
<script setup lang="ts">
import { useCesiumFps } from 'vesium';

const { fps, interval } = useCesiumFps({ delay: 100 });
</script>

<template>
  <div
    w="200px"
    p="10px"
    flex="~ col"
  >
    <span>FPS:{{ fps?.toFixed(2) }}</span>
    <span>Interval:{{ interval?.toFixed(2) }}ms</span>
  </div>
</template>

Type Definitions

typescript
import type { Ref } from 'vue';
export interface UseCesiumFpsOptions {
    /**
     * Throttled sampling (ms)
     * @default 100
     */
    delay?: number;
}
export interface UseCesiumFpsRetrun {
    /**
     * Inter-frame Interval (ms)
     */
    interval: Readonly<Ref<number>>;
    /**
     * Frames Per Second
     */
    fps: Readonly<Ref<number>>;
}
/**
 * Reactive get the frame rate of Cesium
 * @param options options
 * @returns Reactive fps states
 */
export declare function useCesiumFps(options?: UseCesiumFpsOptions): UseCesiumFpsRetrun;