doodle.interact.effect.AnimationWriter.scala Maven / Gradle / Ivy
/*
* Copyright 2015 Creative Scala
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package doodle
package interact
package effect
import cats.Monoid
import cats.effect.IO
import doodle.algebra.Algebra
import doodle.algebra.Picture
import doodle.effect.Writer
import fs2.Stream
import java.io.File
/** The `AnimationWriter` typeclass describes a data type that can write an
* animation to a file.
*/
trait AnimationWriter[Alg <: Algebra, Frame, Format]
extends Writer[Alg, Frame] {
def write[A](
file: File,
description: Frame,
frames: Stream[IO, Picture[Alg, A]]
)(implicit m: Monoid[A]): IO[A]
}