Magnifier

Package

Plugins Main

Category

Accessibility

Originally separated into Magnifier and Fisheye and combined only a few hours later

The Magnifier plugin zooms in a portion of the screen around the mouse cursor.

Using the Magnifier

The Magnifier creates a small window of customizable size that shows a zoomed image of the area around the mouse cursor. Magnifier can also put this image inside of an overlaid image, such as one of a magnifying glass, or use a fisheye distortion effect to create the zoom. Available from Git.

A demonstration of this plugin is available on YouTube.

The magnifier can be shown or hidden at any time using key and mouse bindings. Zooming out all the way automatically hides the magnifier.

By default, the key and mouse bindings are:

  • <Super>m - Zoom to pre-defined multiplier (default is 2x) and back

  • <Shift><Super>Button4 - Zoom in

  • <Shift><Super>Button5 - Zoom out

The Mouse position polling plugin must be available for this plugin to work.

Configuration

This section contains an explanation of every option and binding available to this plugin, presented in the same order as they appear in CCSM.

Bindings

Initiate

A keyboard shortcut that shows the magnifier with the default zoom factor. When the magnifier is already shown, this shortcut hides it.

Zoom In

A mouse shortcut that increases the current zoom of the magnifier, and shows it when it isn't already shown.

Zoom Out

A mouse shortcut that decreases the current zoom of the magnifier, and hides it when zoomed all the way out.

General

Mode

Choose whether the magnifier should be displayed as a simple rectangle, an image, or a fisheye lens effect.

Zoom

How far to zoom in when the magnifier is activated with the Initiate keyboard shortcut.

Speed

(FIXME: Doesn't seem to have any effect.)

Timestep

How quickly to animate the zoom.

Fisheye

Radius

The radius (size) of the fisheye lens.

Image Overlay

Magnifier image

The picture to use for the magnifier's border.

Clip mask

An image with a transparent region representing the outline of the magnifier's lens.

X offset cursor

The distance between the mouse cursor and the top edge of the magnifier image. Adjust this to make the lens look centred around the mouse.

Y offset cursor

The distance between the mouse cursor and the left edge of the magnifier image. Adjust this to make the lens look centred around the mouse.

Simple

Keep fully on screen

Don't allow the edge of the magnifier rectangle to extend past the edge of the screen.

Width

The width of the magnified region.

Height

The height of the magnified region.

Border width

The thickness of the rectangular border surrounding the magnified region.

Border color

The colour of the rectangular border surrounding the magnified region.

Standards Compliant

This magnifier is fully compliant with the screen magnifier specification