ZennDev1337/Rust-for-Arduboy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update docs

Browse source
This commit is contained in:
ZennDev1337 2023-08-15 15:30:11 +02:00
parent 10236c7441
commit c4f43a0f9d
9 changed files with 39 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

7
arduboy-rust/src/lib.rs
View file

@ -8,6 +8,13 @@
//! ```
//! use arduboy_rust::prelude::*;
//! ```
//! Inside the Wrapper-Project folder is a folder named src.
//! You can disable C++ libraries in the main.h file.
//! Just comment the unused library definition out.
//!
//! To get an idea, the ArduboyTones Library needs 2-3% of the flash memory.
//!
//! [Here is the link to the GitHub Repo](https://github.com/zenndev1337/rust-for-arduboy)
extern crate panic_halt;
pub mod hardware;

4
arduboy-rust/src/library/arduboy2.rs
View file

@ -445,7 +445,7 @@ impl Arduboy2 {
///Returns
/// true if the specified point is within the specified rectangle.
///
///This function is intended to detemine if an object, whose boundaries are are defined by the given rectangle, is in contact with the given point.
///This function is intended to detemine if an object, whose boundaries are defined by the given rectangle, is in contact with the given point.
pub fn collide_point(&self, point: Point, rect: Rect) -> bool {
point.x >= rect.x
&& point.x < rect.x + rect.width as i16
@ -460,7 +460,7 @@ impl Arduboy2 {
///Returns
/// true if the first rectangle is intersecting the second.
///
///This function is intended to detemine if an object, whose boundaries are are defined by the given rectangle, is in contact with another rectangular object.
///This function is intended to detemine if an object, whose boundaries are defined by the given rectangle, is in contact with another rectangular object.
pub fn collide_rect(&self, rect1: Rect, rect2: Rect) -> bool {
!(rect2.x >= rect1.x + rect1.width as i16
|| rect2.x + rect2.width as i16 <= rect1.x