Package gsk

GTK Scene Graph Kit (GSK) is the rendering and scene graph API for GTK introduced with version 3.90. GSK lies between the graphical control elements (widgets) and the rendering. Like GDK, GSK is part of GTK and licensed under the GNU Lesser General Public License (LGPL). This is the API documentation of a Lisp binding to GSK.

About This Package

GskRenderer
GskPathMeasure
GtkPathPoint
GskStroke
GskPath
GskPathBuilder
GskRenderNode
GskRoundedRect
GskTransform
GskGLShader

GskRenderer

Class gsk:renderer

The gsk:renderer class is a class that renders a scene graph defined by a tree of gsk:render-node instances. ...

Accessor gsk:renderer-realized (object)

Accessor of the realized slot of the gsk:renderer class. ...

Accessor gsk:renderer-surface (object)

Accessor of the surface slot of the gsk:renderer class. ...

Function gsk:renderer-new-for-surface (surface)

Creates an appropriate gsk:renderer instance for the given surface. ...

Function gsk:renderer-realize (renderer surface)

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

Function gsk:renderer-unrealize (renderer)

Releases all the resources created by the gsk:renderer-realize function. ...

Function gsk:renderer-is-realized (renderer)

Checks whether the renderer is realized or not. ...

Function gsk:renderer-render (renderer root &optional region)

Renders the scene graph, described by a tree of gsk:render-node instances, ensuring that the given region gets redrawn. ...

Function gsk:renderer-render-texture (renderer root &optional viewport)

Renders the scene graph, described by a tree of gsk:render-node instances, to a gdk:texture instance. ...

Class gsk:cairo-renderer

The GSK renderer that is using Cairo. ...

Function gsk:cairo-renderer-new ()

Creates a new gsk:renderer instance using Cairo. ...

Class gsk:gl-renderer

The OpenGL based renderer. ...

Function gsk:gl-renderer-new ()

Creates a new gsk:renderer instance using OpenGL. ...

Class gsk:ngl-renderer

The new experimental OpenGL based renderer. ...

Function gsk:ngl-renderer-new ()

Creates an instance of the new experimental OpenGL renderer. ...

GskPathMeasure

GBoxed gsk:path-measure

The gsk:path-measure structure is a structure that allows measurements on gsk:path intances such as determining the length of the path. ...

Function gsk:path-measure-new (path)

Creates a measure object for the given path with the default tolerance. ...

Function gsk:path-measure-new-with-tolerance (path tolerance)

Creates a measure object for the given path and tolerance. ...

Function gsk:path-measure-length (measure)

Gets the length of the path being measured. ...

Function gsk:path-measure-path (measure)

Returns the path that the measure was created for. ...

Function gsk:path-measure-point (measure distance)

Returns the point at the given distance into the path. ...

Function gsk:path-measure-tolerance (measure)

Returns the tolerance that the measure was created with. ...

GtkPathPoint

GEnum gsk:path-direction

The values of the gsk:path-direction enumeration are used to pick one of the four tangents at a given point on the path. ...

GBoxed gsk:path-point

The gsk:path-point structure is an opaque type representing a point on a path. ...

Function gsk:path-point-curvature (point path direction center)

Calculates the curvature of the path at the point. ...

Function gsk:path-point-distance (point measure)

Returns the distance from the beginning of the path to point. ...

Function gsk:path-point-position (point path pos)

Gets the position of the point. ...

Function gsk:path-point-rotation (point path direction)

Gets the direction of the tangent at a given point. ...

Function gsk:path-point-tangent (point path direction tangent)

Gets the tangent of the path at the point. ...

Function gsk:path-point-compare (point1 point2)

Returns whether point1 is before or after point2. ...

Function gsk:path-point-copy (point)

Copies a path point. ...

Function gsk:path-point-equal (point1 point2)

Returns whether the two path points refer to the same location on all paths. ...

GskStroke

GEnum gsk:line-cap

Specifies how to render the start and end points of contours or dashes when stroking. ...

GEnum gsk:line-join

Specifies how to render the junction of two lines when stroking. ...

GBoxed gsk:stroke

The gsk:stroke structure collects the parameters that influence the operation of stroking a path. ...

Function gsk:stroke-new (width)

Creates a new gsk:stroke instance with the given width. ...

Function gsk:stroke-copy (stroke)

Creates a copy of the given stroke. ...

Function gsk:stroke-equal (stroke1 stroke2)

Checks if two strokes are identical. ...

Function gsk:stroke-dash (stroke)

The gsk:stroke-dash function gets the list of dashes in use or nil if dashing is disabled. ...

Function gsk:stroke-dash-offset (stroke)

The gsk:stroke-dash-offset function returns the dash offset of a gsk:stroke instance. ...

Function gsk:stroke-line-cap (stroke)

The gsk:stroke-line-cap function gets the line cap used. ...

Function gsk:stroke-line-join (stroke)

