svg-renderer 1.0.2

A high-performance SVG-to-raster renderer powered by Skia, with CPU and optional Vulkan GPU backends
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! `svg-renderer` — a high-performance SVG-to-raster renderer powered by [Skia](https://skia.org).
//!
//! # Backends
//!
//! | Backend  | Feature          | Description                                  |
//! |----------|------------------|----------------------------------------------|
//! | CPU      | (always)         | Renders via Skia's raster backend.           |
//! | Vulkan   | `vulkan-backend` | GPU-accelerated via Skia's Vulkan backend.   |
//!
//! # Pipeline mode
//!
//! [`SvgPipelineRenderer`] spawns dedicated worker threads for parallel
//! rendering, suitable for throughput-oriented workloads.
//!
//! # Quick start
//!
//! ```no_run
//! use svg_renderer::{SvgRenderer, RenderOptions};
//!
//! let svg_data = b"<svg xmlns='http://www.w3.org/2000/svg'></svg>";
//! let opts = RenderOptions::new(800, 600).unwrap();
//! let mut renderer = SvgRenderer::new().unwrap();
//! let image = renderer.render_svg(svg_data, &opts).unwrap();
//! println!("{}x{} RGBA image", image.width, image.height);
//! ```

mod error;
mod image;
mod options;
mod pipeline;
mod renderer;
mod resource;
#[cfg(feature = "vulkan-backend")]
mod vulkan;

pub(crate) use resource::CachedResourceProvider;
#[cfg(feature = "vulkan-backend")]
pub(crate) use vulkan::VulkanState;

pub use error::SvgRenderError;
pub use image::ImageData;

/// JPEG alpha handling behavior.
pub use options::JpegAlphaOption;
/// JPEG chroma subsampling mode.
pub use options::JpegDownsample;
/// JPEG encoding options.
pub use options::JpegOptions;
/// Render options: size, clear color, MSAA sample count.
pub use options::RenderOptions;
/// Render size configuration.
pub use options::RenderSize;
/// WebP compression mode (lossy / lossless).
pub use options::WebpCompression;
/// WebP encoding options.
pub use options::WebpOptions;

#[cfg(feature = "vulkan-backend")]
pub use pipeline::VulkanSvgPipelineRenderer;
pub use pipeline::{CpuSvgPipelineRenderer, SvgPipelineRenderer};
#[cfg(feature = "vulkan-backend")]
pub use renderer::VulkanSvgRenderer;
pub use renderer::{
    CpuSvgRenderer, RenderBackend, SvgRenderer, render_svg, render_svg_to_jpeg, render_svg_to_png,
    render_svg_to_webp,
};