Class: Effect

Effect

Effect is a Component that will be picked up by the renderer for post-processing. Most effects are added to the Camera, but some could be tied to a different Entity (for example: a DirectionalLight for crepuscular rays)


new Effect()

Properties:
Name Type Description
needsNormalDepth boolean

Defines whether this Effect needs normal/depth information from the renderer.

needsMotionVectors boolean

Defines whether this Effect needs motion vector information from the renderer.

hdrTarget FrameBuffer

The current full-resolution render target framebuffer.

hdrTargetTexture Texture2D

The current full-resolution texture.

hdrSource Texture2D

The current full-resolution source texture.

Author:
  • derschmale <http://www.derschmale.com>

Extends

Members


acceptVisitor

If provided, this method will be called by the scene partition traverser, allowing collection by the renderer.

Inherited From:

bounds

If a Component has a scene presence, it can have bounds

Inherited From:

enabled

Defines whether or not this component should be enabled.

Inherited From:

onUpdate

If provided, this method will be called every frame, allowing updating the entity.

Inherited From:

Methods


_swapHDRFrontAndBack()

Child classes need to call this when rendering to and from full-resolution textures. This will effectively swap hdrSource and hdrTarget to allow ping-ponging.


bindListener()

Listens to the entity's messenger for a given message type.

Inherited From:

broadcast()

Broadcasts a message dispatched by the owning Entity's onMessage Signal.

Inherited From:

clone()

Creates a duplicate of this Component.

Inherited From:

draw()

This method needs to be implemented by child classes.


hasListeners()

Tests whether the given signal is being listened to.

Inherited From:

invalidateBounds()

Marks the bounds as invalid, causing them to be recalculated when next queried.

Inherited From:

isSupported()

Indicates whether this Effect is supported considering the current capabilities. Subclasses should overwrite this if support depends on extensions.


unbindListener()

Listens to the entity's messenger for a given message type.

Inherited From: