Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gsk.Functions

Contents

Methods

Description

Synopsis

blendNodeGetBlendMode :: (HasCallStack, MonadIO m) => RenderNode -> m BlendMode
blendNodeGetBottomChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
blendNodeGetTopChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
blendNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> RenderNode -> BlendMode -> m RenderNode
blurNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
blurNodeGetRadius :: (HasCallStack, MonadIO m) => RenderNode -> m Double
blurNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> Double -> m RenderNode
borderNodeNew :: (HasCallStack, MonadIO m) => RoundedRect -> [Float] -> [RGBA] -> m RenderNode
borderNodePeekColors :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA
borderNodePeekOutline :: (HasCallStack, MonadIO m) => RenderNode -> m RoundedRect
borderNodePeekWidths :: (HasCallStack, MonadIO m) => RenderNode -> m Float
cairoNodeGetDrawContext :: (HasCallStack, MonadIO m) => RenderNode -> m Context
cairoNodeNew :: (HasCallStack, MonadIO m) => Rect -> m RenderNode
cairoNodePeekSurface :: (HasCallStack, MonadIO m) => RenderNode -> m Surface
clipNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
clipNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> Rect -> m RenderNode
clipNodePeekClip :: (HasCallStack, MonadIO m) => RenderNode -> m Rect
colorMatrixNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
colorMatrixNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> Matrix -> Vec4 -> m RenderNode
colorMatrixNodePeekColorMatrix :: (HasCallStack, MonadIO m) => RenderNode -> m Matrix
colorMatrixNodePeekColorOffset :: (HasCallStack, MonadIO m) => RenderNode -> m Vec4
colorNodeNew :: (HasCallStack, MonadIO m) => RGBA -> Rect -> m RenderNode
colorNodePeekColor :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA
containerNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> Word32 -> m RenderNode
containerNodeGetNChildren :: (HasCallStack, MonadIO m) => RenderNode -> m Word32
containerNodeNew :: (HasCallStack, MonadIO m) => [RenderNode] -> m RenderNode
crossFadeNodeGetEndChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
crossFadeNodeGetProgress :: (HasCallStack, MonadIO m) => RenderNode -> m Double
crossFadeNodeGetStartChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
crossFadeNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> RenderNode -> Double -> m RenderNode
debugNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
debugNodeGetMessage :: (HasCallStack, MonadIO m) => RenderNode -> m Text
debugNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> Text -> m RenderNode
insetShadowNodeGetBlurRadius :: (HasCallStack, MonadIO m) => RenderNode -> m Float
insetShadowNodeGetDx :: (HasCallStack, MonadIO m) => RenderNode -> m Float
insetShadowNodeGetDy :: (HasCallStack, MonadIO m) => RenderNode -> m Float
insetShadowNodeGetSpread :: (HasCallStack, MonadIO m) => RenderNode -> m Float
insetShadowNodeNew :: (HasCallStack, MonadIO m) => RoundedRect -> RGBA -> Float -> Float -> Float -> Float -> m RenderNode
insetShadowNodePeekColor :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA
insetShadowNodePeekOutline :: (HasCallStack, MonadIO m) => RenderNode -> m RoundedRect
linearGradientNodeGetNColorStops :: (HasCallStack, MonadIO m) => RenderNode -> m Word64
linearGradientNodeNew :: (HasCallStack, MonadIO m) => Rect -> Point -> Point -> [ColorStop] -> m RenderNode
linearGradientNodePeekColorStops :: (HasCallStack, MonadIO m) => RenderNode -> m ColorStop
linearGradientNodePeekEnd :: (HasCallStack, MonadIO m) => RenderNode -> m Point
linearGradientNodePeekStart :: (HasCallStack, MonadIO m) => RenderNode -> m Point
opacityNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
opacityNodeGetOpacity :: (HasCallStack, MonadIO m) => RenderNode -> m Double
opacityNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> Double -> m RenderNode
outsetShadowNodeGetBlurRadius :: (HasCallStack, MonadIO m) => RenderNode -> m Float
outsetShadowNodeGetDx :: (HasCallStack, MonadIO m) => RenderNode -> m Float
outsetShadowNodeGetDy :: (HasCallStack, MonadIO m) => RenderNode -> m Float
outsetShadowNodeGetSpread :: (HasCallStack, MonadIO m) => RenderNode -> m Float
outsetShadowNodeNew :: (HasCallStack, MonadIO m) => RoundedRect -> RGBA -> Float -> Float -> Float -> Float -> m RenderNode
outsetShadowNodePeekColor :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA
outsetShadowNodePeekOutline :: (HasCallStack, MonadIO m) => RenderNode -> m RoundedRect
repeatNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
repeatNodeNew :: (HasCallStack, MonadIO m) => Rect -> RenderNode -> Maybe Rect -> m RenderNode
repeatNodePeekChildBounds :: (HasCallStack, MonadIO m) => RenderNode -> m Rect
repeatingLinearGradientNodeNew :: (HasCallStack, MonadIO m) => Rect -> Point -> Point -> [ColorStop] -> m RenderNode
roundedClipNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode
roundedClipNodeNew :: (HasCallStack, MonadIO m) => RenderNode -> RoundedRect -> m RenderNode
roundedClipNodePeekClip :: (HasCallStack, MonadIO m) => RenderNode -> m RoundedRect
textNodeGetNumGlyphs :: (HasCallStack, MonadIO m) => RenderNode -> m Word32
textNodeGetX :: (HasCallStack, MonadIO m) => RenderNode -> m Float
textNodeGetY :: (HasCallStack, MonadIO m) => RenderNode -> m Float
textNodeNew :: (HasCallStack, MonadIO m, IsFont a) => a -> GlyphString -> RGBA -> Float -> Float -> m (Maybe RenderNode)
textNodePeekColor :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA
textNodePeekFont :: (HasCallStack, MonadIO m) => RenderNode -> m Font
textNodePeekGlyphs :: (HasCallStack, MonadIO m) => RenderNode -> m GlyphInfo
textureNodeGetTexture :: (HasCallStack, MonadIO m) => RenderNode -> m Texture
textureNodeNew :: (HasCallStack, MonadIO m, IsTexture a) => a -> Rect -> m RenderNode

