GI.Gsk.Objects.RenderNode

GskRenderNode is the basic block in a scene graph to be rendered using Renderer.

Each node has a parent, except the top-level node; each node may have children nodes.

Each node has an associated drawing surface, which has the size of the rectangle set when creating it.

Render nodes are meant to be transient; once they have been associated to a Renderer it's safe to release any reference you have on them. All RenderNodes are immutable, you can only specify their properties during construction.

Exported types

newtype RenderNode

Memory-managed wrapper type.

Constructors

RenderNode (ManagedPtr RenderNode)

Instances

Eq RenderNode

Defined in GI.Gsk.Objects.RenderNode

Methods

(==) :: RenderNode -> RenderNode -> Bool

(/=) :: RenderNode -> RenderNode -> Bool

BoxedPtr RenderNode

Defined in GI.Gsk.Objects.RenderNode

Methods

boxedPtrCopy :: RenderNode -> IO RenderNode

boxedPtrFree :: RenderNode -> IO ()

ManagedPtrNewtype RenderNode

Defined in GI.Gsk.Objects.RenderNode

Methods

toManagedPtr :: RenderNode -> ManagedPtr RenderNode

TypedObject RenderNode

Defined in GI.Gsk.Objects.RenderNode

Methods

glibType :: IO GType

HasParentTypes RenderNode

Defined in GI.Gsk.Objects.RenderNode

IsGValue (Maybe RenderNode)

Convert RenderNode to and from GValue. See toGValue and fromGValue.

Defined in GI.Gsk.Objects.RenderNode

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe RenderNode -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe RenderNode)

type ParentTypes RenderNode

Defined in GI.Gsk.Objects.RenderNode

type ParentTypes RenderNode = '[] :: [Type]

class (BoxedPtr o, TypedObject o, IsDescendantOf RenderNode o) => IsRenderNode o

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

Defined in GI.Gsk.Objects.RenderNode

toRenderNode :: (MonadIO m, IsRenderNode o) => o -> m RenderNode

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

Methods

draw, ref, serialize, unref, writeToFile.

Getters

getBounds, getNodeType.

Setters

None.

deserialize

renderNodeDeserialize

Arguments

:: (HasCallStack, MonadIO m)

=> Bytes

bytes: the bytes containing the data

-> Maybe ParseErrorFunc

errorFunc: Callback on parsing errors

-> m (Maybe RenderNode)

Returns: a new GskRenderNode

Loads data previously created via renderNodeSerialize.

For a discussion of the supported format, see that function.

draw

renderNodeDraw

Arguments

:: (HasCallStack, MonadIO m, IsRenderNode a)

=> a

node: a GskRenderNode

-> Context

cr: cairo context to draw to

-> 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

renderNodeGetBounds

Arguments

:: (HasCallStack, MonadIO m, IsRenderNode a)

=> a

node: a GskRenderNode

-> m Rect

Retrieves the boundaries of the node.

The node will not draw outside of its boundaries.

getNodeType

renderNodeGetNodeType

Arguments

:: (HasCallStack, MonadIO m, IsRenderNode a)

=> a

node: a GskRenderNode

-> m RenderNodeType

Returns: the type of the GskRenderNode

Returns the type of the node.

ref

renderNodeRef

Arguments

:: (HasCallStack, MonadIO m, IsRenderNode a)

=> a

node: a GskRenderNode

-> m RenderNode

Returns: the GskRenderNode with an additional reference

Acquires a reference on the given GskRenderNode.

serialize

renderNodeSerialize

Arguments

:: (HasCallStack, MonadIO m, IsRenderNode a)

=> a

node: a GskRenderNode

-> m Bytes

Returns: a GBytes representing the node.

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

renderNodeUnref

Arguments

:: (HasCallStack, MonadIO m, IsRenderNode a)

=> a

node: a GskRenderNode

-> m ()

Releases a reference on the given GskRenderNode.

If the reference was the last, the resources associated to the node are freed.

writeToFile

renderNodeWriteToFile

Arguments

:: (HasCallStack, MonadIO m, IsRenderNode a)

=> a

node: a GskRenderNode

-> [Char]

filename: the file to save it to.

-> m ()

(Can throw GError)

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.