Struct autopilot::bitmap::Bitmap

pub struct Bitmap {
    pub image: DynamicImage,
    pub size: Size,
    pub scale: f64,
}

Fields

image: DynamicImage

size: Size

Size of the bitmap in points.

scale: f64

Methods

impl Bitmap

pub fn new(image: DynamicImage, scale: Option<f64>) -> Bitmap

Creates a bitmap from the given DynamicImage, and scale if given (defaults to 1).

pub fn bounds(&self) -> Rect

Returns bounds of bitmap as a rect, with an origin of zero.

pub fn copy_to_pasteboard(&self) -> ImageResult<()>

Copies image to pasteboard. Currently only supported on macOS.

pub fn cropped(&mut self, rect: Rect) -> ImageResult<Bitmap>

Returns new Bitmap created from a portion of another.

pub fn get_pixel(&self, point: Point) -> Rgba<u8>

pub fn bitmap_eq(&self, needle: &Bitmap, tolerance: Option<f64>) -> bool

Returns true if bitmap is equal to needle with the given tolerance.

pub fn find_color(
    &self,
    needle: Rgba<u8>,
    tolerance: Option<f64>,
    rect: Option<Rect>,
    start_point: Option<Point>
) -> Option<Point>

Attempts to find color inside rect in bmp from the given start_point. Returns coordinates if found, or None if not. If rect is None, bmp.bounds() is used instead. If start_point is None, the origin of rect is used.

Tolerance is defined as a float in the range from 0 to 1, where 0 is an exact match and 1 matches anything.

pub fn find_every_color(
    &self,
    needle: Rgba<u8>,
    tolerance: Option<f64>,
    rect: Option<Rect>,
    start_point: Option<Point>
) -> Vec<Point>

Returns list of all coordinates inside rect in bmp matching color from the given start_point. If rect is None, bmp.bounds() is used instead. If start_point is None, the origin of rect is used.

pub fn count_of_color(
    &self,
    needle: Rgba<u8>,
    tolerance: Option<f64>,
    rect: Option<Rect>,
    start_point: Option<Point>
) -> u64

Returns count of color in bitmap. Functionally equivalent to:

find_every_color(color, tolerance, rect, start_point).count()

pub fn find_bitmap(
    &self,
    needle: &Bitmap,
    tolerance: Option<f64>,
    rect: Option<Rect>,
    start_point: Option<Point>
) -> Option<Point>

Attempts to find needle inside rect in bmp from the given start_point. Returns coordinates if found, or None if not. If rect is None, bmp.bounds() is used instead. If start_point is None, the origin of rect is used.

Tolerance is defined as a float in the range from 0 to 1, where 0 is an exact match and 1 matches anything.

pub fn find_every_bitmap(
    &self,
    needle: &Bitmap,
    tolerance: Option<f64>,
    rect: Option<Rect>,
    start_point: Option<Point>
) -> Vec<Point>

Returns list of all coordinates inside rect in bmp matching needle from the given start_point. If rect is None, bmp.bounds is used instead. If start_point is None, the origin of rect is used.

pub fn count_of_bitmap(
    &self,
    needle: &Bitmap,
    tolerance: Option<f64>,
    rect: Option<Rect>,
    start_point: Option<Point>
) -> u64

Returns count of occurrences of needle in bmp. Functionally equivalent to:

find_every_bitmap(color, tolerance, rect, start_point).count()

Trait Implementations

impl Clone for Bitmap

fn clone(&self) -> Bitmap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitmap

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

Formats the value using the given formatter.

impl PartialEq for Bitmap

fn eq(&self, other: &Bitmap) -> 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 !=.

impl Hash for Bitmap

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].