Methods

blendNodeGetBlendMode

blendNodeGetBlendMode :: (HasCallStack, MonadIO m) => RenderNode -> m BlendMode Source #

No description available in the introspection data.

blendNodeGetBottomChild

blendNodeGetBottomChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode Source #

No description available in the introspection data.

blendNodeGetTopChild

blendNodeGetTopChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode Source #

No description available in the introspection data.

blendNodeNew

blendNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`bottom`: The bottom node to be drawn
-> RenderNode	`top`: The node to be blended onto the `bottom` node
-> BlendMode	`blendMode`: The blend mode to use
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will use blendMode to blend the top node onto the bottom node.

blurNodeGetChild

blurNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode Source #

No description available in the introspection data.

blurNodeGetRadius

blurNodeGetRadius :: (HasCallStack, MonadIO m) => RenderNode -> m Double Source #

No description available in the introspection data.

blurNodeNew

blurNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`child`: the child node to blur
-> Double	`radius`: the blur radius
-> m RenderNode

Creates a render node that blurs the child.

borderNodeNew

borderNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RoundedRect	`outline`: a `RoundedRect` describing the outline of the border
-> [Float]	`borderWidth`: the stroke width of the border on the top, right, bottom and left side respectively.
-> [RGBA]	`borderColor`: the color used on the top, right, bottom and left side.
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will stroke a border rectangle inside the given outline. The 4 sides of the border can have different widths and colors.

borderNodePeekColors

borderNodePeekColors :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA Source #

No description available in the introspection data.

borderNodePeekOutline

borderNodePeekOutline :: (HasCallStack, MonadIO m) => RenderNode -> m RoundedRect Source #

No description available in the introspection data.

borderNodePeekWidths

borderNodePeekWidths :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

cairoNodeGetDrawContext

cairoNodeGetDrawContext Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a cairo `RenderNode`
-> m Context	Returns: a Cairo context used for drawing; use `cairo_destroy()` when done drawing

Creates a Cairo context for drawing using the surface associated to the render node. If no surface exists yet, a surface will be created optimized for rendering to renderer.

cairoNodeNew

cairoNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Rect	`bounds`: the rectangle to render to
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will render a cairo surface into the area given by bounds. You can draw to the cairo surface using cairoNodeGetDrawContext

cairoNodePeekSurface

cairoNodePeekSurface :: (HasCallStack, MonadIO m) => RenderNode -> m Surface Source #

No description available in the introspection data.

clipNodeGetChild

clipNodeGetChild Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a clip `gskRenderNode`
-> m RenderNode	Returns: The child that is getting clipped

Gets the child node that is getting clipped by the given node.

clipNodeNew

clipNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`child`: The node to draw
-> Rect	`clip`: The clip to apply
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will clip the child to the area given by clip.

clipNodePeekClip

clipNodePeekClip :: (HasCallStack, MonadIO m) => RenderNode -> m Rect Source #

No description available in the introspection data.

colorMatrixNodeGetChild

colorMatrixNodeGetChild Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a color matrix `gskRenderNode`
-> m RenderNode	Returns: The child that is getting its colors modified

