openfl.events.RenderEvent - OpenFL API Reference

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.

Static variables

`@:value("clearDOM")staticinlineread onlyCLEAR_DOM:EventType<RenderEvent> = "clearDOM"`

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.

`@:value("renderCairo")staticinlineread onlyRENDER_CAIRO:EventType<RenderEvent> = "renderCairo"`

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.

`@:value("renderCanvas")staticinlineread onlyRENDER_CANVAS:EventType<RenderEvent> = "renderCanvas"`

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.

`@:value("renderDOM")staticinlineread onlyRENDER_DOM:EventType<RenderEvent> = "renderDOM"`

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.

`@:value("renderOpenGL")staticinlineread onlyRENDER_OPENGL:EventType<RenderEvent> = "renderOpenGL"`

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.

Constructor

`@:value({ allowSmoothing : true, objectColorTransform : null, objectMatrix : null, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, ?objectMatrix:Matrix, ?objectColorTransform:ColorTransform, allowSmoothing:Bool = true)`

Creates an Event object that contains information about render events. Event objects are passed as parameters to event listeners.

Parameters:

`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`.
`bubbles`	Determines whether the Event object participates in the bubbling stage of the event flow.
`cancelable`	Determines whether the Event object can be canceled.
`objectMatrix`	Sets the concatenated matrix for the display object being rendered.
`objectTransform`	Sets the concatenated color transform for the display object being rendered.
`allowSmoothing`	Determines whether the current render should allow smoothing.

Variables

`allowSmoothing:Bool`

Whether the current render should allow smoothing.

`objectColorTransform:ColorTransform`

The concatenated color transform for the display object being rendered.

`objectMatrix:Matrix`

The concatenated matrix for the display object being rendered.

`read onlyrenderer:DisplayObjectRenderer`

The display object renderer being used for this render.

Methods

Inherited Variables

Defined by Event

Inherited Methods

Defined by Event

`@:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String`

A utility function for implementing the toString() method in custom OpenFL Event classes. Overriding the toString() method is recommended, but not required.

class PingEvent extends Event {
	var URL:String;

	public function new() {
		super();
	}

	public override function toString():String {
		return formatToString("PingEvent", "type", "bubbles", "cancelable", "eventPhase", "URL");
	}
}

Parameters:

`className`	The name of your custom Event class. In the previous example, the `className` parameter is `PingEvent`.

Returns:

The name of your custom Event class and the String value of your ...arguments parameter.

`isDefaultPrevented():Bool`

Checks whether the preventDefault() method has been called on the event. If the preventDefault() method has been called, returns true; otherwise, returns false.

Returns:

If preventDefault() has been called, returns true; otherwise, returns false.

`preventDefault():Void`

Cancels an event's default behavior if that behavior can be canceled. Many events have associated behaviors that are carried out by default. For example, if a user types a character into a text field, the default behavior is that the character is displayed in the text field. Because the TextEvent.TEXT_INPUT event's default behavior can be canceled, you can use the preventDefault() method to prevent the character from appearing. An example of a behavior that is not cancelable is the default behavior associated with the Event.REMOVED event, which is generated whenever Flash Player is about to remove a display object from the display list. The default behavior (removing the element) cannot be canceled, so the preventDefault() method has no effect on this default behavior. You can use the Event.cancelable property to check whether you can prevent the default behavior associated with a particular event. If the value of Event.cancelable is true, then preventDefault() can be used to cancel the event; otherwise, preventDefault() has no effect.

`stopImmediatePropagation():Void`

Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. This method takes effect immediately, and it affects event listeners in the current node. In contrast, the stopPropagation() method doesn't take effect until all the event listeners in the current node finish processing.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

`stopPropagation():Void`

Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.