PixiThree - v0.0.16
    Preparing search index...

    Function ThreeRenderTexture

    • A Three.js RenderTarget containing React Three Fiber children.

      It must be inside a ThreeScene component.

      Parameters

      • props: ThreeRenderTextureProps

        Component props

        • Optionalattach?: AttachType

          RenderTarget Texture React Three Fiber attach

        • children: ReactNode

          Children will be rendered into a portal

        • Optionalcompute?: 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

        • OptionalobjectRef?: RefObject<Object3D<Object3DEventMap>>

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

        • Optionaloptions?: RenderTargetOptions

          Optional RenderTarget options

        • Optionalref?: Ref<TextureNode>

          Render TextureNode Ref

        • OptionalrenderPriority?: number

          Optional render priority, defaults to 0

        • 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>
      <mesh>
      <boxGeometry />
      <meshBasicMaterial>
      <ThreeRenderTexture attach="map" width={512} height={512}>
      <SpinnyCube />
      </ThreeRenderTexture>
      </meshBasicMaterial>
      </mesh>
      </ThreeScene>
      </CanvasView>
      </RenderContext>