canvas-draw | chickadee

Canvas Draw

Description

Bindings to the CanvasDraw graphics library

See the original C library

Repository

https://chust.org/repos/scheme-canvas-draw

Documentation

See the official API docs.

Here is a condensed version to be usable with the online and offline Chicken documentation.

main Module

Usage

(import canvas-draw)

This module re-exports most bindings from the base, play and primitives modules.

To create canvasses you also have to import bindings from at least one of the context modules: iup, native, gl, clipboard, printer, picture, server, client, pdf, ps, svg, metafile, debug, cgm, dgn, dxf, emf, wmf.

The foreign types and conversion procedures defined in base are not re-exported.

base Module

Usage

(import canvas-draw-base)

Basic CD library support. Initializes the CD library when loaded.

Data Types

(canvas? [v any/c]) -> boolean?procedure: Check whether a value is a CD canvas.

(context? [v any/c]) -> boolean?procedure: Check whether a value is a CD driver context.

(state? [v any/c]) -> boolean?procedure: Check whether a value is a CD canvas state.

Canvas Management

(context-capabilities [context context?]) -> (listof symbol?)procedure

Returns a list of flags describing the capabilities supported by the given context.

The following flags may show up in the list:

'flush
'clear
'play
'y-axis
'clip-area
'clip-polygon
'region
'rectangle
'chord
'image/rgb
'image/rgba
'image/map
'get-image/rgb
'image/server
'background
'background-opacity
'write-mode
'line-style
'line-width
'fprimtives
'hatch
'stipple
'pattern
'font
'font-dimensions
'text-size
'text-orientation
'palette
'line-cap
'line-join
'path
'bezier

(use-context+ (parameter/c any))parameter

A parameter determining whether calls to make-canvas should use extended variants of the passed context drivers.

Defaults to #f.

(make-canvas [context context?] [data (or/c string? pointer?)]) -> canvas?procedure: Creates a new canvas with the given driver context. The data is context specific and is either a string describing the setup of the new canvas or a pointer to some native data object. e.g., to create a canvas from an iup canvas, use (make-canvas context:iup iup-canvas)

(call-with-canvas [canvas canvas?] [proc (-> canvas? any)]) -> anyprocedure

(call-with-canvas [context context?] [data (or/c string? pointer?)] [proc (-> canvas? any)]) -> anyprocedure

Calls the given procedure with the given canvas and makes sure the canvas is synchronized with external resources around the call.

If called in the three argument form, a fresh canvas is created using the given context and is automatically destroyed upon return from the given procedure.

(canvas-context [canvas canvas?]) -> context?procedure: Retrieves the context from a given canvas.

(canvas-simulate! [canvas canvas?] [flags (listof symbol?)]) -> (listof symbol?)procedure

Sets flags determining which operations should be simulated by the given canvas. Returns the previous set of flags.

The following flags may show up in the list:

'line
'rectangle
'box
'arc
'sector
'chord
'polyline
'polygon
'text
'all
'lines
'fills

