comic/render [ Methods ]

[ Top ] [ comic ] [ Methods ]

Name

 render

File

 render.lsp

Description

 Render a comic (or an event) to one or more protagonists.

Arguments

 - comic: The object to render. Can also be an event or a list
   of events
 - protagonists: One or more protagonists to render to

Optional Arguments

 - output-dir: Overwrite the default output directory
 - print: Print additional information on the render-process
 - auto-complete-time: Auto-complete start-times and durations
   The algorithm should be able to always auto-complete
   all values if one or more non-zero time-values are
   present.
 - protagonists-to-ignore: A list of protagonists to ignore
   during render. The protagonist will be considered when
   selecting events, but events will not be rendered.
 - mix: Indicates whether a mix method should be called if
   it is defined for a given output-type. (default: t)
 - tidy-up: Indicates whether the temporary directory should
   be tidied up after render. All files created by
   in tmp-dir during render will be deleted. Other
   files in tmp-dir will not be deleted!
   (delete-temporary-files does this job.)

Return Value

 T

Synopsis

(defgeneric render (comic
                    &rest args
                    &key
                      print
                      auto-complete-time
                      call-space-superhero
                      output-dir
                      mix
                      tidy-up
                      protagonists-filter-proc
                    &allow-other-keys))

Example

(render #<COMIC ...> (make-protagonist :sound) :print t)