PixiThree - v0.0.16
    Preparing search index...

    Interface CanvasViewProps

    interface CanvasViewProps {
        alpha?: boolean;
        antialias?: boolean;
        canvasRef?: RefObject<HTMLCanvasElement | null>;
        className?: string;
        fallback?: ReactNode;
        fpsLimit?: number;
        frameloop?: "always" | "demand";
        onRender?: () => void;
        resolution?: number;
    }

    Hierarchy

    • PropsWithChildren
      • CanvasViewProps
    Index

    Properties

    alpha?: boolean

    Enable alpha transparency, default false

    antialias?: boolean

    Enable antialiasing

    canvasRef?: RefObject<HTMLCanvasElement | null>

    Optional ref to the canvas element. Useful for recording with useCanvasRecorder.

    className?: string

    Class name for the canvas element, default "h-full w-full"

    fallback?: ReactNode

    Canvas fallback content

    fpsLimit?: number

    Optional FPS limit

    frameloop?: "always" | "demand"

    Render mode: "always" or "demand", default "always"

    onRender?: () => void

    Callback invoked after each frame renders. Useful for recording integration.

    resolution?: number

    Canvas resolution. Defaults to window.devicePixelRatio