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.Objects.Renderer

Contents

Exported types
Methods
Properties
- realized
- surface

Description

No description available in the introspection data.

Synopsis

newtype Renderer = Renderer (ManagedPtr Renderer)
class (GObject o, IsDescendantOf Renderer o) => IsRenderer o
toRenderer :: (MonadIO m, IsRenderer o) => o -> m Renderer
noRenderer :: Maybe Renderer
rendererGetSurface :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m (Maybe Surface)
rendererIsRealized :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m Bool
rendererNewForSurface :: (HasCallStack, MonadIO m, IsSurface a) => a -> m (Maybe Renderer)
rendererRealize :: (HasCallStack, MonadIO m, IsRenderer a, IsSurface b) => a -> b -> m ()
rendererRender :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderNode -> Maybe Region -> m ()
rendererRenderTexture :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderNode -> Maybe Rect -> m Texture
rendererUnrealize :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m ()
getRendererRealized :: (MonadIO m, IsRenderer o) => o -> m Bool
getRendererSurface :: (MonadIO m, IsRenderer o) => o -> m (Maybe Surface)

Exported types

newtype Renderer Source #

Memory-managed wrapper type.

Constructors

Renderer (ManagedPtr Renderer)

Instances

Instances details

Eq Renderer Source #
Instance details Defined in GI.Gsk.Objects.Renderer Methods (==) :: Renderer -> Renderer -> Bool # (/=) :: Renderer -> Renderer -> Bool #
GObject Renderer Source #
Instance details Defined in GI.Gsk.Objects.Renderer Methods gobjectType :: IO GType #
IsGValue Renderer Source #	Convert `Renderer` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gsk.Objects.Renderer Methods toGValue :: Renderer -> IO GValue # fromGValue :: GValue -> IO Renderer #
HasParentTypes Renderer Source #
Instance details Defined in GI.Gsk.Objects.Renderer
type ParentTypes Renderer Source #
Instance details Defined in GI.Gsk.Objects.Renderer type ParentTypes Renderer = '[Object]

class (GObject o, IsDescendantOf Renderer o) => IsRenderer o Source #

Type class for types which can be safely cast to Renderer, for instance with toRenderer.

Instances

Instances details

(GObject o, IsDescendantOf Renderer o) => IsRenderer o Source #
Instance details Defined in GI.Gsk.Objects.Renderer

toRenderer :: (MonadIO m, IsRenderer o) => o -> m Renderer Source #

Cast to Renderer, for types for which this is known to be safe. For general casts, use castTo.

noRenderer :: Maybe Renderer Source #

A convenience alias for Nothing :: Maybe Renderer.

Methods

getSurface

rendererGetSurface Source #

Arguments

:: (HasCallStack, MonadIO m, IsRenderer a)
=> a	`renderer`: a `Renderer`
-> m (Maybe Surface)	Returns: a `Surface`

Retrieves the Surface set using rendererRealize. If the renderer has not been realized yet, Nothing will be returned.

isRealized

rendererIsRealized Source #

Arguments

:: (HasCallStack, MonadIO m, IsRenderer a)
=> a	`renderer`: a `Renderer`
-> m Bool	Returns: `True` if the `Renderer` was realized, and `False` otherwise

Checks whether the renderer is realized or not.

newForSurface

rendererNewForSurface Source #

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)
=> a	`surface`: a `Surface`
-> m (Maybe Renderer)	Returns: a `Renderer`

Creates an appropriate Renderer instance for the given surface.

The renderer will be realized when it is returned.

realize

rendererRealize Source #

Arguments

:: (HasCallStack, MonadIO m, IsRenderer a, IsSurface b)
=> a	`renderer`: a `Renderer`
-> b	`surface`: the `Surface` renderer will be used on
-> m ()	(Can throw `GError`)

Creates the resources needed by the renderer to render the scene graph.

render

rendererRender Source #

Arguments

:: (HasCallStack, MonadIO m, IsRenderer a)
=> a	`renderer`: a `Renderer`
-> RenderNode	`root`: a `RenderNode`
-> Maybe Region	`region`: the `Region` that must be redrawn or `Nothing` for the whole window
-> m ()

Renders the scene graph, described by a tree of RenderNode instances, ensuring that the given region gets redrawn.

Renderers must ensure that changes of the contents given by the root node as well as the area given by region are redrawn. They are however free to not redraw any pixel outside of region if they can guarantee that it didn't change.

The renderer will acquire a reference on the RenderNode tree while the rendering is in progress.

renderTexture

rendererRenderTexture Source #

Arguments

:: (HasCallStack, MonadIO m, IsRenderer a)
=> a	`renderer`: a realized `GdkRenderer`
-> RenderNode	`root`: a `RenderNode`
-> Maybe Rect	`viewport`: the section to draw or `Nothing` to use `root`'s bounds
-> m Texture	Returns: a `Texture` with the rendered contents of `root`.

Renders the scene graph, described by a tree of RenderNode instances, to a Texture.

The renderer will acquire a reference on the RenderNode tree while the rendering is in progress.

If you want to apply any transformations to root, you should put it into a transform node and pass that node instead.

unrealize

rendererUnrealize Source #

Arguments

:: (HasCallStack, MonadIO m, IsRenderer a)
=> a	`renderer`: a `Renderer`
-> m ()

Releases all the resources created by rendererRealize.

Properties

realized

No description available in the introspection data.

getRendererRealized :: (MonadIO m, IsRenderer o) => o -> m Bool Source #

Get the value of the “realized” property. When overloading is enabled, this is equivalent to

get renderer #realized

surface

No description available in the introspection data.

getRendererSurface :: (MonadIO m, IsRenderer o) => o -> m (Maybe Surface) Source #

Get the value of the “surface” property. When overloading is enabled, this is equivalent to

get renderer #surface