The gsk:stroke-line-join function gets the line join used. ...

Function gsk:stroke-line-width (stroke)

The gsk:stroke-line-width function gets the line width used. ...

Function gsk:stroke-miter-limit (stroke)

The gsk:stroke-miter-limit function returns the miter limit of a gsk:stroke instance. ...

Function gsk:stroke-to-cairo (stroke context)

A helper function that sets the stroke parameters of context from the values found in stroke. ...

GskPath

GFlags gsk:path-foreach-flags

Flags that can be passed to the gsk:path-foreach function to influence what kinds of operations the path is decomposed into. ...

GEnum gsk:path-operation

Path operations are used to describe the segments of a gsk:path instance. ...

GEnum gsk:fill-rule

The gsk:fill-rule enumeration is used to select how paths are filled. ...

GBoxed gsk:path

A gsk:path structure describes lines and curves that are more complex than simple rectangles. ...

Function gsk:path-parse (str)

This is a convenience function that constructs a gsk:path instance from a serialized form. ...

Callback gsk:path-foreach-func

Prototype of the callback function to iterate through the operations of a path. ...

Function gsk:path-foreach (path flags func)

Calls func for every operation of the path. ...

Function gsk:path-bounds (path bounds)

Computes the bounds of the given path. ...

Function gsk:path-closest-point (path point threshold)

Computes the closest point on the path to the given point and sets the result to it. ...

Function gsk:path-start-point (path)

Gets the start point of the path. ...

Function gsk:path-end-point (path)

Gets the end point of the path. ...

Function gsk:path-stroke-bounds (path stroke bounds)

Computes the bounds for stroking the given path with the parameters in stroke. ...

Function gsk:path-in-fill (path point rule)

Returns whether the given point is inside the area that would be affected if the path was filled according to rule. ...

Function gsk:path-is-closed (path)

Returns if the path represents a single closed contour. ...

Function gsk:path-is-empty (path)

Checks if the path is empty, that is, contains no lines or curves. ...

Function gsk:path-to-cairo (path context)

Appends the given path to the given Cairo context for drawing with Cairo. ...

Function gsk:path-to-string (path)

Converts the path into a human-readable string representation suitable for printing. ...

GskPathBuilder

GBoxed gsk:path-builder

The gsk:path-builder structure is an auxiliary structure for constructing gsk:path instances. ...

Function gsk:path-builder-new ()

Create a new gsk:path-builder instance. ...

Function gsk:path-builder-to-path (builder)

Creates a new gsk:path instance from the given path builder. ...

Function gsk:path-builder-current-point (path point)

Gets the current point. ...

Function gsk:path-builder-close (builder)

Ends the current contour with a line back to the start point. ...

Function gsk:path-builder-add-rect (builder rect)

Adds rect as a new contour to the path built by the path builder. ...

Function gsk:path-builder-add-circle (builder center radius)

Adds a circle with center and radius. ...

Function gsk:path-builder-add-layout (builder layout)

Adds the outlines for the glyphs in layout to the path builder. ...

Function gsk:path-builder-add-path (builder path)

Appends all of path to the path builder. ...

Function gsk:path-builder-add-reverse-path (builder path)

Appends all of path to the path builder, reverse order. ...

Function gsk:path-builder-add-rounded-rect (builder rect)

Adds rect as a new contour to the path built in builder. ...

Function gsk:path-builder-add-segment (builder path start end)

Adds to builder the segment of path from start to end. ...

Function gsk:path-builder-add-cairo-path (builder path)

Adds a Cairo path to the path builder. ...

Function gsk:path-builder-move-to (builder x y)

Starts a new contour by placing the pen at x, y. ...

Function gsk:path-builder-rel-move-to (builder x y)

Starts a new contour by placing the pen at x, y relative to the current point. ...

Function gsk:path-builder-line-to (builder x y)

Draws a line from the current point to x, y and makes it the new current point. ...

Function gsk:path-builder-rel-line-to (builder x y)

Draws a line from the current point to a point offset from it by x, y and makes it the new current point. ...

Function gsk:path-builder-arc-to (builder x1 y1 x2 y2)

Adds an elliptical arc from the current point to x2, y2 with x1, y1 determining the tangent directions. ...

Function gsk:path-builder-rel-arc-to (builder x1 y1 x2 y2)

Adds an elliptical arc from the current point to x2, y2 with x1, y1 determining the tangent directions. ...

Function gsk:path-builder-conic-to (builder x1 y1 x2 y2 weight)

Adds a conic curve from the current point to x2, y2 with the given weight and x1, y1 as the control point. ...

Function gsk:path-builder-rel-conic-to (builder x1 y1 x2 y2 weight)

Adds a conic curve from the current point to x2, y2 with the given weight and x1, y1 as the control point. ...

Function gsk:path-builder-cubic-to (builder x1 y1 x2 y2 x3 y3)