Gets the child node that is getting its colors modified by the given node.

colorMatrixNodeNew

colorMatrixNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`child`: The node to draw
-> Matrix	`colorMatrix`: The matrix to apply
-> Vec4	`colorOffset`: Values to add to the color
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will drawn the child with reduced colorMatrix.

In particular, the node will transform the operation pixel = color_matrix * pixel + color_offset for every pixel.

colorMatrixNodePeekColorMatrix

colorMatrixNodePeekColorMatrix :: (HasCallStack, MonadIO m) => RenderNode -> m Matrix Source #

No description available in the introspection data.

colorMatrixNodePeekColorOffset

colorMatrixNodePeekColorOffset :: (HasCallStack, MonadIO m) => RenderNode -> m Vec4 Source #

No description available in the introspection data.

colorNodeNew

colorNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RGBA	`rgba`: a `RGBA` specifying a color
-> Rect	`bounds`: the rectangle to render the color into
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will render the color specified by rgba into the area given by bounds.

colorNodePeekColor

colorNodePeekColor :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA Source #

No description available in the introspection data.

containerNodeGetChild

containerNodeGetChild Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a container `RenderNode`
-> Word32	`idx`: the position of the child to get
-> m RenderNode	Returns: the `idx`'th child of `container`

Gets one of the children of container.

containerNodeGetNChildren

containerNodeGetNChildren Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a container `RenderNode`
-> m Word32	Returns: the number of children of the `RenderNode`

Retrieves the number of direct children of node.

containerNodeNew

containerNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> [RenderNode]	`children`: The children of the node
-> m RenderNode	Returns: the new `RenderNode`

Creates a new RenderNode instance for holding the given children. The new node will acquire a reference to each of the children.

crossFadeNodeGetEndChild

crossFadeNodeGetEndChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode Source #

No description available in the introspection data.

crossFadeNodeGetProgress

crossFadeNodeGetProgress :: (HasCallStack, MonadIO m) => RenderNode -> m Double Source #

No description available in the introspection data.

crossFadeNodeGetStartChild

crossFadeNodeGetStartChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode Source #

No description available in the introspection data.

crossFadeNodeNew

crossFadeNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`start`: The start node to be drawn
-> RenderNode	`end`: The node to be cross_fadeed onto the `start` node
-> Double	`progress`: How far the fade has progressed from start to end. The value will be clamped to the range [0 ... 1]
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will do a cross-fade between start and end.

debugNodeGetChild

debugNodeGetChild Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a debug `gskRenderNode`
-> m RenderNode	Returns: The child that is getting debug

Gets the child node that is getting debug by the given node.

debugNodeGetMessage

debugNodeGetMessage Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a debug `RenderNode`
-> m Text	Returns: The debug message

Gets the debug message that was set on this node

debugNodeNew

debugNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`child`: The child to add debug info for
-> Text	`message`: The debug message
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will add debug information about the given child.

Adding this node has no visual effect.

insetShadowNodeGetBlurRadius

insetShadowNodeGetBlurRadius :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

insetShadowNodeGetDx

insetShadowNodeGetDx :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

insetShadowNodeGetDy

insetShadowNodeGetDy :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

insetShadowNodeGetSpread

insetShadowNodeGetSpread :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

insetShadowNodeNew

insetShadowNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RoundedRect	`outline`: outline of the region containing the shadow
-> RGBA	`color`: color of the shadow
-> Float	`dx`: horizontal offset of shadow
-> Float	`dy`: vertical offset of shadow
-> Float	`spread`: how far the shadow spreads towards the inside
-> Float	`blurRadius`: how much blur to apply to the shadow
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will render an inset shadow into the box given by outline.

insetShadowNodePeekColor

insetShadowNodePeekColor :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA Source #

No description available in the introspection data.

insetShadowNodePeekOutline

insetShadowNodePeekOutline :: (HasCallStack, MonadIO m) => RenderNode -> m RoundedRect Source #

No description available in the introspection data.

linearGradientNodeGetNColorStops

linearGradientNodeGetNColorStops :: (HasCallStack, MonadIO m) => RenderNode -> m Word64 Source #

No description available in the introspection data.

linearGradientNodeNew

linearGradientNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Rect	`bounds`: the rectangle to render the linear gradient into
-> Point	`start`: the point at which the linear gradient will begin
-> Point	`end`: the point at which the linear gradient will finish
-> [ColorStop]	`colorStops`: a pointer to an array of `ColorStop` defining the gradient
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will create a linear gradient from the given points and color stops, and render that into the area given by bounds.

linearGradientNodePeekColorStops

