Graphics.XOSD

Tested with: GHC 6.10, GHC 7.6

Bindings to xosd, the X on-screen display library xosd is a library for displaying an on-screen display (like the one on many TVs) on your X display.

 runXOSD [ Timeout 3
          , VAlign VAlignMiddle
          , HAlign HAlignCenter
          , Font "-adobe-helvetica-bold-r-*-*-34-*-*-*-*-*-*-*"
          , Color "LimeGreen"
          , Display (String "TEST")] 
      (const $ return ())

The abstract XOSD type

type XOSD = Ptr XOSD_

An abstract X on-screen display object

An xosd window can be used to display textual or numerical data on a X11 display in a unmanaged, shaped window that appears to be transparent. It provides a similar effect to the on-screen display of many televisions and video recorders

data Attribute

Attributes that can be set on an XOSD object

Constructors

Lines !Int

BarLength !Int

VAlign !VAlign

HAlign !HAlign

VOffset !Int

HOffset !Int

ShadowOffset !Int

OutlineOffset !Int

OutlineColor String

ShadowColor String

Color String

Font String

Timeout !Int

Hidden

Visible

Scroll !Int

Display !Format

Instances

Eq Attribute

Show Attribute

data Format

The type of possible display formats

Constructors

Percent !Int

Slider !Int

String String

Instances

Eq Format

Read Format

Show Format

data VAlign

Valid screen positions (vertical alignment)

Constructors

VAlignTop

VAlignMiddle

VAlignBottom

Instances

Eq VAlign

Ord VAlign

Read VAlign

Show VAlign

data HAlign

Valid screen positions (vertical alignment)

Constructors

HAlignLeft

HAlignCenter

HAlignRight

Instances

Eq HAlign

Ord HAlign

Read HAlign

Show HAlign

Interface to the interpreter

runXOSD :: [Attribute] -> (XOSD -> IO ()) -> IO ()

Run some code with an X on-screen display attached.

Introduction and elimination

initialize :: [Attribute] -> IO XOSD

Create a new XOSD object with given attributes.

destroy :: XOSD -> IO ()

xosd_uninit destroys an existing xosd window, freeing the memory. This is an unsafe function: as destroying an xosd object twice will likely cause bad things to happen, so don't do that.

Operations on a running XOSD

set :: XOSD -> [Attribute] -> IO ()

Set a list of attributes

display :: XOSD -> Int -> Format -> IO ()

Display some content.

wait :: XOSD -> IO ()

Wait until nothing is displayed. Blocks the process until no longer visible.

scroll :: XOSD -> Int -> IO ()

Scroll the display