Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
A node in the render tree.
Synopsis
- newtype RenderNode = RenderNode (ManagedPtr RenderNode)
- class (BoxedPtr o, TypedObject o, IsDescendantOf RenderNode o) => IsRenderNode o
- toRenderNode :: (MonadIO m, IsRenderNode o) => o -> m RenderNode
- renderNodeDraw :: (HasCallStack, MonadIO m, IsRenderNode a) => a -> Context -> m ()
- renderNodeGetBounds :: (HasCallStack, MonadIO m, IsRenderNode a) => a -> m Rect
- renderNodeGetNodeType :: (HasCallStack, MonadIO m, IsRenderNode a) => a -> m RenderNodeType
- renderNodeRef :: (HasCallStack, MonadIO m, IsRenderNode a) => a -> m RenderNode
- renderNodeSerialize :: (HasCallStack, MonadIO m, IsRenderNode a) => a -> m Bytes
- renderNodeUnref :: (HasCallStack, MonadIO m, IsRenderNode a) => a -> m ()
- renderNodeWriteToFile :: (HasCallStack, MonadIO m, IsRenderNode a) => a -> Text -> m ()
Exported types
newtype RenderNode Source #
Memory-managed wrapper type.
RenderNode (ManagedPtr RenderNode) |
Instances
Eq RenderNode Source # | |
Defined in GI.Gsk.Objects.RenderNode (==) :: RenderNode -> RenderNode -> Bool # (/=) :: RenderNode -> RenderNode -> Bool # | |
BoxedPtr RenderNode Source # | |
Defined in GI.Gsk.Objects.RenderNode boxedPtrCopy :: RenderNode -> IO RenderNode boxedPtrFree :: RenderNode -> IO () | |
ManagedPtrNewtype RenderNode Source # | |
Defined in GI.Gsk.Objects.RenderNode toManagedPtr :: RenderNode -> ManagedPtr RenderNode | |
TypedObject RenderNode Source # | |
Defined in GI.Gsk.Objects.RenderNode | |
HasParentTypes RenderNode Source # | |
Defined in GI.Gsk.Objects.RenderNode | |
type ParentTypes RenderNode Source # | |
Defined in GI.Gsk.Objects.RenderNode |
class (BoxedPtr o, TypedObject o, IsDescendantOf RenderNode o) => IsRenderNode o Source #
Type class for types which can be safely cast to RenderNode
, for instance with toRenderNode
.
Instances
(BoxedPtr o, TypedObject o, IsDescendantOf RenderNode o) => IsRenderNode o Source # | |
Defined in GI.Gsk.Objects.RenderNode |
toRenderNode :: (MonadIO m, IsRenderNode o) => o -> m RenderNode Source #
Cast to RenderNode
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
draw
:: (HasCallStack, MonadIO m, IsRenderNode a) | |
=> a |
|
-> Context |
|
-> m () |
Draw the contents of node
to the given cairo context.
Typically, you'll use this function to implement fallback rendering
of GskRenderNodes
on an intermediate Cairo context, instead of using
the drawing context associated to a Surface
's rendering buffer.
For advanced nodes that cannot be supported using Cairo, in particular for nodes doing 3D operations, this function may fail.
getBounds
:: (HasCallStack, MonadIO m, IsRenderNode a) | |
=> a |
|
-> m Rect |
Retrieves the boundaries of the node
. The node will not draw outside
of its boundaries.
getNodeType
renderNodeGetNodeType Source #
:: (HasCallStack, MonadIO m, IsRenderNode a) | |
=> a |
|
-> m RenderNodeType | Returns: the type of the |
Returns the type of the node
.
ref
:: (HasCallStack, MonadIO m, IsRenderNode a) | |
=> a |
|
-> m RenderNode | Returns: the |
Acquires a reference on the given RenderNode
.
serialize
:: (HasCallStack, MonadIO m, IsRenderNode a) | |
=> a |
|
-> m Bytes | Returns: a |
Serializes the node
for later deserialization via
renderNodeDeserialize
. No guarantees are made about the format
used other than that the same version of GTK will be able to deserialize
the result of a call to renderNodeSerialize
and
renderNodeDeserialize
will correctly reject files it cannot open
that were created with previous versions of GTK.
The intended use of this functions is testing, benchmarking and debugging. The format is not meant as a permanent storage format.
unref
:: (HasCallStack, MonadIO m, IsRenderNode a) | |
=> a |
|
-> m () |
Releases a reference on the given RenderNode
.
If the reference was the last, the resources associated to the node
are
freed.
writeToFile
renderNodeWriteToFile Source #
:: (HasCallStack, MonadIO m, IsRenderNode a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
This function is equivalent to calling renderNodeSerialize
followed by fileSetContents
. See those two functions for details
on the arguments.
It is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection.