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 |
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
Memory-managed wrapper type.
Instances
Eq Renderer Source # | |
GObject Renderer Source # | |
Defined in GI.Gsk.Objects.Renderer gobjectType :: IO GType # | |
IsGValue Renderer Source # | Convert |
HasParentTypes Renderer Source # | |
Defined in GI.Gsk.Objects.Renderer | |
type ParentTypes Renderer Source # | |
Defined in GI.Gsk.Objects.Renderer |
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
(GObject o, IsDescendantOf Renderer o) => IsRenderer o Source # | |
Defined in GI.Gsk.Objects.Renderer |
toRenderer :: (MonadIO m, IsRenderer o) => o -> m Renderer Source #
Methods
Overloaded methods
getSurface
:: (HasCallStack, MonadIO m, IsRenderer a) | |
=> a |
|
-> m (Maybe Surface) | Returns: a |
Retrieves the Surface
set using rendererRealize
. If the renderer
has not been realized yet, Nothing
will be returned.
isRealized
:: (HasCallStack, MonadIO m, IsRenderer a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether the renderer
is realized or not.
newForSurface
rendererNewForSurface Source #
:: (HasCallStack, MonadIO m, IsSurface a) | |
=> a |
|
-> m (Maybe Renderer) | Returns: a |
Creates an appropriate Renderer
instance for the given surface
.
The renderer will be realized when it is returned.
realize
:: (HasCallStack, MonadIO m, IsRenderer a, IsSurface b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Creates the resources needed by the renderer
to render the scene
graph.
render
:: (HasCallStack, MonadIO m, IsRenderer a) | |
=> a |
|
-> RenderNode |
|
-> Maybe Region |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsRenderer a) | |
=> a |
|
-> RenderNode |
|
-> Maybe Rect |
|
-> m Texture | Returns: a |
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
:: (HasCallStack, MonadIO m, IsRenderer a) | |
=> a |
|
-> 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