Interface RenderQueue

A queue of scheduled render shots.

Utilized by render scheduler in order to collect render shots and schedule their execution.

The default implementation may be constructed using :object.by RenderQueue.by() function.

Hierarchy

  • RenderQueue

Methods

  • Adds a render shot to this queue.

    Parameters

    Returns void

  • Adds a render shot to the head of this queue.

    Parameters

    Returns void

  • Retrieves the first added render shot and removes it from the queue.

    Returns undefined | RenderShot

    Either pulled out render shot, or undefined when there is no more render shots.

  • Schedules recurrent render shots execution.

    When defined, this method is responsible for execution of render shots scheduled during preceding render shots execution.

    When not defined, it is expected that schedule executes all scheduled render shots, including recurrent ones.

    Parameters

    • task: ((this) => void)

      A function that performs render shots execution. Should not be executed if there is no recurrent shots.

        • (this): void
        • Parameters

          • this: void

          Returns void

    Returns boolean

    true if recurrent shots scheduled, or false if there is no recurrent shots.

  • Schedules queued render shots execution.

    Parameters

    • task: ((this) => void)

      A function that performs render shots execution.

        • (this): void
        • Parameters

          • this: void

          Returns void

    Returns void

Generated using TypeDoc