PixiThree - v0.0.16
    Preparing search index...

    Function CanvasView

    • A canvas DOM element that contains React Pixi children.

      It must be inside a RenderContext component.

      Parameters

      • props: CanvasViewProps

        Component props

        • Optionalalpha?: boolean

          Enable alpha transparency, default false

        • Optionalantialias?: boolean

          Enable antialiasing

        • OptionalcanvasRef?: RefObject<HTMLCanvasElement | null>

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

        • OptionalclassName?: string

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

        • Optionalfallback?: ReactNode

          Canvas fallback content

        • OptionalfpsLimit?: number

          Optional FPS limit

        • Optionalframeloop?: "always" | "demand"

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

        • OptionalonRender?: () => void

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

        • Optionalresolution?: number

          Canvas resolution. Defaults to window.devicePixelRatio

      Returns Element

      <RenderContext>
      <CanvasView>
      <ThreeScene>
      <SpinnyCube /> // Three.js Object
      </ThreeScene>
      <SpinnyStar /> // Pixi.js Graphic
      </CanvasView>
      </RenderContext>