Skip to content

Commit

Permalink
docs: remove old crate-level documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
  • Loading branch information
nxsaken committed Jun 10, 2024
1 parent 015e070 commit 64d2d37
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
//! Efficient scan conversion (rasterization) of line segments with clipping to a rectangular window.
//!
//! The key advantage of `clipline` over vanilla Bresenham is that it eliminates the need for
//! bounds checking on every pixel, which speeds up line drawing. Furthermore, the clipping uses
//! integer arithmetic, producing pixel-perfect endpoints. This sets it apart from floating-point
//! clipping algorithms like Cohen-Sutherland, which may distort the line due to rounding errors.
//!
//! ## Usage
//! This crate provides two ways of performing scan conversion: the [`clipline`] function, and the
//! [`Clipline`] iterator. The former is slightly more optimized, the latter allows external iteration.
//! Both methods can be toggled with the `func` and `iter` features (both enabled by default).
//! # Clipline
//!
//! Efficient rasterization of line segments with clipping.

#![no_std]
#![cfg_attr(feature = "try_fold", feature(try_trait_v2))]
Expand Down

0 comments on commit 64d2d37

Please sign in to comment.