R/coder.R

In jeroenooms/magick: Advanced Graphics and Image-Processing in R

#' Magick Configuration
#'
#' ImageMagick can be configured to support various additional tool and formats
#' via external libraries. These functions show which features ImageMagick supports
#' on your system.
#'
#' Note that \code{coder_info} raises an error for unsupported formats.
#'
#' @export
#' @rdname config
#' @param format image format such as \code{png}, \code{tiff} or \code{pdf}.
#' @references \url{https://www.imagemagick.org/Magick++/CoderInfo.html}
#' @examples coder_info("png")
#' coder_info("jpg")
#' coder_info("pdf")
#' coder_info("tiff")
#' coder_info("gif")
coder_info <- function(format){
  magick_coder_info(format)
}

#' @rdname config
#' @export
magick_config <- function(){
  out <- magick_config_internal()
  out$version = numeric_version(out$version)
  out$threads = magick_threads()
  out
}

#' @rdname config
#' @export
#' @param seed integer with seed value to use
#' @examples # Reproduce random image
#' magick_set_seed(123)
#' image_blank(200,200, pseudo_image = "plasma:fractal")
magick_set_seed <- function(seed){
  stopifnot(length(seed) == 1)
  seed <- as.integer(seed)
  set_magick_seed(seed)
}