Struct kle_serial::Key

pub struct Key<T = f64>
where
    T: Real,
{

    pub legends: [Option<Legend>; 12],
    pub color: Color,
    pub x: T,
    pub y: T,
    pub width: T,
    pub height: T,
    pub x2: T,
    pub y2: T,
    pub width2: T,
    pub height2: T,
    pub rotation: T,
    pub rx: T,
    pub ry: T,
    pub profile: String,
    pub switch: Switch,
    pub ghosted: bool,
    pub stepped: bool,
    pub homing: bool,
    pub decal: bool,
}

A struct representing a single key.

Fields

legends: [Option<Legend>; 12]

The key’s legends. This array is indexed in left to right, top to bottom order as shown in the image below.

Legends that are empty in KLE will be deserialised as None.

color: Color

The colour of the key

x: T

The X position of the key in keyboard units (19.05 mm or 0.75 in).

Note: KLE has some strange behaviour when it comes to stepped and L-shaped keys. The ‘true’ X position will be less if the key’s x2 field is negative. This behaviour can be observed by placing an ISO enter in KLE; x is 0.25 and x2 is −0.25.

y: T

The Y position of the key in keyboard units (19.05 mm or 0.75 in).

Note: KLE has some strange behaviour when it comes to stepped and L-shaped keys. The ‘true’ Y position will be less if the key’s y2 field is negative. This behaviour can be observed by placing an ISO enter in KLE; x is 0.25 and x2 is −0.25.

width: T

The width of the key in keyboard units (19.05 mm or 0.75 in).

height: T

The height of the key in keyboard units (19.05 mm or 0.75 in).

x2: T

The relative X position of a stepped or L-shaped part of the key.

This is set to 0.0 for regular keys, but is used for stepped caps lock and ISO enter keys, amongst others.

y2: T

The relative Y position of a stepped or L-shaped part of the key.

This is set to 0.0 for regular keys, but is used for stepped caps lock and ISO enter keys, amongst others.

width2: T

The width of a stepped or L-shaped part of the key.

This is equal to the width for regular keys, but is used for stepped caps lock and ISO enter keys, amongst others.

height2: T

The height of a stepped or L-shaped part of the key.

This is equal to the height for regular keys, but is used for stepped caps lock and ISO enter keys, amongst others.

rotation: T

The rotation of the key in degrees.

rx: T

The X coordinate for the centre of rotation of the key.

ry: T

The Y coordinate for the centre of rotation of the key.

profile: String

The keycap profile of the key.

switch: Switch

The key switch.

ghosted: bool

Whether the key is ghosted.

stepped: bool

Whether the key is stepped.

homing: bool

Whether this is a homing key.

decal: bool

Whether this is a decal.

Trait Implementations

impl<T> Clone for Key<T>

where T: Real + Clone,

fn clone(&self) -> Key<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Key<T>

where T: Real + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Key<T>

where T: Real,

fn default() -> Self

Returns the “default value” for a type.