Struct extendr_api::graphics::Device

pub struct Device { /* private fields */ }

Implementations

impl Device

pub fn current() -> Result<Device>

Get the current device.

pub fn mode_on(&self) -> Result<()>

Enable device rendering.

pub fn mode_off(&self) -> Result<()>

Disable device rendering and flush.

pub fn device_number(&self) -> i32

Get the device number for this device.

pub fn get_device(number: i32) -> Result<Device>

Get a device by number.

pub fn from_device_coords(&self, value: (f64, f64), from: Unit) -> (f64, f64)

Convert device coordinates into a specified unit. This is usually done by the API.

pub fn to_device_coords(&self, value: (f64, f64), to: Unit) -> (f64, f64)

Convert a specified unit coordinates into device coordinates. This is usually done by the API.

pub fn from_device_wh(&self, value: (f64, f64), from: Unit) -> (f64, f64)

Convert device width/height coordinates into a specified unit. This is usually done by the API.

pub fn to_device_wh(&self, value: (f64, f64), to: Unit) -> (f64, f64)

Convert a specified unit width/height coordinates into device coordinates. This is usually done by the API.

pub fn new_page(&self, gc: &Context)

Start a new page. The page color can be set in advance.

pub fn clip(&self, from: (f64, f64), to: (f64, f64), gc: &Context)

Change the clip rectangle.

pub fn line(&self, from: (f64, f64), to: (f64, f64), gc: &Context)

Draw a stroked line. gc.color() is the stroke color.

pub fn polyline<T: IntoIterator<Item = (f64, f64)>>( &self, coords: T, gc: &Context )

Draw a stroked/filled polyline. gc.color() is the stroke color. The input is anything yielding (x,y) coordinate pairs. Polylines are not closed.

pub fn polygon<T: IntoIterator<Item = (f64, f64)>>( &self, coords: T, gc: &Context )

Draw a stroked/filled polygon. gc.color() is the stroke color. The input is anything yielding (x,y) coordinate pairs. Polygons are closed.

pub fn circle(&self, center: (f64, f64), radius: f64, gc: &Context)

Draw a stroked/filled circle. gc.color() is the stroke color. gc.fill() is the fill color.

pub fn rect(&self, from: (f64, f64), to: (f64, f64), gc: &Context)

Draw a stroked/filled axis-aligned rectangle. gc.color() is the stroke color. gc.fill() is the fill color.

pub fn path<T: IntoIterator<Item = impl IntoIterator<Item = (f64, f64)>>>( &self, coords: T, winding: bool, gc: &Context )

Draw a path with multiple segments. gc.color() is the stroke color. gc.fill() is the fill color. The input is an interator of iterators yielding (x,y) pairs.

pub fn capture(&self) -> Robj

Screen capture. Returns an integer matrix representing pixels if it is able.

pub fn raster<T: AsRef<[u32]>>( &self, raster: Raster<T>, pos: (f64, f64), size: (f64, f64), angle: f64, interpolate: bool, gc: &Context )

Draw a bitmap.

pub fn text<T: AsRef<str>>( &self, pos: (f64, f64), text: T, center: (f64, f64), rot: f64, gc: &Context )

Draw a text string starting at pos. TODO: do we need to convert units?

pub fn symbol(&self, pos: (f64, f64), symbol: i32, size: f64, gc: &Context)

Draw a special symbol centered on pos. See https://stat.ethz.ch/R-manual/R-devel/library/graphics/html/points.html

pub fn char_metric(&self, c: char, gc: &Context) -> TextMetric

Get the metrics for a single unicode codepoint.

pub fn text_width<T: AsRef<str>>(&self, text: T, gc: &Context) -> f64

Get the width of a unicode string.

pub fn text_height<T: AsRef<str>>(&self, text: T, gc: &Context) -> f64

Get the height of a unicode string.

pub fn text_metric<T: AsRef<str>>(&self, text: T, gc: &Context) -> TextMetric

Get the metrics for a unicode string.

pub fn math_text_width(&self, expr: &Robj, gc: &Context) -> f64

Get the width of a mathematical expression.

pub fn math_text_height(&self, expr: &Robj, gc: &Context) -> f64

Get the height of a mathematical expression.

pub fn math_text_metric(&self, expr: &Robj, gc: &Context) -> TextMetric

Get the metrics for a mathematical expression.

pub fn math_text( &self, expr: &Robj, pos: (f64, f64), center: (f64, f64), rot: f64, gc: &Context )

Draw a mathematical expression.

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Device

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Device

fn eq(&self, other: &Device) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Device