Graphics.Aosd

For a higher-level API for textual OSDs using Pango, use Graphics.Aosd.Pango.

Renderers

class AosdRenderer a where

Methods

toGeneralRenderer :: a -> IO GeneralRenderer

Instances

AosdRenderer GeneralRenderer

AosdRenderer TextRenderer

data GeneralRenderer

Constructors

GeneralRenderer

Fields

grRender :: Render ()

grInkExtent :: Rectangle

Part of the surface that the renderer actually draws on (determines the window size).

grPositioningExtent :: Rectangle

Part of the surface whose...

• ... left edge is aligned to the left edge of the screen, if xPos is Min
• ... center is aligned to the center of the screen, if xPos is Center
• ... right edge is aligned to the right edge of the screen, if xPos is Max

(Likewise for the y axis)

Instances

AosdRenderer GeneralRenderer

Options

data AosdOptions

Constructors

AosdOptions

Fields

classHint :: Maybe XClassHint

Nothing = use libaosd default.

transparency :: Maybe Transparency

Nothing = use libaosd default.

xPos :: Position

yPos :: Position

offset :: (CInt, CInt)

Positive values denote a rightwards respectively downwards offset (in pixels).

hideUponMouseEvent :: Maybe Bool

Nothing = use libaosd default.

mouseEventCB :: Maybe (C'AosdMouseEvent -> IO ())

Mouse-click event handler.

data Transparency

Constructors

None

Fake

Composite

Instances

Show Transparency

data Position

Constructors

Min

Left/top

Center

Max

Right/bottom

Instances

Bounded Position

Enum Position

Show Position

data XClassHint

Constructors

XClassHint

Fields

resName :: String

resClass :: String

Instances

Show XClassHint

defaultOpts :: AosdOptions

Non-Nothing defaults:

• transparency = Just Composite,
• xPos = Center,
• yPos = Center,
• offset = (0,0),
• hideUponMouseEvent = Just True

Displaying

aosdFlash :: AosdRenderer a => AosdOptions -> a -> FlashDurations -> IO ()

Main high-level displayer. Blocks.

data FlashDurations

Constructors

FlashDurations

Fields

inMillis :: CUInt

Fade-in time in milliseconds

fullMillis :: CUInt

Full display time in milliseconds

outMillis :: CUInt

Fade-out time in milliseconds

Instances

Show FlashDurations

symDurations

Arguments

:: CUInt

inMillis and outMillis.

-> CUInt

fullMillis.

-> FlashDurations

Construct a FlashDurations with equal inMillis and outMillis.

Low-level operations

newtype AosdPtr

Constructors

AosdPtr

Fields

unAosdPtr :: ForeignPtr C'Aosd

aosdNew :: AosdRenderer a => AosdOptions -> a -> IO AosdPtr

Create an Aosd object managed by the garbage collector.

reconfigure :: AosdRenderer a => AosdOptions -> a -> AosdPtr -> IO ()

aosdRender :: AosdPtr -> IO ()

aosdShow :: AosdPtr -> IO ()

aosdHide :: AosdPtr -> IO ()

aosdLoopOnce :: AosdPtr -> IO ()

aosdLoopFor

Arguments

:: AosdPtr

-> CUInt

Time in milliseconds.

-> IO ()

Reexports

module Graphics.Rendering.Cairo

data Rectangle

Rectangle

• Specifies x, y, width and height

Constructors

Rectangle Int Int Int Int

Instances

Eq Rectangle

Show Rectangle

data CInt

Haskell type representing the C int type.

Instances

Bounded CInt

Enum CInt

Eq CInt

Integral CInt

Num CInt

Ord CInt

Read CInt

Real CInt

Show CInt

Typeable CInt

Storable CInt

Bits CInt

data CUInt

Haskell type representing the C unsigned int type.

Instances

Bounded CUInt

Enum CUInt

Eq CUInt

Integral CUInt

Num CUInt

Ord CUInt

Read CUInt

Real CUInt

Show CUInt

Typeable CUInt

Storable CUInt

Bits CUInt