ox_content_og_image 2.3.0

OG image generation for Ox Content
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

//! Configuration for OG image generation.

use serde::{Deserialize, Serialize};

/// Configuration for OG image generation.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OgImageConfig {
    /// Image width in pixels.
    pub width: u32,
    /// Image height in pixels.
    pub height: u32,
    /// Background color (hex).
    pub background_color: String,
    /// Text color (hex).
    pub text_color: String,
    /// Title font size.
    pub title_font_size: u32,
    /// Description font size.
    pub description_font_size: u32,
    /// Font family name.
    pub font_family: Option<String>,
    /// Logo path.
    pub logo_path: Option<String>,
    /// Output format.
    pub format: ImageFormat,
}

impl Default for OgImageConfig {
    fn default() -> Self {
        Self {
            width: 1200,
            height: 630,
            background_color: "#0b1220".to_string(),
            text_color: "#eff6ff".to_string(),
            title_font_size: 70,
            description_font_size: 28,
            font_family: None,
            logo_path: None,
            format: ImageFormat::Png,
        }
    }
}

/// Image output format.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum ImageFormat {
    /// PNG format.
    #[default]
    Png,
    /// JPEG format.
    Jpeg,
    /// WebP format.
    WebP,
}