SDL.Compositor

This module provides the means for declarative image generation using sdl2 primitives as a basis. Atomical operations for image composition are rotation, translation, mirroring, color modulation, changing blend modes and primitive drawing.

This packages aims to provide a basic interface via type classes. This means that you could write your own implementation but still use eventual utility functions provided by this package. The authors decided to split the functionality into several typeclasses to allow partial implementations while preserving type safety.

Interface

class Compositor c where

A Compositor is a thing that can overlap, rotate and mirror objects.

Minimal complete definition

overC, rotateC, flipC

Methods

overC :: c -> c -> c infixr 5

overC x y positions x over y. The meaning of this depends on the context. For Textures and drawings this means that x should be drawn after y was drawn.

rotateC :: Double -> c -> c

flipC :: V2 Bool -> c -> c

This function takes a 'V2 Bool' that represents mirroring action. The first component of the vector represents mirroring along the y-axis (horizontally) and the second component represents mirroring along the x-axis (vertically).

Instances

Compositor (CompositingNode a)

Methods

overC :: CompositingNode a -> CompositingNode a -> CompositingNode a

rotateC :: Double -> CompositingNode a -> CompositingNode a

flipC :: V2 Bool -> CompositingNode a -> CompositingNode a

Compositor (c a) => Compositor (ResIndependent c a)

Methods

overC :: ResIndependent c a -> ResIndependent c a -> ResIndependent c a

rotateC :: Double -> ResIndependent c a -> ResIndependent c a

flipC :: V2 Bool -> ResIndependent c a -> ResIndependent c a

class Blender b where

This class modells a graphics object that supports switching of BlendMode.

Minimal complete definition

blendMode

Methods

blendMode :: BlendMode -> b -> b

This method sets the BlendMode of an object. If the object has children, their BlendMode property will be preserved.

Instances

Blender (CompositingNode a)

Methods

blendMode :: BlendMode -> CompositingNode a -> CompositingNode a

Blender (c a) => Blender (ResIndependent c a)

Methods

blendMode :: BlendMode -> ResIndependent c a -> ResIndependent c a

class Manipulator m where

This class models a graphics object that supports color modulation.

Minimal complete definition

modulateAlphaM, modulateRedM, modulateGreenM, modulateBlueM

Methods

modulateAlphaM :: Int -> m -> m

Modulate the alpha channel of picture. This behavior stacks multiplicatively.

modulateRedM :: Int -> m -> m

Modulate the red channel of picture. This behavior stacks multiplicatively.

modulateGreenM :: Int -> m -> m

Modulate the green channel of picture. This behavior stacks multiplicatively.

modulateBlueM :: Int -> m -> m

Modulate the blue channel of picture. This behavior stacks multiplicatively.

Instances

Manipulator (CompositingNode a)

Methods

modulateAlphaM :: Int -> CompositingNode a -> CompositingNode a

modulateRedM :: Int -> CompositingNode a -> CompositingNode a

modulateGreenM :: Int -> CompositingNode a -> CompositingNode a

modulateBlueM :: Int -> CompositingNode a -> CompositingNode a

Manipulator (c a) => Manipulator (ResIndependent c a)

Methods

modulateAlphaM :: Int -> ResIndependent c a -> ResIndependent c a

modulateRedM :: Int -> ResIndependent c a -> ResIndependent c a

modulateGreenM :: Int -> ResIndependent c a -> ResIndependent c a

modulateBlueM :: Int -> ResIndependent c a -> ResIndependent c a

class Drawer d where

Minimal complete definition

rectangleC, lineC, filledRectangleC

Methods

rectangleC :: V2 Int -> Color -> d

lineC :: V2 Int -> Color -> d

filledRectangleC :: V2 Int -> Color -> d

Instances

Drawer (CompositingNode a)

Methods

rectangleC :: V2 Int -> Color -> CompositingNode a

lineC :: V2 Int -> Color -> CompositingNode a

filledRectangleC :: V2 Int -> Color -> CompositingNode a

class AbsoluteSize c where

Minimal complete definition

translateA, sizedA

Methods

translateA :: V2 Int -> c a -> c a

sizedA :: V2 Int -> a -> c a

Instances

AbsoluteSize CompositingNode

Methods

translateA :: V2 Int -> CompositingNode a -> CompositingNode a

sizedA :: V2 Int -> a -> CompositingNode a

class Texture tex where

Minimal complete definition

textureAlphaMod, textureColorMod, textureBlendMode, textureWidth, textureHeight, destroyTexture

Methods

textureAlphaMod :: tex -> StateVar Word8

textureColorMod :: tex -> StateVar (V3 Word8)

textureBlendMode :: tex -> StateVar BlendMode

textureWidth :: tex -> IO Int

textureHeight :: tex -> IO Int

textureDims :: tex -> IO (V2 Int)

destroyTexture :: tex -> IO ()

Instances

Texture Texture

Methods

textureAlphaMod :: Texture -> StateVar Word8

textureColorMod :: Texture -> StateVar (V3 Word8)

textureBlendMode :: Texture -> StateVar BlendMode

textureWidth :: Texture -> IO Int

textureHeight :: Texture -> IO Int

textureDims :: Texture -> IO (V2 Int)

destroyTexture :: Texture -> IO ()

Texture RawTexture

Methods

textureAlphaMod :: RawTexture -> StateVar Word8

textureColorMod :: RawTexture -> StateVar (V3 Word8)

