Threepipe Path Tracing Plugins
    Preparing search index...

    Class ThreeGpuPathTracerPlugin

    ThreeGpuPathTracerPlugin

    Path Tracing plugin for Threepipe using three-gpu-pathtracer.

    This plugin allows for GPU-accelerated path tracing in Three.js scenes. (using webgl2)

    It provides options to configure the path tracing parameters such as bounces, samples per frame, and more. It also integrates with the Three.js scene and camera, updating materials and lights as needed. Serialization and deserialization are supported for plugin state management. It listens to scene updates, camera changes, and material updates to refresh the path tracing setup. It can be enabled or disabled, and it automatically handles rendering to the screen or to a texture. It supports progressive rendering, allowing for a smooth transition of rendered frames.

    Hierarchy

    • AViewerPluginSync
      • ThreeGpuPathTracerPlugin
    Index

    Constructors

    Properties

    _dirty: boolean = false
    _viewer?: ThreeViewer
    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    dependencies: typeof ProgressivePlugin[] = ...
    enabled: boolean = true
    samplesPerFrame: number = 1
    tracer: undefined | WebGLPathTracer
    uiConfig?: UiObjectConfig<any, string, any> = undefined
    OldPluginType?: string
    PluginType: "ThreeGpuPathTracerPlugin" = 'ThreeGpuPathTracerPlugin'

    Accessors

    Methods

    • Parameters

      • e: IViewerEvent

      Returns IViewerEvent

    • Parameters

      • Optionalprefix: string

      Returns string

    • Parameters

      • key: any
      • setDirty: boolean = true

      Returns void

    • Parameters

      • key: any
      • setDirty: boolean = true

      Returns void

    • Returns ISerializedConfig | Record<string, never>

    • Parameters

      • state: any

      Returns Promise<void>

    • Parameters

      • viewer: ThreeViewer

      Returns void

    • Parameters

      • Optionalmeta: SerializationMetaType

      Returns ISerializedConfig