Skip to content

visual_accessibility.md

Latest commit

 

History

History
98 lines (74 loc) · 4.02 KB

visual_accessibility.md

File metadata and controls

98 lines (74 loc) · 4.02 KB
Raw

Visual Accessibility Module

Page Map

Header Link
Purpose Purpose
Use Cases Use Cases
Context Context
Filter Modes Filter Modes
Practical Example Practical Example
API Reference API Reference
enable_colorblind_filter enable_colorblind_filter
disable_colorblind_filter disable_colorblind_filter

Purpose

A global colorblind filter runs a full-screen color-correction pass so players with color vision deficiencies can tell gameplay colors apart. It is a whole-frame control on ctx.res, driven by an accessibility menu, with a mode for the deficiency type and a strength for how strong the correction is. Wire it to a settings toggle so the choice persists across the session.

Use Cases

  • Accessibility options menu: apply the player's chosen mode and strength with enable_colorblind_filter!(ctx.res, mode, strength) when the setting changes.
  • Protanopia / deuteranopia / tritanopia correction: pass ColorBlindFilter::Protan, Deuteran, or Tritan to shift confusable red/green/blue hues apart.
  • Achromatopsia support: pass ColorBlindFilter::Achroma for total color blindness.
  • Strength slider: pass a 0.0..=1.0 strength so players tune the effect to their vision.
  • Turning the filter off: disable_colorblind_filter!(ctx.res) when the player selects "None".

Ownership And Choice

Accessibility settings own a player preference that affects presentation globally. Use this module for supported display transforms such as color-vision filters. Do not encode gameplay meaning only by color or treat a filter as a substitute for accessible art and UI. Keep the selected preference in settings data and apply it from one presentation owner.

Context

  • Script context path: ctx.res
  • Module access: ctx.res (calls live directly on the resource window)
  • Backing type: perro_structs::ColorBlindFilter
  • Lifecycle examples stay inside lifecycle! because script hooks get API from the macro expansion.

Filter Modes

ColorBlindFilter selects which deficiency the correction pass targets:

Mode Targets
ColorBlindFilter::Protan Protanopia (red-weak)
ColorBlindFilter::Deuteran Deuteranopia (green-weak)
ColorBlindFilter::Tritan Tritanopia (blue-weak)
ColorBlindFilter::Achroma Achromatopsia (total color blindness)

strength is a f32 from 0.0 (no correction) to 1.0 (full correction).

Practical Example

Apply the filter when an options menu commits a new accessibility choice.

lifecycle!({
    fn on_all_init(&self, ctx: &mut ScriptContext<'_, API>) {
        signal_connect!(ctx.run, ctx.id, signal!("accessibility_changed"), func!("apply_filter"));
    }
});

methods!({
    // pub because signal dispatch only reaches pub fn methods.
    pub fn apply_filter(&self, ctx: &mut ScriptContext<'_, API>) {
        // Values would come from the settings the player picked.
        enable_colorblind_filter!(ctx.res, ColorBlindFilter::Deuteran, 0.8);
    }

    pub fn clear_filter(&self, ctx: &mut ScriptContext<'_, API>) {
        disable_colorblind_filter!(ctx.res);
    }
});

API Reference

enable_colorblind_filter

Field Detail
Access ctx.res
Signature enable_colorblind_filter!(ctx.res, mode, strength)
Params ctx.res, mode: ColorBlindFilter, strength: f32
Returns ()
Use when Enabling or retuning the global colorblind correction pass.
Fails when / edge behavior Replaces any active filter; strength outside 0.0..=1.0 is clamped by the render pass.

disable_colorblind_filter

Field Detail
Access ctx.res
Signature disable_colorblind_filter!(ctx.res)
Params ctx.res
Returns ()
Use when Turning the filter off, for example when the player selects "None".
Fails when / edge behavior No-op when no filter is active.