Struct UpscaleConfig 

#[non_exhaustive]
pub struct UpscaleConfig {
    pub mode: UpscaleMode,
    pub factor: u32,
}

Upscaling configuration exposed through crate::ChessConfig.

JSON shape: { "mode": "disabled" } or { "mode": "fixed", "factor": 2 }.

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.

mode: UpscaleMode

Selected upscale mode. Default: UpscaleMode::Disabled.

factor: u32

Integer factor used when mode == Fixed. Ignored otherwise. Must be 2, 3, or 4.

Implementations

impl UpscaleConfig

pub fn disabled() -> Self

Construct a disabled configuration (no upscaling).

pub fn fixed(factor: u32) -> Self

Construct a fixed-factor configuration. Does not validate.

pub fn effective_factor(&self) -> u32

Return the effective integer factor, or 1 when disabled.

pub fn validate(&self) -> Result<(), UpscaleError>

Validate that the configuration is well-formed.

Trait Implementations

impl Clone for UpscaleConfig

fn clone(&self) -> UpscaleConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpscaleConfig

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

Formats the value using the given formatter.

impl Default for UpscaleConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UpscaleConfig

where UpscaleConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UpscaleConfig

fn eq(&self, other: &UpscaleConfig) -> 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 UpscaleConfig

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 UpscaleConfig

impl Eq for UpscaleConfig

impl StructuralPartialEq for UpscaleConfig