(canvas-attribute [canvas canvas?] [name (or/c symbol? string?)]) -> (or/c string? #f)procedure: Retrieves the value of a context specific canvas attribute.

(canvas-attribute-set! [canvas canvas?] [name (or/c symbol? string?)] [value (or/c string? #f)]) -> void?procedure

Alternatively (set! (canvas-attribute [canvas canvas?] [name (or/c symbol? string?)]) [value (or/c string? #f)]) -> void?

Sets the value of a context specific canvas attribute.

(canvas-state [canvas canvas?]) -> state?procedure: Extracts a representation of the current state from a canvas.

(canvas-state-set! [canvas canvas?] [state state?]) -> void?procedure

Alternatively (set! (canvas-state [canvas canvas?]) [state state?]) -> void?

Restores the given state of a canvas.

(canvas-clear! [canvas canvas?]) -> void?procedure: Clears a canvas to the background color.

(canvas-flush [canvas canvas?]) -> void?procedure: Flushes all pending drawing operations in a canvas to its backend.

Coordinate System

(canvas-size [canvas canvas?]) -> (values integer? integer? real? real?)procedure: Retrieves the width and height of the given canvas in pixels and millimeters.

(canvas-mm->px [canvas canvas?] [x/mm real?] [y/mm real?]) -> (values integer? integer?)procedure: Converts a position given in millimeters into a pixel position in the given canvas.

(canvas-px->mm [canvas canvas?] [x/px integer?] [y/px integer?]) -> (values real? real?)procedure: Converts a position given in pixels into a physical position in the given canvas.

(canvas-origin [canvas canvas?]) -> (values integer? integer?)procedure: Retrieves the position of the canvas' origin.

(canvas-origin-set! [canvas canvas?] [x integer?] [y integer?]) -> void?procedure: Defines the position of the canvas' origin.

(canvas-transform [canvas canvas?]) -> (or/c (-> real? real? (values integer? integer?)) #f)procedure: Retrieves the active coordinate transformation of the given canvas.

(canvas-transform-set! [canvas canvas?] [proc (or/c (-> real? real? (values integer? integer?)) #f)]) -> void?procedure

Alternatively (set! (canvas-transform [canvas canvas?]) [proc (or/c (-> real? real? (values integer? integer?)) #f)]) -> void?

Defines the active coordinate transformation for the given canvas. The given procedure must represent a linear transformation.

(canvas-transform-compose! [canvas canvas?] [proc (-> real? real? (values integer? integer?))]) -> void?procedure: Modifies the active coordinate transformation for the given canvas by left-multiplication with the given transformation. The given procedure must represent a linear transformation.

(canvas-transform-translate! [canvas canvas?] [dx real?] [dy real?]) -> void?procedure: Modifies the active coordinate transformation for the given canvas applying a translation.

(canvas-transform-scale! [canvas canvas?] [sx real?] [sy real?]) -> void?procedure: Modifies the active coordinate transformation for the given canvas applying a scaling.

(canvas-transform-rotate! [canvas canvas?] [alpha real?]) -> void? procedure: Modifies the active coordinate transformation for the given canvas applying a rotation around the origin.

General Attributes

(canvas-foreground [canvas canvas?]) -> integer?procedure: Retrieves the foreground color of the given canvas.

(canvas-foreground-set! [canvas canvas?] [color integer?]) -> void?procedure

Alternatively (set! (canvas-foreground [canvas canvas?]) [color integer?]) -> void?

Sets the foreground color of the given canvas.

(canvas-background [canvas canvas?]) -> integer?procedure: Retrieves the background color of the given canvas.

(canvas-background-set! [canvas canvas?] [color integer?]) -> void?procedure

Alternatively (set! (canvas-background [canvas canvas?]) [color integer?]) -> void?

Sets the background color of the given canvas.

(canvas-write-mode [canvas canvas?]) -> symbol?procedure

Retrieves the write mode of the given canvas.

The mode may be one of the following symbols:

'replace
'xor
'not-xor

(canvas-write-mode-set! [canvas canvas?] [mode symbol?]) -> void?procedure

Alternatively (set! (canvas-write-mode [canvas canvas?]) [mode symbol?]) -> void?

Sets the write mode of the given canvas.

Clipping

(canvas-clip-mode [canvas canvas?]) -> (or/c symbol? #f)procedure

Retrieves the clipping mode of the given canvas.

The mode may be one of the following values:

'area
'polygon
'region
#f

In fact, #t is never returned but may be used when setting the clipping mode.

(canvas-clip-mode-set! [canvas canvas?] [mode (or/c symbol? #f)]) -> void?procedure

(set! (canvas-clip-mode [canvas canvas?]) [mode (or/c symbol? #f)]) -> void?

Sets the clipping mode of the given canvas.

(canvas-clip-area [canvas canvas?]) -> (values real? real? real? real?)procedure: Retrieves the current rectangular clipping area of the given canvas.

(canvas-clip-area-set! [canvas canvas?] [x0 double?] [x1 double?] [y0 double?] [y1 double?]) -> void?procedure

Sets the current rectangular clipping area of the given canvas.

The base module only exports checking type conversion functions instead of foreign types since the latter cannot be exported. To define the types canvas, nonnull-canvas, context, nonnull-context, state and nonnull-state in your own module, include the file "canvas-draw-types.scm".

((canvas->pointer [nonnull? any/c]) [canvas (or/c canvas? #f)]) -> (or/c pointer? #f)procedure

Checking conversion from canvasses to pointers.