This is the cl-resvg Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:19:44 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-resvgAn up-to-date bindings library for the resvg SVG rendering library
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/shirakumo/cl-resvg.git)
zlib
1.0.0
documentation-utils (system).
float-features (system).
cffi (system).
package.lisp (file).
low-level.lisp (file).
wrapper.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-resvg/cl-resvg.asdcl-resvg/package.lispcl-resvg/low-level.lispcl-resvg/wrapper.lispcl-resvg/documentation.lispcl-resvg/low-level.lisppackage.lisp (file).
cl-resvg (system).
create-options (function).
destroy-options (function).
destroy-tree (function).
image-bbox (function).
image-empty-p (function).
image-size (function).
image-viewbox (function).
init-log (function).
load-font-data (function).
load-font-file (function).
load-system-fonts (function).
node-bbox (function).
node-exists-p (function).
node-stroke-bbox (function).
node-transform (function).
parse-from-data (function).
parse-from-file (function).
rect-height (function).
(setf rect-height) (function).
rect-width (function).
(setf rect-width) (function).
rect-x (function).
(setf rect-x) (function).
rect-y (function).
(setf rect-y) (function).
render (function).
render-node (function).
set-cursive-family (function).
set-dpi (function).
set-fantasy-family (function).
set-font-family (function).
set-font-size (function).
set-image-rendering-mode (function).
set-languages (function).
set-monospace-family (function).
set-resources-dir (function).
set-sans-serif-family (function).
set-serif-family (function).
set-shape-rendering-mode (function).
set-text-rendering-mode (function).
size-height (function).
(setf size-height) (function).
size-width (function).
(setf size-width) (function).
*here* (special variable).
*static* (special variable).
rect-tclass (class).
size-tclass (class).
transform-tclass (class).
cl-resvg/wrapper.lisplow-level.lisp (file).
cl-resvg (system).
bbox (function).
code (reader method).
empty-p (function).
free (method).
image (structure).
init (function).
load-font (function).
make-image (function).
make-transform (function).
node-p (function).
print-object (method).
render (function).
render-scaled (function).
resvg-error (condition).
shutdown (function).
size (function).
transform (function).
viewbox (function).
with-image (macro).
%make-image (function).
*options* (special variable).
check-error (function).
copy-image (function).
image-p (function).
ptr (reader).
(setf ptr) (writer).
cl-resvg/documentation.lispwrapper.lisp (file).
cl-resvg (system).
Packages are listed by definition order.
org.shirakumo.fraf.resvg.cfficommon-lisp.
create-options (function).
destroy-options (function).
destroy-tree (function).
image-bbox (function).
image-empty-p (function).
image-size (function).
image-viewbox (function).
init-log (function).
load-font-data (function).
load-font-file (function).
load-system-fonts (function).
node-bbox (function).
node-exists-p (function).
node-stroke-bbox (function).
node-transform (function).
parse-from-data (function).
parse-from-file (function).
rect-height (function).
(setf rect-height) (function).
rect-width (function).
(setf rect-width) (function).
rect-x (function).
(setf rect-x) (function).
rect-y (function).
(setf rect-y) (function).
render (function).
render-node (function).
set-cursive-family (function).
set-dpi (function).
set-fantasy-family (function).
set-font-family (function).
set-font-size (function).
set-image-rendering-mode (function).
set-languages (function).
set-monospace-family (function).
set-resources-dir (function).
set-sans-serif-family (function).
set-serif-family (function).
set-shape-rendering-mode (function).
set-text-rendering-mode (function).
size-height (function).
(setf size-height) (function).
size-width (function).
(setf size-width) (function).
*here* (special variable).
*static* (special variable).
rect-tclass (class).
size-tclass (class).
transform-tclass (class).
org.shirakumo.fraf.resvgcommon-lisp.
bbox (function).
code (generic reader).
empty-p (function).
free (generic function).
image (structure).
init (function).
load-font (function).
make-image (function).
make-transform (function).
node-p (function).
render (function).
render-scaled (function).
resvg-error (condition).
shutdown (function).
size (function).
transform (function).
viewbox (function).
with-image (macro).
%make-image (function).
*options* (special variable).
check-error (function).
copy-image (function).
image-p (function).
ptr (reader).
(setf ptr) (writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Convenience macro to lexically bind an image.
Calls INIT with the supplied options, then binds IMAGE to the result
of MAKE-IMAGE on SOURCE. Upon exit of the BODY, calls FREE on the
image.
See INIT
See IMAGE (type)
See MAKE-IMAGE
See FREE
Returns the bounding box as an (X Y W H) list.
If NODE is given, it should be the ID of a node in the SVG tree. If no such node exists, an error of type RESVG-ERROR is signalled.
See IMAGE (type)
Returns true if the image has no content.
See IMAGE (type)
Initializes the library.
It is safe to call this multiple times, especially to set different
options.
Should be called before other functions are called.
The options are as follows:
resources-dir — The directory to locate relative paths from
dpi — Sets the target DPI (default: 96)
font-size — Sets the default font size (defalut: 12)
fonts — Sets the default fonts. Should be a plist
with the following keys, and the values
being the name of the font-family to use.
:DEFAULT
:SERIF
:SANS-SERIF
:CURSIVE
:FANTASY
:MONOSPACE
languages — Sets the system languages. Should be a
comma-separated string
shape-rendering-mode — Sets the rendering mode for shapes. Can be
one of:
:OPTIMIZE-SPEED
:CRISP-EDGES
:GEOMETRIC-PRECISION
text-rendering-mode — Sets the rendering mode for text: Can be
one of:
:OPTIMIZE-SPEED
:OPTIMIZE-LEGIBILITY
:GEOMETRIC-PRECISION
image-rendering-mode — Sets the rendering mode for images: Can be
one of:
:OPTIMIZE-QUALITY
:OPTIMIZE-SPEED
See LOAD-FONT
See SHUTDOWN
Load a font from a file or UB8 vector.
After loading, the font will be available to render in SVG images.
Calls INIT if it wasn’t yet.
See INIT
Create a new SVG image from a data source.
SOURCE can either be a STRING or an UB8 vector for in-memory loading,
or a PATHNAME to load from a file.
Calls INIT if it wasn’t yet.
Signals a RESVG-ERROR if the file couldn’t be parsed.
See INIT
See IMAGE (type)
Create a transform matrix.
X-OFFSET and Y-OFFSET represent a translation.
X-SCALE and Y-SCALE represent a scaling.
ANGLE represents a rotation.
See RENDER
Returns true if a node with the given ID exists.
See IMAGE (type)
Render the image to a pixel buffer.
If NODE is given, it should be the ID of a node in the SVG tree.
If no such node exists, an error of type RESVG-ERROR is signalled.
If WIDTH or HEIGHT are not given, they are set to the dimensions of
the image.
If OUTPUT is not given, an array of the appropriate size is created
and returned for you.
If the TRANSFORM is given, it should be a 3x2 single-float
simple-array vector, by which the image is transformed before output.
Returns three values:
The output pixel array
The width in pixels
The height in pixels
See IMAGE (type)
See MAKE-TRANSFORM
See RENDER-SCALED
See SIZE
Render the image to a scaled output.
Either WIDTH or HEIGHT must be specified, setting the output image’s
width or height. If one of the parameters is omitted, the other is
computed based on the image’s aspect ratio and treating the specified
size as a uniform scaling factor.
For the other parameters, see RENDER
See RENDER
Uninitializes the library.
After calling this function you make not call any other functions
except for INIT.
It is safe to call this multiple times.
See INIT
Returns the size box as a (X . Y) cons.
If NODE is given, it should be the ID of a node in the SVG tree. If no such node exists, an error of type RESVG-ERROR is signalled.
See IMAGE (type)
Returns the transform matrix of the given node.
If no such node exists, an error of type RESVG-ERROR is signalled.
The transform is a 3x2 single-float matrix. If no simple-array is
passed, one is created and returned for you.
See MAKE-TRANSFORM
See IMAGE (type)
Returns the view box as an (X Y W H) list.
See IMAGE (type)
Returns the error code signalled by the underlying library.
See RESVG-ERROR
resvg-error)) ¶code.
Frees the image.
The object may not be used anymore after this.
It is safe to call this multiple times.
See IMAGE (type)
Error signalled when something goes wrong in the underlying library.
See CODE
error.
code.
Representation of an SVG image.
See MAKE-IMAGE
See FREE
See EMPTY-P
See VIEWBOX
See SIZE
See BBOX
See NODE-P
See TRANSFORM
See RENDER
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
B C D E F G I L M N P R S T V W |
|---|
| Jump to: | %
(
B C D E F G I L M N P R S T V W |
|---|
| Jump to: | *
C P S |
|---|
| Jump to: | *
C P S |
|---|
| Jump to: | C D F I L O P R S T W |
|---|
| Jump to: | C D F I L O P R S T W |
|---|