CPSlideOutShader

org.cosplay.prefabs.shaders.CPSlideOutShader

See theCPSlideOutShader companion object

class CPSlideOutShader(dir: CPSlideDirection, entireFrame: Boolean, durMs: Long, bgPx: CPPixel, onFinish: CPSceneObjectContext => Unit, autoStart: Boolean, skip: (CPZPixel, Int, Int) => Boolean, balance: (Int, Int) => Float) extends CPShader

Slide out shader.

This shader can be used for 'slide out' or the directional gradual hide effect for the entire camera frame or the individual scene object it is attached to. If used for entire camera frame effect it can be attached to an off-screen sprite.

Attributes

autoStart: Whether to start shader right away. Default value is false.
balance: A function that produces value in [0, 1] range that is used in color mixture. Value 0 means that the color will be 100% background, value 1 means that the color will be 100% the actual pixel color, value 0.5 means that the color will be a 50% mix between the background and the actual pixel color. The function takes two parameters: first is a current frame number since the start of the effect, and the second parameter is the last frame number of the effect. First parameter is always less then the second one. By default, the the (a, b) => a.toFloat / b function is used that gives gradual color transition through the frames range. Another popular function to use here is a sigmoid function: (a, b) => sigmoid.value(a - b / 2).toFloat that gives a different visual effect.
bgPx: Background pixel to fade out to.
dir: Slide direction as defined by CPSlideDirection.
durMs: Duration of the effect in milliseconds.
entireFrame: Whether apply to the entire camera frame or just the object this shader is attached to.
onFinish: Optional callback to call when this shader finishes. Default is a no-op.
skip: 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 false for all pixels.
See also:: CPFadeInShader

CPFadeOutShader

CPSlideInShader

CPShimmerShader

CPSparkleShader

CPStarStreakShader

CPFlashlightShader

CPOffScreenSprite
Example:: See CPShaderExample class for the example of using shaders.
Companion:: object
Source:: CPSlideOutShader.scala
Graph
Supertypes: trait CPShader
trait CPAsset
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Tests whether this shader is in progress.

Attributes

Source:: CPSlideOutShader.scala

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.

Attributes

Definition Classes: CPShader
Source:: CPSlideOutShader.scala

Set the callback to call when shader effect is finished.

Attributes

onFinish: Override for the callback to call when shader effect is finished.
Source:: CPSlideOutShader.scala

Resets this shaders to its initial state starting its effect on the next frame.

Attributes

onFinish: Optional override for the callback to call when shader effect is finished. If not provided, the default value is the callback supplied at the creation of this shader.
Source:: CPSlideOutShader.scala

Inherited fields

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.

Attributes

Inherited from:: CPShader
Source:: CPShader.scala

Generated with