print.bm_bitmap {bittermelon}

Print bitmap objects

Description

print.bm_bitmap() prints a representation of bitmap objects to the terminal. It is a wrapper around format.bm_bitmap() which converts bitmap objects to a character vector. px_unicode and px_ascii are builtin character vectors intended for use with the px argument (the former contains Unicode “Block Elements” while the latter is purely ASCII).

Usage

## S3 method for class 'bm_bitmap'
print(x, ..., px = getOption("bittermelon.px", px_unicode),
                                 fg = getOption("bittermelon.fg", FALSE),
                                 bg = getOption("bittermelon.bg", FALSE),
                                 compress = getOption("bittermelon.compress", "none"))

## S3 method for class 'bm_bitmap'
format(x, ..., px = getOption("bittermelon.px", px_unicode),
                                 fg = getOption("bittermelon.fg", FALSE),
                                 bg = getOption("bittermelon.bg", FALSE),
                                 compress = getOption("bittermelon.compress", "none"))

px_unicode

px_ascii

Arguments

x

A bm_bitmap() object

...

Further arguments passed to or from other methods.

px

Character vector of the pixel to use for each integer value i.e. The first character for integer 0L, the second character for integer 1L, and so on. Will be recycled.

fg

R color strings of foreground colors to use. Requires suggested package crayon. FALSE (default) for no foreground colors. Will be recycled.

bg

R color strings of background colors to use. Requires suggested package crayon. FALSE (default) for no background colors. Will be recycled.

compress

If none (default) don't compress first with bm_compress(). Otherwise compress first with bm_compress() passing the value of compress as its direction argument (i.e. either "vertical" or "v", "horizontal" or "h", OR "both" or "b").

Format

An object of class character of length 20.

An object of class character of length 20.

Value

A character vector of the string representation (print.bm_bitmap() does this invisibly). As a side effect print.bm_bitmap() prints out the string representation to the terminal.

See Also

bm_bitmap()

Examples

  font_file <- system.file("fonts/spleen/spleen-8x16.hex.gz", package = "bittermelon")
  font <- read_hex(font_file)
  bm_R <- font[[str2ucp("R")]]
  print(bm_R, px = c(" ", "#"))

  bm_8 <- font[[str2ucp("8")]]
  bm_8_with_border <- bm_extend(bm_extend(bm_8, left = 1L),
                                sides = 1L, value = 2L)
  print(bm_8_with_border, px = c(".", "@", "X"))

  if (require("crayon") && crayon::has_color()) {
    print(bm_8_with_border, px = " ", bg = c("white", "blue", "red"))
  }