textureBlendMode :: RawTexture -> StateVar BlendMode

textureWidth :: RawTexture -> IO Int

textureHeight :: RawTexture -> IO Int

textureDims :: RawTexture -> IO (V2 Int)

destroyTexture :: RawTexture -> IO ()

class Renderer rend where

Minimal complete definition

rendererDrawColor, clear, present, drawRect, fillRect, drawLine

Methods

rendererDrawColor :: rend -> StateVar (V4 Word8)

clear :: rend -> IO ()

present :: rend -> IO ()

drawRect :: rend -> Maybe (Rectangle Int) -> IO ()

fillRect :: rend -> Maybe (Rectangle Int) -> IO ()

drawLine :: rend -> Point V2 Int -> Point V2 Int -> IO ()

Instances

Renderer Renderer

Methods

rendererDrawColor :: Renderer -> StateVar (V4 Word8)

clear :: Renderer -> IO ()

present :: Renderer -> IO ()

drawRect :: Renderer -> Maybe (Rectangle Int) -> IO ()

fillRect :: Renderer -> Maybe (Rectangle Int) -> IO ()

drawLine :: Renderer -> Point V2 Int -> Point V2 Int -> IO ()

class Renderable rend tex where

This class modells that something can be rendered to another thing.

Minimal complete definition

copyEx, createTexture, rendererRenderTarget

Methods

copyEx :: rend -> tex -> Maybe (Rectangle Int) -> Maybe (Rectangle Int) -> Double -> Maybe (Point V2 Int) -> V2 Bool -> IO ()

createTexture :: rend -> PixelFormat -> TextureAccess -> V2 Int -> IO tex

rendererRenderTarget :: rend -> StateVar (Maybe tex)

Instances

Renderable Renderer Texture

Methods

copyEx :: Renderer -> Texture -> Maybe (Rectangle Int) -> Maybe (Rectangle Int) -> Double -> Maybe (Point V2 Int) -> V2 Bool -> IO ()

createTexture :: Renderer -> PixelFormat -> TextureAccess -> V2 Int -> IO Texture

rendererRenderTarget :: Renderer -> StateVar (Maybe Texture)

Renderable Renderer RawTexture

Methods

copyEx :: Renderer -> RawTexture -> Maybe (Rectangle Int) -> Maybe (Rectangle Int) -> Double -> Maybe (Point V2 Int) -> V2 Bool -> IO ()

createTexture :: Renderer -> PixelFormat -> TextureAccess -> V2 Int -> IO RawTexture

rendererRenderTarget :: Renderer -> StateVar (Maybe RawTexture)

Utility

withZIndex :: (Compositor c, Monoid c) => [(Int, c)] -> c

Arrange all given compositions in one composition.

This function takes a list of pairs where the first element of the pair is the z-index and the second element is the composition. Elements of with a higher z-index will be rendered "in front of" elements with lower indices. If elements have the same index then the element that comes first in the list will be drawn over all the later ones.

This method can only arrange compositions that are in the "the same list of arguments". That means that

withZIndex [(1,a),(2,b)] `overC` withZIndex [(3,c)]

will always result in b being rendered "in front of" a and c, no matter how large the z-index of c is.

Implementation

data CompositingNode a

A compositing node represents a compound graphical resource.

Instances

AbsoluteSize CompositingNode

Methods

translateA :: V2 Int -> CompositingNode a -> CompositingNode a

sizedA :: V2 Int -> a -> CompositingNode a

Eq a => Eq (CompositingNode a)

Methods

(==) :: CompositingNode a -> CompositingNode a -> Bool

(/=) :: CompositingNode a -> CompositingNode a -> Bool

Show a => Show (CompositingNode a)

Methods

showsPrec :: Int -> CompositingNode a -> ShowS

show :: CompositingNode a -> String

showList :: [CompositingNode a] -> ShowS

Monoid (CompositingNode a)

mempty represents no painting at all. Also

mappend a b == overC a b

Methods

mempty :: CompositingNode a

mappend :: CompositingNode a -> CompositingNode a -> CompositingNode a

mconcat :: [CompositingNode a] -> CompositingNode a

Manipulator (CompositingNode a)

Methods

modulateAlphaM :: Int -> CompositingNode a -> CompositingNode a

modulateRedM :: Int -> CompositingNode a -> CompositingNode a

modulateGreenM :: Int -> CompositingNode a -> CompositingNode a

modulateBlueM :: Int -> CompositingNode a -> CompositingNode a

Drawer (CompositingNode a)

Methods

rectangleC :: V2 Int -> Color -> CompositingNode a

lineC :: V2 Int -> Color -> CompositingNode a

filledRectangleC :: V2 Int -> Color -> CompositingNode a

Blender (CompositingNode a)

Methods

blendMode :: BlendMode -> CompositingNode a -> CompositingNode a

Compositor (CompositingNode a)

Methods

overC :: CompositingNode a -> CompositingNode a -> CompositingNode a

rotateC :: Double -> CompositingNode a -> CompositingNode a

flipC :: V2 Bool -> CompositingNode a -> CompositingNode a

runRenderer :: forall tex rend. (Texture tex, Renderer rend, Renderable rend tex) => rend -> CompositingNode tex -> IO ()

Render a composed image.

Colors

data Color

Represents the value of color.

rgba :: Word8 -> Word8 -> Word8 -> Word8 -> Color

construct a color value from red green blue and alpha values.