491f0cd08a
* Copyright headers 1 * Licence headers 2 * Copyright Headers 3 * Copyright Headers 4 * Copyright Headers 5 * Copyright Headers 6 * Copyright headers 7 * Add copyright headers for html and config file * Replace license files and update package.json * Update with CLA * lint
29 lines
832 B
TypeScript
29 lines
832 B
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2020 Nurjin Jafar
|
|
Copyright 2020 Nordeck IT + Consulting GmbH.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
/**
|
|
* Defines the interface of a canvas based room effect
|
|
*/
|
|
export default interface ICanvasEffect {
|
|
/**
|
|
* @param {HTMLCanvasElement} canvas The canvas instance as the render target of the animation
|
|
* @param {number} timeout? A timeout that defines the runtime of the animation (defaults to false)
|
|
*/
|
|
start: (canvas: HTMLCanvasElement, timeout?: number) => Promise<void>;
|
|
|
|
/**
|
|
* Stops the current animation
|
|
*/
|
|
stop: () => Promise<void>;
|
|
|
|
/**
|
|
* Returns a value that defines if the animation is currently running
|
|
*/
|
|
isRunning: boolean;
|
|
}
|