Color shimmer shader.
This shader provides color shimmer effect for the entire camera frame or the individual scene object it is attached to. Shimmering consists of randomly changing a color of the pixel for a small period of time. If used for entire camera frame effect it can be attached to an off-screen sprite. Note that unlike CPSparkleShader that provides similar effect but with gradual dimming and brightening of color, the shimmer effect employs random color selection from the given set of colors.
- Value parameters:
Whether to start shader right away. Default value is
Sequence of colors to use for shimmering effect. Colors will be selected randomly from this set.
Duration of the effect in milliseconds. By default, the effect will go forever.
Whether apply to the entire camera frame or just the object this shader is attached to.
nth-frame to render the effect. For example, if key frame is
5than the colors will change on each 5th frame and remain the same on all subsequent frames until next key frame is reached.
Optional callback to call when this shader finishes by exceeding the duration specified by
durMsparameter. Default is a no-op.
Predicate allowing to skip certain pixel from the shader. Predicate takes a pixel (with its Z-order), and X and Y-coordinate of that pixel. Note that XY-coordinates are always in relation to the entire canvas. Typically used to skip background or certain Z-index. Default predicate returns
falsefor all pixels.
- See also:
See CPShaderExample class for the example of using shaders.
Called on each frame pass on scene object that has this shaders attached to it. This callback is called regardless of whether or not the scene object is visible or in camera frame.
Gets the origin of this asset. Typically, this should be a URL, file name or class name for in-code assets like array images, animations or system font.