Graphics.Ueberzug

Documentation

data Ueberzug

The main struct storing a handle to the ueberzug process

newUeberzug :: Ueberzug

Create a new Ueberzug instance with an empty process handle

draw :: Ueberzug -> UbConf -> IO (Either String Ueberzug)

Draw an image using the ub instance with config config

clear :: Ueberzug -> String -> IO (Either String Ueberzug)

Clear an image with identifier identifier_. The ub instance should be the same one that draw returned, when drawing that image.

data Actions

The available actions on the ueberzug image

Constructors

Add

Remove

data Scalers

The available scalers to scale the image

Constructors

Crop

Distort

FitContain

Contain

ForcedCover

Cover

Instances

Show Scalers

Defined in Graphics.Ueberzug

Methods

showsPrec :: Int -> Scalers -> ShowS

show :: Scalers -> String

showList :: [Scalers] -> ShowS

data UbConf

The ueberzug configuration record. Contains all the data needed to draw the image

Constructors

UbConf

Fields

• action :: Actions
• identifier :: String
• x :: Int
• y :: Int
• path :: FilePath
• width :: Maybe Int
• height :: Maybe Int
• scaler :: Maybe Scalers
• should_draw :: Maybe Bool
• synchronously_draw :: Maybe Bool
• scaling_position_x :: Maybe Float
• scaling_position_y :: Maybe Float

defaultUbConf :: UbConf

Default config with approx. "mempty" values for convenience