import Matrix from "../geom/Matrix"; import ColorTransform from "../geom/ColorTransform"; import Event from "./Event"; import DisplayObjectRenderer from "../display/DisplayObjectRenderer"; declare namespace openfl.events { /** * *BETA** * * RenderEvent is dispatched (optionally) once a listener is added to a * DisplayObject. When the internal Stage renderer is ready to draw the specified * object, a RenderEvent will be dispatched. * * Caching a RenderEvent to access at a later time will not work properly. Also, * since the RenderEvent is more of an internal API, there may be additional * concerns to order to ensure that all objects and features work as-intended. * * The type of RenderEvent dispatched will match the type of rendering being used. * This renderer type will match the default Stage render, but also can depend on * whether an off-screen render (such as DisplayObject `cacheAsBitmap` or BitmapData * `draw`) is being used. * */ export class RenderEvent extends Event { /** * Creates an Event object that contains information about render events. * Event objects are passed as parameters to event listeners. * * @param type The type of the event. Possible values * are: `RenderEvent.CLEAR_DOM`, * `RenderEvent.RENDER_CAIRO`, * `RenderEvent.RENDER_CANVAS`, * `RenderEvent.RENDER_DOM`, and * `RenderEvent.RENDER_OPENGL`. * @param bubbles Determines whether the Event object participates in the * bubbling stage of the event flow. * @param cancelable Determines whether the Event object can be canceled. * @param objectMatrix Sets the concatenated matrix for the display object being rendered. * @param objectTransform Sets the concatenated color transform for the display object being * rendered. * @param allowSmoothing Determines whether the current render should allow smoothing. * */ constructor(type: string, bubbles?: boolean, cancelable?: boolean, objectMatrix?: Matrix, objectColorTransform?: ColorTransform, allowSmoothing?: boolean); /** * The `RenderEvent.CLEAR_DOM` constant defines the value of the `type` property * of an `renderEvent` event object. * * This event has the following properties: * * | Property | Value | * | --- | --- | * | `bubbles` | `true` | * | `cancelable` | `true` | * | `currentTarget` | The object that is actively processing the Event object with an event listener. | * | `renderer` | A reference to the active display object renderer. | * | `target` | The display object that is going to be rendered. | * */ static readonly CLEAR_DOM = "clearDOM"; /** * The `RenderEvent.RENDER_CAIRO` constant defines the value of the `type` property * of an `renderEvent` event object. * * This event has the following properties: * * | Property | Value | * | --- | --- | * | `bubbles` | `true` | * | `cancelable` | `true` | * | `currentTarget` | The object that is actively processing the Event object with an event listener. | * | `renderer` | A reference to the active display object renderer. | * | `target` | The display object that is going to be rendered. | * */ static readonly RENDER_CAIRO = "renderCairo"; /** * The `RenderEvent.RENDER_CANVAS` constant defines the value of the `type` property * of an `renderEvent` event object. * * This event has the following properties: * * | Property | Value | * | --- | --- | * | `bubbles` | `true` | * | `cancelable` | `true` | * | `currentTarget` | The object that is actively processing the Event object with an event listener. | * | `renderer` | A reference to the active display object renderer. | * | `target` | The display object that is going to be rendered. | * */ static readonly RENDER_CANVAS = "renderCanvas"; /** * The `RenderEvent.RENDER_DOM` constant defines the value of the `type` property * of an `renderEvent` event object. * * This event has the following properties: * * | Property | Value | * | --- | --- | * | `bubbles` | `true` | * | `cancelable` | `true` | * | `currentTarget` | The object that is actively processing the Event object with an event listener. | * | `renderer` | A reference to the active display object renderer. | * | `target` | The display object that is going to be rendered. | * */ static readonly RENDER_DOM = "renderDOM"; /** * The `RenderEvent.RENDER_OPENGL` constant defines the value of the `type` property * of an `renderEvent` event object. * * This event has the following properties: * * | Property | Value | * | --- | --- | * | `bubbles` | `true` | * | `cancelable` | `true` | * | `currentTarget` | The object that is actively processing the Event object with an event listener. | * | `renderer` | A reference to the active display object renderer. | * | `target` | The display object that is going to be rendered. | * */ static readonly RENDER_OPENGL = "renderOpenGL"; /** * Whether the current render should allow smoothing. * */ allowSmoothing: boolean; /** * The concatenated color transform for the display object being rendered. * */ objectColorTransform: ColorTransform; /** * The concatenated matrix for the display object being rendered. * */ objectMatrix: Matrix; /** * The display object renderer being used for this render. * */ renderer: DisplayObjectRenderer; override clone(): RenderEvent; override toString(): string; } } export default openfl.events.RenderEvent;