nr_rect: Draw rectangles on a native raster image

In nara: Native Raster Image Tools

Draw rectangles on a native raster image

Description

Draw rectangles on a native raster image

Usage

nr_rect(
  nr,
  x,
  y,
  w,
  h,
  fill = "black",
  color = NA,
  hjust = 0,
  vjust = 0,
  linewidth = 1,
  use_alpha = TRUE
)

Arguments

nr	native raster image
x, y	coordinates of lower left corner of rectangle. [vector]
w, h	width and height of rectangle. [vector]
fill	interior fill color [vector]
color	outline color. Default: NA. [vector]
hjust, vjust	specify horizontal and vertical justification of the handle on the src image to be placed at (x, y) within the dst image. Default (0, 0) is to use the top-left corner of the image as the handle. Use (0.5, 0.5) to centre the src image at the dst location (x, y)
linewidth	Line linewidth. Default: 1. If linewidth = 1 then a naive version of Bresenham is used to draw the points. If linewidth is greater than 1, then the line is convert to a triangle strip and rendered as polygons.
use_alpha	Use alpha channel when drawing? Logical. Default: TRUE

Value

Invisibly return the supplied native raster image which was been modified in-place

See Also

Other drawing functions: nr_circle(), nr_polygon(), nr_polyline(), nr_tri_mesh()

Examples

set.seed(1)
w <- 200
h <- 150
nr <- nr_new(w, h, 'grey80')

N <- 10
coords <- expand.grid(x = seq(2, w, length.out = N), 
                      y = seq(2, h, length.out = N))

cols <- sample(grDevices::heat.colors(nrow(coords)))

nr_rect(
  nr,
  x = coords$x,
  y = coords$y,
  w = w/N - 1,
  h = h/N - 1,
  fill = cols
)
plot(nr)

nara documentation built on May 28, 2026, 5:07 p.m.