Struct Modulate 

#[non_exhaustive]
pub struct Modulate {
    pub brightness: f32,
    pub saturation: f32,
    pub hue: f32,
}

Brightness, saturation and hue adjustment (SPEC §Core ops).

Saturation and hue are defined in HSV, which is what modulate means everywhere else in this corner of the ecosystem. That is a deliberate compatibility choice rather than a claim that HSV is the right colour model: it is not perceptually uniform, and v2’s ICC work is where a principled version belongs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

brightness: f32

Multiplier on value/lightness. 1.0 leaves it unchanged.

saturation: f32

Multiplier on saturation. 1.0 leaves it unchanged, 0.0 is greyscale.

hue: f32

Rotation of hue in degrees.

Implementations

impl Modulate

pub fn identity() -> Modulate

A modulation that changes nothing.

pub fn with_brightness(self, factor: f32) -> Result<Modulate, PixelsError>

Scale brightness by factor.

Errors

Returns PixelsError::InvalidArgument if factor is negative or not finite — a NaN multiplier would propagate silently into every pixel.

pub fn with_saturation(self, factor: f32) -> Result<Modulate, PixelsError>

Scale saturation by factor.

Errors

As Modulate::with_brightness.

pub fn with_hue(self, degrees: f32) -> Result<Modulate, PixelsError>

Rotate hue by degrees.

Errors

Returns PixelsError::InvalidArgument if degrees is not finite.

pub fn is_identity(&self) -> bool

Whether this modulation is the identity, and can be skipped entirely.

Trait Implementations

impl Clone for Modulate

fn clone(&self) -> Modulate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Modulate

impl Debug for Modulate

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

Formats the value using the given formatter.

impl Default for Modulate

fn default() -> Modulate

Returns the “default value” for a type.

impl Op for Modulate

fn rescaled(&self) -> Option<Arc<dyn Op>>

Pointwise: every output pixel depends on the one input pixel beneath it, with no length or coordinate anywhere, so resolution is irrelevant to what this op means, and there is no bound state to discard.

fn name(&self) -> &'static str

A short, stable name for this op, used in diagnostics.

fn output_descriptor( &self, inputs: &[ImageDescriptor], ) -> Result<ImageDescriptor, PixelsError>

Compute the output shape from the input shapes.

fn input_regions( &self, output: Region, _inputs: &[ImageDescriptor], ) -> Result<Vec<Region>, PixelsError>

The input regions needed to produce output.

fn compute( &self, inputs: &[Tile<'_>], output: &mut TileMut<'_>, ) -> Result<(), PixelsError>

Fill output from inputs — the kernel entry point.

fn arity(&self) -> usize

The number of inputs this op consumes.

fn access_pattern(&self) -> AccessPattern

How this op reads its inputs; drives tile negotiation (ADR-0003).

impl PartialEq for Modulate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Modulate