Adds a cubic Bézier curve from the current point to x3, y3 with x1, y1 and x2, y2 as the control points. ...

Function gsk:path-builder-rel-cubic-to (builder x1 y1 x2 y2 x3 y3)

Adds a cubic Bézier curve from the current point to x3, y3 with x1, y1 and x2, y2 as the control points. ...

Function gsk:path-builder-quad-to (builder x1 y1 x2 y2)

Adds a quadratic Bézier curve from the current point to x2, y2 with x1, y1 as the control point. ...

Function gsk:path-builder-rel-quad-to (builder x1 y1 x2 y2)

Adds a quadratic Bézier curve from the current point to x2, y2 with x1, y1 as the control point. ...

Function gsk:path-builder-html-arc-to (builder x1 y1 x2 y2 radius)

Implements arc-to according to the HTML Canvas spec. ...

Function gsk:path-builder-rel-html-arc-to (builder x1 y1 x2 y2 radius)

Implements arc-to according to the HTML Canvas spec. ...

Function gsk:path-builder-svg-arc-to (builder rx ry x-axis-rotation large-arc positive-sweep x y)

Implements arc-to according to the SVG spec. ...

Function gsk:path-builder-rel-svg-arc-to (builder rx ry x-axis-rotation large-arc positive-sweep x y)

Implements arc-to according to the SVG spec. ...

GskRenderNode

GEnum gsk:render-node-type

The type of a node determines what the node is rendering. ...

GEnum gsk:scaling-filter

The filters used when scaling texture data. ...

GEnum gsk:blend-mode

The blend modes available for render nodes. ...

GEnum gsk:mask-mode

The mask modes available for mask nodes. ...

GskRenderNode gsk:render-node

The gsk:render-node instance is the basic block in a scene graph to be rendered using the gsk:renderer object. ...

Function gsk:render-node-ref (node)

Acquires a reference on the given render node. ...

Function gsk:render-node-unref (node)

Releases a reference on the given render node. ...

Function gsk:render-node-node-type (node)

Returns the type of the render node. ...

Function gsk:render-node-draw (node cr)

Draw the contents of node to the given Cairo context. ...

Function gsk:render-node-serialize (node)

Serializes the node for later deserialization via the gsk:render-node-deserialize function. ...

Function gsk:render-node-deserialize (bytes)

Loads data previously created via the gsk:render-node-serialize function. ...

Function gsk:render-node-write-to-file (node path)

This function is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection. ...

Function gsk:render-node-bounds (node bounds)

Retrieves the boundaries of the render node. ...

GskRenderNode gsk:container-node

A render node that can contain other render nodes. ...

Function gsk:container-node-new (children)

Creates a new container node for holding the given children. ...

Function gsk:container-node-n-children (node)

Retrieves the number of direct children of node. ...

Function gsk:container-node-child (node index)

Gets one of the children of the container node. ...

GskRenderNode gsk:cairo-node

A render node for a Cairo surface. ...

Function gsk:cairo-node-new (bounds)

Creates a render node that will render a Cairo surface into the area given by bounds. ...

Function gsk:cairo-node-draw-context (node)

Creates a Cairo context for drawing using the surface associated to the render node. ...

Function gsk:cairo-node-surface (node)

Retrieves the Cairo surface used by the render node. ...

GskRenderNode gsk:color-node

A render node for a solid color. ...

Function gsk:color-node-new (rgba bounds)

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

Function gsk:color-node-color (node)

Retrieves the color of the given render node. ...

GskRenderNode gsk:linear-gradient-node

A render node for a linear gradient. ...

Function gsk:linear-gradient-node-new (bounds start end color-stops)

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

Function gsk:linear-gradient-node-start (node)

Retrieves the initial point of the linear gradient. ...

Function gsk:linear-gradient-node-end (node)

Retrieves the final point of the linear gradient. ...

Function gsk:linear-gradient-node-n-color-stops (node)

Retrieves the number of color stops in the linear gradient. ...

Function gsk:linear-gradient-node-color-stops (node)

Retrieves the color stops in the linear gradient. ...

GskRenderNode gsk:repeating-linear-gradient-node

A render node for a repeating linear gradient. ...

Function gsk:repeating-linear-gradient-node-new (bounds start end color-stops)

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

GskRenderNode gsk:radial-gradient-node

A render node for a radial gradient. ...

Function gsk:radial-gradient-node-new (bounds center hradius vradius start end color-stops)

Creates a render node that will create a radial gradient. ...

Function gsk:radial-gradient-node-n-color-stops (node)

Retrieves the number of color stops in the radial gradient. ...

Function gsk:radial-gradient-node-color-stops (node)

Retrieves the color stops in the radial gradient. ...

Function gsk:radial-gradient-node-start (node)

Retrieves the start value for the radial gradient. ...

Function gsk:radial-gradient-node-end (node)

Retrieves the end value for the radial gradient. ...