PixiThree - v0.0.16
    Preparing search index...

    Function PixiTexture

    • A Three TextureNode that that renders React Pixi children.

      It must be inside a ThreeScene component.

      Parameters

      • props: PixiTextureProps

        Component props

        • Optionalattach?: AttachType
        • OptionalcontainerRef?: Ref<Container<ContainerChild>>

          Pixi Container Ref

        • OptionaleventGuard?: (args: PixiTextureEventData) => boolean

          Optional guard to filter events

        • OptionaleventPriority?: number

          Optional event priority, defaults to 0

        • Optionalevents?: boolean

          Enable event handling, defaults to true

        • OptionalfpsLimit?: number

          Optional FPS limit

        • Optionalframeloop?: "always" | "demand"

          Optional frameloop, defaults to "demand"

        • height: number

          Texture height

        • OptionalobjectRef?: RefObject<Object3D<Object3DEventMap>>

          Optional Object3D for event computation, defaults to fiber parent if any

        • Optionalref?: Ref<TextureNode>
        • width: number

          Texture width

      Returns Element

      <RenderContext>
      <CanvasView>
      <ThreeScene>
      <mesh>
      <boxGeometry />
      <meshBasicMaterial>
      <PixiTexture attach="map" width={512} height={512}>
      <SpinnyStar />
      </PixiTexture>
      </meshBasicMaterial>
      </mesh>
      </ThreeScene>
      </CanvasView>
      </RenderContext>