pixi.js
Version:
<p align="center"> <a href="https://pixijs.com" target="_blank" rel="noopener noreferrer"> <img height="150" src="https://files.pixijs.download/branding/pixijs-logo-transparent-dark.svg?v=1" alt="PixiJS logo"> </a> </p> <br/> <p align="center">
40 lines (39 loc) • 1.49 kB
TypeScript
import type { Renderer } from '../../../rendering/renderers/types';
import type { Container } from '../Container';
/** @internal */
export interface OnRenderMixinConstructor {
/**
* This callback is used when the container is rendered. It runs every frame during the render process,
* making it ideal for per-frame updates and animations.
*
* > [!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
* > and "updateTransform" is no longer called every frame
* @example
* ```ts
* // Basic rotation animation
* const container = new Container();
* container.onRender = () => {
* container.rotation += 0.01;
* };
*
* // Cleanup when done
* container.onRender = null; // Removes callback
* ```
* @param renderer - The renderer instance
* @see {@link Renderer} For renderer capabilities
*/
onRender?: ((renderer: Renderer) => void | null);
}
/**
* The OnRenderMixin interface provides a way to define a callback that is executed
* every time the container is rendered. This is useful for adding custom rendering logic
* or animations that need to be updated each frame.
* @category scene
* @advanced
*/
export interface OnRenderMixin extends Required<OnRenderMixinConstructor> {
/** @private */
_onRender: ((renderer: Renderer) => void) | null;
}
/** @internal */
export declare const onRenderMixin: Partial<Container>;