@realsee/five/vue/hooks/FiveProvider.d.ts

Realsee Renderer SDK

import { Five, Work, Works, State, FiveInitArgs } from "@realsee/five";
import { DefineComponent, PropType } from "vue";
type FiveProviderComponent = DefineComponent<{
    works: PropType<Work[]>;
    initialWorks: PropType<Work[] | Promise<Work[]>>;
    initialState: PropType<"inherit" | "initial" | Partial<Omit<State, "offset">>>;
    initialUserAction: BooleanConstructor;
    onWorksChange: PropType<(work: Works) => void>;
    onStateChange: PropType<(state: State, userAction: boolean) => void>;
    onCurrentStateChange: PropType<(state: State, userAction: boolean) => void>;
    onError: PropType<(error: Error) => void>;
    fiveInitArgs: {
        type: PropType<Omit<FiveInitArgs, "renderer" | "scissor">>;
        default: () => {};
    };
    style: ObjectConstructor;
}, {
    five: Readonly<Five>;
}>;
/**
 * Five 实例化Five 组件
 *
 * 在 FiveProvider 下，可以使用 FiveCanvas 来创建渲染画布。
 * 以及使用 useFiveState useFiveEventCallback等 Five Vue Composition API 来对 FiveProvider 进行操作
 * @description Five 创建Five实例的组件
 * @param FiveProviderComponent - Five 参数
 * @example
 * ```typescript
 * <FiveProvider :initialWork="work">
 *  <FiveCanvas width="512" height="512"/>
 * </FiveProvider>
 * ```
 */
declare const FiveProvider: FiveProviderComponent;
export { FiveProvider, FiveProviderComponent };