image-renderer 0.1.0

Image renderer
Documentation

Image Renderer

License: MIT Rust

一个功能完整的 Rust 图像处理库，参考 Skia API 风格设计，提供简洁易用的 2D 图形绘制能力。

✨ 主要特性

  • 🎨 丰富的绘图功能

    • 基本图形：矩形、圆形、椭圆、线条
    • 圆角矩形、自定义边框
    • 虚线样式支持（短虚线、长虚线、点状、点划线等）

  • 📝 文本渲染

    • 支持系统字体和自定义字体
    • 可调节字体大小、颜色
    • 支持加粗、斜体样式

  • 🖼️ 图像处理

    • 图片加载与保存（PNG、JPEG）
    • 九宫格（Nine-Patch）图片绘制
    • 图像变换和渲染

  • 🎯 高性能

    • Release 模式下启用 LTO 优化
    • 零成本抽象设计
    • 高效的内存管理

📦 安装

在 Cargo.toml 中添加依赖：

[dependencies]
image-renderer = "0.1.0"

🚀 快速开始

基础绘制示例

use image_renderer::{Canvas, Color, Paint, Point, Rect, Font, TextStyle};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建 800x600 的画布，白色背景
    let mut canvas = Canvas::new_with_color(800, 600, Color::WHITE)?;
    
    // 绘制填充矩形
    let rect = Rect::new(100, 100, 200, 150);
    let paint = Paint::fill(Color::BLUE);
    canvas.draw_rect(rect, &paint);
    
    // 绘制描边圆形
    let center = Point::new(400, 300);
    let paint_stroke = Paint::stroke(Color::RED, 3.0);
    canvas.draw_circle(center, 80.0, &paint_stroke);
    
    // 绘制文本
    let font = Font::default_system_font()?;
    let text_style = TextStyle::new(font, 24.0);
    let mut paint_text = Paint::new();
    paint_text.set_color(Color::BLACK);
    canvas.draw_text("Hello, World!", Point::new(100, 50), &text_style, &paint_text);
    
    // 保存图片
    canvas.save("output.png")?;
    
    Ok(())
}

虚线绘制

use image_renderer::{Canvas, Color, Paint, Point, DashStyle};

let mut canvas = Canvas::new_with_color(800, 600, Color::WHITE)?;

// 创建虚线画笔
let mut paint = Paint::stroke(Color::BLUE, 2.0);
paint.set_dash_style(DashStyle::ShortDash);

// 绘制虚线
canvas.draw_dashed_line(Point::new(50, 100), Point::new(750, 100), &paint);

canvas.save("dashed_line.png")?;

九宫格图片绘制

use image_renderer::{Canvas, Color, Rect, Surface};

// 加载源图片
let source_image = Surface::from_file("button.png")?;

// 创建画布
let mut canvas = Canvas::new_with_color(800, 600, Color::WHITE)?;

// 定义九宫格的中心区域（保留边缘 20 像素）
let center = Rect::new(20, 20, 60, 60);

// 绘制到目标区域（会自动拉伸）
let dst = Rect::new(50, 50, 300, 150);
canvas.draw_image_nine(&source_image, center, dst)?;

canvas.save("nine_patch_output.png")?;

自定义边框

use image_renderer::{Canvas, Color, Paint, Rect, Border, BorderSide, BorderRadius};

let mut canvas = Canvas::new_with_color(800, 600, Color::WHITE)?;

// 创建自定义边框
let border = Border {
    top: BorderSide::new(Color::RED, 5.0),
    right: BorderSide::new(Color::GREEN, 3.0),
    bottom: BorderSide::new(Color::BLUE, 5.0),
    left: BorderSide::new(Color::YELLOW, 3.0),
};

let radius = BorderRadius {
    top_left: 20.0,
    top_right: 10.0,
    bottom_right: 20.0,
    bottom_left: 10.0,
};

let rect = Rect::new(100, 100, 300, 200);
let paint = Paint::fill(Color::WHITE);

canvas.draw_rect_with_border(rect, &paint, &border, &radius);
canvas.save("custom_border.png")?;

📚 核心 API

Canvas（画布）

// 创建画布
let canvas = Canvas::new(800, 600)?;
let canvas = Canvas::new_with_color(800, 600, Color::WHITE)?;

// 清空画布
canvas.clear(Color::WHITE);

// 保存图片
canvas.save("output.png")?;
canvas.save_with_format("output.jpg", ImageFormat::Jpeg)?;

Paint（画笔）

// 创建填充画笔
let paint = Paint::fill(Color::BLUE);

// 创建描边画笔
let paint = Paint::stroke(Color::RED, 3.0);

// 设置虚线样式
paint.set_dash_style(DashStyle::ShortDash);

Color（颜色）

// 预定义颜色
Color::RED
Color::GREEN
Color::BLUE
Color::WHITE
Color::BLACK

// RGB 创建
Color::rgb(255, 0, 0)

// RGBA 创建
Color::rgba(255, 0, 0, 128)

// 十六进制创建
Color::from_hex("#FF0000")?
Color::from_hex("#FF0000FF")?

绘图方法

// 绘制矩形
canvas.draw_rect(rect, &paint);
canvas.draw_rounded_rect(rect, radius, &paint);

// 绘制圆形和椭圆
canvas.draw_circle(center, radius, &paint);
canvas.draw_oval(rect, &paint);

// 绘制线条
canvas.draw_line(start, end, &paint);
canvas.draw_dashed_line(start, end, &paint);

// 绘制文本
canvas.draw_text(text, position, &text_style, &paint);

// 绘制图片
canvas.draw_image(&surface, dst_rect)?;
canvas.draw_image_nine(&surface, center, dst_rect)?;

🎨 虚线样式

支持多种虚线样式：

  • DashStyle::Solid - 实线
  • DashStyle::ShortDash - 短虚线
  • DashStyle::LongDash - 长虚线
  • DashStyle::Dot - 点状
  • DashStyle::DashDot - 点划线
  • DashStyle::DashDotDot - 双点划线
  • DashStyle::Custom(Vec<f32>) - 自定义模式

🔧 运行示例

项目包含完整的示例程序，展示了所有主要功能：

# 运行示例
cargo run

# 运行测试
cargo test

# 构建 Release 版本
cargo build --release

运行后会生成以下示例图片：

  • output_basic.png - 基础绘制示例
  • output_nine_patch.png - 九宫格绘制示例
  • output_dashed_lines.png - 虚线样式示例
  • output_custom_borders.png - 自定义边框示例

📖 文档

查看完整的 API 文档：

cargo doc --open

🛠️ 技术栈

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📄 许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件

👤 作者

Jerry jerry@jerry.moe

🔗 相关链接