Interface DelegateRenderScheduler<TExecution, TOptions>

Context entry containing RenderScheduler instance.

This instance is globally singleton.

Uses default render scheduler by default.

Type Parameters

TExecution extends RenderExecution = RenderExecution

A type of supported render shot execution context.
TOptions extends RenderScheduleOptions = RenderScheduleOptions

A type of accepted render schedule options.

Hierarchy

RenderScheduler<TExecution, TOptions>
- DelegateRenderScheduler

DelegateRenderScheduler(this, options?): RenderSchedule<TExecution>
Render scheduler signature.

This function creates a render schedule according to the given options.

The default render scheduler is always available as newRenderSchedule function.

There are several scheduler implementations exist:
- animationRenderScheduler (used by default),
- asyncRenderScheduler,
- immediateRenderScheduler,
- queuedRenderScheduler,
- ManualRenderScheduler,
- noopRenderScheduler.
Custom scheduler implementations could be created using customRenderScheduler function.
Parameters
- this: void
- Optional options: TOptions
  
  Created render schedule options.
Returns RenderSchedule<TExecution>
New render schedule.
- Defined in render-scheduler.ts:33

Index

Methods

Methods

scheduleBy

scheduleBy(this, scheduler): DelegateRenderScheduler<TExecution, TOptions>
Switches a render scheduler to schedule rendering by.

The previously scheduled render shots would still be executed by previous scheduler.

Does nothing if the target scheduler is the same as previous one.
Parameters
- this: void
- scheduler: RenderScheduler<TExecution>
  
  A render scheduler to schedule rendering by from now on.
Returns DelegateRenderScheduler<TExecution, TOptions>
this instance.
- Defined in delegate-render-scheduler.ts:30

Generated using TypeDoc