sar-core 0.1.1

A Rust library for parsing and rendering SymbolArt (SAR) files from Phantasy Star Online 2.
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

use std::fmt::Debug;

use super::symbol::Symbol;

/// Represents a position in 2D space
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Position {
    /// X coordinate
    pub x: u8,
    /// Y coordinate
    pub y: u8,
}

/// Represents a complete SymbolArt composition
///
/// A SymbolArt is a user-created artwork composed of multiple layers of symbols.
/// Each layer contains a symbol positioned and colored according to the layer's properties.
pub trait SymbolArt: Send + Sync {
    type Layer: SymbolArtLayer + Send + Sync;
    fn author_id(&self) -> u32;
    fn height(&self) -> u8;
    fn width(&self) -> u8;
    fn layers(&self) -> Vec<Self::Layer>;
    fn name(&self) -> String;
}

/// Represents a single layer in a SymbolArt composition
///
/// A SymbolArt is composed of multiple layers stacked on top of each other,
/// where each layer contains a symbol positioned and colored according to the
/// layer's properties. The order of layers determines their visual stacking
/// order in the final composition.
pub trait SymbolArtLayer {
    fn top_left(&self) -> Position;
    fn bottom_left(&self) -> Position;
    fn top_right(&self) -> Position;
    fn bottom_right(&self) -> Position;
    fn symbol(&self) -> Symbol;
    fn color(&self) -> Color;
    fn is_hidden(&self) -> bool;
}

/// Represents a color in RGBA format
///
/// Each component (red, green, blue, alpha) is represented as an 8-bit unsigned integer,
/// allowing for values between 0 and 255. The alpha channel controls transparency,
/// where 0 is fully transparent and 255 is fully opaque.
#[derive(Debug, Clone, Copy)]
pub struct Color {
    pub a: u8,
    pub r: u8,
    pub g: u8,
    pub b: u8,
}

impl Color {
    pub fn new(a: u8, r: u8, g: u8, b: u8) -> Self {
        Self { a, r, g, b }
    }
}

impl From<Color> for image::Rgba<u8> {
    fn from(value: Color) -> Self {
        image::Rgba([value.r, value.g, value.b, value.a])
    }
}