Struct Color 

pub struct Color(/* private fields */);

A color stored in BGR format, matching the HWP binary specification.

Internally a u32 with repr(transparent) for zero overhead.

FROZEN: Do not change the internal representation after v1.0.

Layout

Bits: [31..24 reserved] [23..16 blue] [15..8 green] [7..0 red]

Examples

use hwpforge_foundation::Color;

let c = Color::from_rgb(0x11, 0x22, 0x33);
assert_eq!(c.to_raw(), 0x00332211);
assert_eq!(c.to_string(), "#112233");

Implementations

impl Color

pub const BLACK: Self

Black: RGB(0, 0, 0).

pub const WHITE: Self

White: RGB(255, 255, 255).

pub const RED: Self

Pure red: RGB(255, 0, 0).

pub const GREEN: Self

Pure green: RGB(0, 255, 0).

pub const BLUE: Self

Pure blue: RGB(0, 0, 255).

pub const fn from_rgb(r: u8, g: u8, b: u8) -> Self

Constructs a Color from RGB components.

The components are stored in BGR order internally. Reserved bits (24-31) are set to zero.

Examples

use hwpforge_foundation::Color;

let magenta = Color::from_rgb(255, 0, 255);
assert_eq!(magenta.red(), 255);
assert_eq!(magenta.blue(), 255);

pub const fn to_rgb(self) -> (u8, u8, u8)

Extracts the RGB components as a tuple (r, g, b).

pub const fn from_raw(bgr: u32) -> Self

Constructs a Color from a raw BGR u32.

Use this when reading values directly from HWP binary data. All 32 bits are preserved (including reserved bits 24-31).

Examples

use hwpforge_foundation::Color;

let c = Color::from_raw(0x00FF0000);
assert_eq!(c.blue(), 255);
assert_eq!(c.red(), 0);

pub const fn to_raw(self) -> u32

Returns the raw BGR u32 value.

pub const fn red(self) -> u8

Returns the red component (bits 0-7).

pub const fn green(self) -> u8

Returns the green component (bits 8-15).

pub const fn blue(self) -> u8

Returns the blue component (bits 16-23).

pub fn to_hex_rgb(&self) -> String

Converts this color to an RGB hex string in #RRGGBB format.

Since HWP uses BGR byte order internally, this method swaps the bytes to produce standard RGB hex output.

Examples

use hwpforge_foundation::Color;
let red = Color::from_rgb(255, 0, 0);
assert_eq!(red.to_hex_rgb(), "#FF0000");

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Color

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Color

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Color

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Color

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Color

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Color

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for Color

fn eq(&self, other: &Color) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Color

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Color

impl Eq for Color

impl StructuralPartialEq for Color