Class PlasmaGenerator

A plasma generator.

Hierarchy

  • EventTarget
    • PlasmaGenerator

Implements

Constructors

constructor

Properties

handle imageData queued workers

Accessors

isReady

Methods

addEventListener dispatchEvent removeEventListener render

Constructors

constructor

Properties

Protected handle

handle: PlasmaHandle

Protected imageData

imageData: ImageData

Protected queued

queued: number

Protected workers

workers: Worker[]

Accessors

isReady

Methods

addEventListener

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Parameters

    • type: string
    • callback: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

dispatchEvent

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

removeEventListener

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    Parameters

    • type: string
    • callback: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

render

  • Requests the next bitmap rendition.

    A "bitmap" custom event with a property detail of the BitmapDetail type is being emitted.

    There may be more than one event per single rendition if the data comes from multiple workers.

    An "error" event is being emitted in case of an error.

    A "ready" event is being emitted when generator finishes rendering the whole bitmap and can render again.

    Returns false if the generator has not yet finished its previous rendition. In this instance wait for a "ready" event and try again once it arrives.

    Returns boolean

Settings

Member Visibility

Theme