Monomer.Widgets.Singles.Image

Displays an image from local storage or a url.

image "https://picsum.photos/id/1059/800/600"

It is also possible to create images from a block of memory using imageMem.

Notes:

• Depending on the type of image fit chosen and the assigned viewport, some space may remain unused. The alignment options exist to handle this situation.
• If you choose fitNone, adding imageRepeatX and imageRepeatY won't have any kind of effect.

Configuration

data ImageCfg e

Configuration options for image:

• transparency: the alpha to apply when rendering the image.
• onLoadError: an event to report a load error.
• imageNearest: apply nearest filtering when stretching an image.
• imageRepeatX: repeat the image across the x coordinate.
• imageRepeatY: repeat the image across the y coordinate.
• fitNone: does not perform any stretching if the size does not match viewport.
• fitFill: stretches the image to match the viewport.
• fitWidth: stretches the image to match the viewport width. Maintains ratio.
• fitHeight: stretches the image to match the viewport height. Maintains ratio.
• fitEither: stretches the image to match either the viewport width or height such that image does not overflow viewport. Maintains ratio.
• alignLeft: aligns to the left if extra space is available.
• alignRight: aligns to the right if extra space is available.
• alignCenter: aligns to the horizontal center if extra space is available.
• alignTop: aligns to the top if extra space is available.
• alignMiddle: aligns to the vertical middle if extra space is available.
• alignBottom: aligns to the bottom if extra space is available.

Instances

Monoid (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

mempty :: ImageCfg e

mappend :: ImageCfg e -> ImageCfg e -> ImageCfg e

mconcat :: [ImageCfg e] -> ImageCfg e

Semigroup (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

(<>) :: ImageCfg e -> ImageCfg e -> ImageCfg e

sconcat :: NonEmpty (ImageCfg e) -> ImageCfg e

stimes :: Integral b => b -> ImageCfg e -> ImageCfg e

Default (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

def :: ImageCfg e

CmbAlignBottom (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

alignBottom :: ImageCfg e

alignBottom_ :: Bool -> ImageCfg e

CmbAlignCenter (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

alignCenter :: ImageCfg e

alignCenter_ :: Bool -> ImageCfg e

CmbAlignLeft (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

alignLeft :: ImageCfg e

alignLeft_ :: Bool -> ImageCfg e

CmbAlignMiddle (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

alignMiddle :: ImageCfg e

alignMiddle_ :: Bool -> ImageCfg e

CmbAlignRight (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

alignRight :: ImageCfg e

alignRight_ :: Bool -> ImageCfg e

CmbAlignTop (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

alignTop :: ImageCfg e

alignTop_ :: Bool -> ImageCfg e

CmbFitEither (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

fitEither :: ImageCfg e

CmbFitFill (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

fitFill :: ImageCfg e

CmbFitHeight (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

fitHeight :: ImageCfg e

CmbFitNone (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

fitNone :: ImageCfg e

CmbFitWidth (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

fitWidth :: ImageCfg e

CmbImageNearest (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

imageNearest :: ImageCfg e

CmbImageRepeatX (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

imageRepeatX :: ImageCfg e

CmbImageRepeatY (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

imageRepeatY :: ImageCfg e

CmbResizeFactor (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

resizeFactor :: Double -> ImageCfg e

CmbResizeFactorDim (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

resizeFactorW :: Double -> ImageCfg e

resizeFactorH :: Double -> ImageCfg e

CmbTransparency (ImageCfg e)

Defined in Monomer.Widgets.Singles.Image

Methods

transparency :: Double -> ImageCfg e

CmbOnLoadError (ImageCfg e) e ImageLoadError

Defined in Monomer.Widgets.Singles.Image

Methods

onLoadError :: (ImageLoadError -> e) -> ImageCfg e

data ImageLoadError

Possible errors when loading an image.

Constructors

ImageLoadFailed String

ImageInvalid String

Instances

Show ImageLoadError

Defined in Monomer.Widgets.Singles.Image

Methods

showsPrec :: Int -> ImageLoadError -> ShowS

show :: ImageLoadError -> String

showList :: [ImageLoadError] -> ShowS

Eq ImageLoadError

Defined in Monomer.Widgets.Singles.Image

Methods

(==) :: ImageLoadError -> ImageLoadError -> Bool

(/=) :: ImageLoadError -> ImageLoadError -> Bool

CmbOnLoadError (ImageCfg e) e ImageLoadError

Defined in Monomer.Widgets.Singles.Image

Methods

onLoadError :: (ImageLoadError -> e) -> ImageCfg e

Constructors

image

Arguments

:: WidgetEvent e

=> Text

The local path or url.

-> WidgetNode s e

The created image widget.

Creates an image with the given local path or url.

image_

Arguments

:: WidgetEvent e

=> Text

The local path or url.

-> [ImageCfg e]

The configuration of the image.

-> WidgetNode s e

The created image widget.

Creates an image with the given local path or url. Accepts config.

imageMem

Arguments

:: WidgetEvent e

=> Text

The logical name of the image.

-> ByteString

The image data as 4-byte RGBA blocks.

-> Size

The size of the image.

-> WidgetNode s e

The created image widget.

Creates an image with the given binary data.

imageMem_

Arguments

:: WidgetEvent e

=> Text

The logical name of the image.

-> ByteString

The image data as 4-byte RGBA blocks.

-> Size

The size of the image.

-> [ImageCfg e]

The configuration of the image.

-> WidgetNode s e

The created image widget.

Creates an image with the given binary data. Accepts config.