PixiThree - v0.0.16
    Preparing search index...

    Function ThreeScene

    • A Pixi Sprite that contains React Three Fiber children.

      Renders Three.js 3D content as a Pixi.js sprite. It must be inside a CanvasView component.

      Parameters

      • props: ThreeSceneProps

        Also accepts PixiReactElementProps

        • children: ReactNode

          Children will be rendered into a portal

        • OptionaleventCompute?: ComputeFunction

          Optional event compute for React Three Fiber Events, defaults to undefined

        • OptionaleventPriority?: number

          Optional event priority, defaults to 0

        • OptionalfpsLimit?: number

          Optional FPS limit

        • Optionalframeloop?: "always" | "demand"

          Optional frameloop, defaults to "always"

        • Optionalheight?: number

          Optional height of the texture, defaults to canvas parent bounds

        • OptionalpostProcessing?: (x: RootState) => PostProcessing

          Optional PostProcessing factory, defaults to undefined

        • OptionalrenderPriority?: number

          Optional render priority, defaults to 0

        • OptionalrenderTargetOptions?: RenderTargetOptions

          Optional RenderTarget options

        • Optionalresolution?: number

          Optional resolution of the texture, defaults to canvas parent resolution

        • Optionalwidth?: number

          Optional width of the texture, defaults to canvas parent bounds

      Returns Element

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