org.cosplay.prefabs.scenes

Type members

Classlikes

class CPFadeShimmerLogoScene(id: String, dim: Option[CPDim], bgPx: CPPixel, colors: Seq[CPColor], nextSc: String, fadeInMs: Long, fadeOutMs: Long, shimmerKeyFrame: Int) extends CPScene

A scene that displays CosPlay logo with shimmering colors for a few seconds using fade in and fade out shaders.

A scene that displays CosPlay logo with shimmering colors for a few seconds using fade in and fade out shaders.

Value parameters:
bgPx

Background pixel of the scene.

colors

Logo will shimmer with these colors. Typically, these should be the game's primary colors.

dim

Optional dimension of the scene. Note that if dimension is None then scene will adapt to the terminal dimension on each frame. That means that the scene's canvas on which all scene objects are rendered can change its size from frame to frame. In such case, make sure that all scene objects take this into account in their rendering routines.

fadeInMs

Optional fade in duration in milliseconds. Default value is 2000.

fadeOutMs

Optional fade out duration in milliseconds. Default value is 1000.

id

ID of the scene.

nextSc

ID of the next scene to switch to once this scene has finished its shimmering logo effect.

shimmerKeyFrame

Optional shimmer shader keyframe. Default value is 2.

See also:
Source:
CPFadeShimmerLogoScene.scala
class CPSlideShimmerLogoScene(id: String, dim: Option[CPDim], bgPx: CPPixel, colors: Seq[CPColor], nextSc: String, slideInMs: Long, slideInDir: CPSlideDirection, slideOutMs: Long, slideOutDir: CPSlideDirection, shimmerKeyFrame: Int) extends CPScene

A scene that displays CosPlay logo with shimmering colors for a few seconds using slide in and slide out shaders.

A scene that displays CosPlay logo with shimmering colors for a few seconds using slide in and slide out shaders.

Value parameters:
bgPx

Background pixel of the scene.

colors

Logo will shimmer with these colors. Typically, these should be the game's primary colors.

dim

Optional dimension of the scene. Note that if dimension is None then scene will adapt to the terminal dimension on each frame. That means that the scene's canvas on which all scene objects are rendered can change its size from frame to frame. In such case, make sure that all scene objects take this into account in their rendering routines.

id

ID of the scene.

nextSc

ID of the next scene to switch to once this scene has finished its shimmering logo effect.

shimmerKeyFrame

Optional shimmer shader keyframe. Default value is 2.

slideInDir

Slide in direction. Default value is CPSlideDirection.LEFT_TO_RIGHT.

slideInMs

Optional slide in duration in milliseconds. Default value is 2000.

slideOutDir

Slide out direction. Default value is CPSlideDirection.LEFT_TO_RIGHT.

slideOutMs

Optional slide out duration in milliseconds. Default value is 1000.

See also:
Source:
CPSlideShimmerLogoScene.scala