linearGradientNodePeekColorStops :: (HasCallStack, MonadIO m) => RenderNode -> m ColorStop Source #

No description available in the introspection data.

linearGradientNodePeekEnd

linearGradientNodePeekEnd :: (HasCallStack, MonadIO m) => RenderNode -> m Point Source #

No description available in the introspection data.

linearGradientNodePeekStart

linearGradientNodePeekStart :: (HasCallStack, MonadIO m) => RenderNode -> m Point Source #

No description available in the introspection data.

opacityNodeGetChild

opacityNodeGetChild Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a opacity `gskRenderNode`
-> m RenderNode	Returns: The child that is getting opacityed

Gets the child node that is getting opacityed by the given node.

opacityNodeGetOpacity

opacityNodeGetOpacity :: (HasCallStack, MonadIO m) => RenderNode -> m Double Source #

No description available in the introspection data.

opacityNodeNew

opacityNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`child`: The node to draw
-> Double	`opacity`: The opacity to apply
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will drawn the child with reduced opacity.

outsetShadowNodeGetBlurRadius

outsetShadowNodeGetBlurRadius :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

outsetShadowNodeGetDx

outsetShadowNodeGetDx :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

outsetShadowNodeGetDy

outsetShadowNodeGetDy :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

outsetShadowNodeGetSpread

outsetShadowNodeGetSpread :: (HasCallStack, MonadIO m) => RenderNode -> m Float Source #

No description available in the introspection data.

outsetShadowNodeNew

outsetShadowNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RoundedRect	`outline`: outline of the region surrounded by shadow
-> RGBA	`color`: color of the shadow
-> Float	`dx`: horizontal offset of shadow
-> Float	`dy`: vertical offset of shadow
-> Float	`spread`: how far the shadow spreads towards the inside
-> Float	`blurRadius`: how much blur to apply to the shadow
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will render an outset shadow around the box given by outline.

outsetShadowNodePeekColor

outsetShadowNodePeekColor :: (HasCallStack, MonadIO m) => RenderNode -> m RGBA Source #

No description available in the introspection data.

outsetShadowNodePeekOutline

outsetShadowNodePeekOutline :: (HasCallStack, MonadIO m) => RenderNode -> m RoundedRect Source #

No description available in the introspection data.

repeatNodeGetChild

repeatNodeGetChild :: (HasCallStack, MonadIO m) => RenderNode -> m RenderNode Source #

No description available in the introspection data.

repeatNodeNew

repeatNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Rect	`bounds`: The bounds of the area to be painted
-> RenderNode	`child`: The child to repeat
-> Maybe Rect	`childBounds`: The area of the child to repeat or `Nothing` to use the child's bounds
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will repeat the drawing of child across the given bounds.

repeatNodePeekChildBounds

repeatNodePeekChildBounds :: (HasCallStack, MonadIO m) => RenderNode -> m Rect Source #

No description available in the introspection data.

repeatingLinearGradientNodeNew

repeatingLinearGradientNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Rect	`bounds`: the rectangle to render the linear gradient into
-> Point	`start`: the point at which the linear gradient will begin
-> Point	`end`: the point at which the linear gradient will finish
-> [ColorStop]	`colorStops`: a pointer to an array of `ColorStop` defining the gradient
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will create a repeating linear gradient from the given points and color stops, and render that into the area given by bounds.

roundedClipNodeGetChild

roundedClipNodeGetChild Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a clip `gskRenderNode`
-> m RenderNode	Returns: The child that is getting clipped

Gets the child node that is getting clipped by the given node.

roundedClipNodeNew

roundedClipNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RenderNode	`child`: The node to draw
-> RoundedRect	`clip`: The clip to apply
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will clip the child to the area given by clip.

:: (HasCallStack, MonadIO m, IsFont a)
=> a	`font`: the `Font` containing the glyphs
-> GlyphString	`glyphs`: the `GlyphString` to render
-> RGBA	`color`: the foreground color to render with
-> Float	`x`: the x coordinate at which to put the baseline
-> Float	`y`: the y coordinate at wihch to put the baseline
-> m (Maybe RenderNode)	Returns: a new text node, or `Nothing`

Creates a render node that renders the given glyphs, Note that color may not be used if the font contains color glyphs.

:: (HasCallStack, MonadIO m)
=> RenderNode	`node`: a `RenderNode`
-> m Texture	Returns: the `Texture`

No description available in the introspection data.

textureNodeNew

textureNodeNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsTexture a)
=> a	`texture`: the `Texture`
-> Rect	`bounds`: the rectangle to render the texture into
-> m RenderNode	Returns: A new `RenderNode`

Creates a RenderNode that will render the given texture into the area given by bounds.