Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-rsvg2 Reference Manual

This is the cl-rsvg2 Reference Manual, version 0.4.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 12:34:08 2023 GMT+0.

Next: Systems, Previous: The cl-rsvg2 Reference Manual, Up: The cl-rsvg2 Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-rsvg2 Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

cl-rsvg2

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-rsvg2`

Bindings for RSVG Library.

Maintainer

Rörd Hinrichsen <roerdhh@gmail.com>

Author

Sasha Kovar <sasha-rsvg@arcocene.org>

License

LLGPL

Version

0.4.1

Dependencies

cffi (system).
cl-cairo2 (system).
cl-gtk2-glib (system).
trivial-gray-streams (system).

Source

cl-rsvg2.asd.

Child Components

package.lisp (file).
cl-rsvg2-ffi.lisp (file).
cl-rsvg2.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-rsvg2 Reference Manual [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: cl-rsvg2/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-rsvg2/cl-rsvg2.asd`

Source: cl-rsvg2.asd.
Parent Component: cl-rsvg2 (system).
ASDF Systems: cl-rsvg2.

Next: cl-rsvg2/cl-rsvg2-ffi.lisp, Previous: cl-rsvg2/cl-rsvg2.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-rsvg2/package.lisp`

Source: cl-rsvg2.asd.
Parent Component: cl-rsvg2 (system).
Packages: cl-rsvg2.

Next: cl-rsvg2/cl-rsvg2.lisp, Previous: cl-rsvg2/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-rsvg2/cl-rsvg2-ffi.lisp`

Dependency

package.lisp (file).

Source

cl-rsvg2.asd.

Parent Component

cl-rsvg2 (system).

Public Interface

handle-get-base-uri (function).
handle-get-desc (function).
handle-get-metadata (function).
handle-get-title (function).
handle-has-sub (function).
handle-new (function).
handle-set-base-uri (function).
handle-set-dpi (function).
handle-set-dpi-x-y (function).
set-default-dpi (function).
set-default-dpi-x-y (function).

Internals

dimension-data-tclass (class).
handle-close (function).
handle-get-dimensions (function).
handle-get-dimensions-sub (function).
handle-get-position-sub (function).
handle-new-from-data (function).
handle-new-from-file (function).
handle-render-cairo (function).
handle-render-cairo-sub (function).
handle-write (function).
position-data-tclass (class).

Previous: cl-rsvg2/cl-rsvg2-ffi.lisp, Up: Lisp [Contents][Index]

3.1.4 `cl-rsvg2/cl-rsvg2.lisp`

Dependency

cl-rsvg2-ffi.lisp (file).

Source

cl-rsvg2.asd.

Parent Component

cl-rsvg2 (system).

Public Interface

close (method).
draw-svg (function).
draw-svg-data (function).
draw-svg-file (function).
draw-svg-sub (function).
handle (reader method).
handle-close* (function).
handle-data-stream (class).
handle-get-dimension-values (function).
handle-get-sub-dimension-values (function).
handle-get-sub-position-values (function).
handle-write-data (function).
stream-element-type (method).
stream-write-byte (method).
stream-write-sequence (method).
with-handle (macro).
with-handle-data-stream (macro).
with-handle-from-data (macro).
with-handle-from-file (macro).

Next: Definitions, Previous: Files, Up: The cl-rsvg2 Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-rsvg2

Previous: Packages, Up: Packages [Contents][Index]

4.1 `cl-rsvg2`

Source

package.lisp.

Nickname

rsvg2

Use List

cffi.
common-lisp.
glib.
gobject.ffi.
trivial-gray-streams.

Public Interface

draw-svg (function).
draw-svg-data (function).
draw-svg-file (function).
draw-svg-sub (function).
handle (generic reader).
handle-close* (function).
handle-data-stream (class).
handle-get-base-uri (function).
handle-get-desc (function).
handle-get-dimension-values (function).
handle-get-metadata (function).
handle-get-sub-dimension-values (function).
handle-get-sub-position-values (function).
handle-get-title (function).
handle-has-sub (function).
handle-new (function).
handle-set-base-uri (function).
handle-set-dpi (function).
handle-set-dpi-x-y (function).
handle-write-data (function).
set-default-dpi (function).
set-default-dpi-x-y (function).
with-handle (macro).
with-handle-data-stream (macro).
with-handle-from-data (macro).
with-handle-from-file (macro).

Internals

dimension-data-tclass (class).
handle-close (function).
handle-get-dimensions (function).
handle-get-dimensions-sub (function).
handle-get-position-sub (function).
handle-new-from-data (function).
handle-new-from-file (function).
handle-render-cairo (function).
handle-render-cairo-sub (function).
handle-write (function).
position-data-tclass (class).

Next: Indexes, Previous: Packages, Up: The cl-rsvg2 Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Standalone methods
Classes

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: with-handle ((var handle) &body body) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Macro: with-handle-data-stream ((stream) &body body) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Macro: with-handle-from-data ((handle data data-len) &body body) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Macro: with-handle-from-file ((handle filespec) &body body) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: draw-svg (svg &optional context) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: draw-svg-data (data data-len &optional context) ¶

Draw SVG data on a Cairo surface. DATA needs to be an uint8 C array, and DATA-LEN its length, in bytes. Return the SVGs width and height.

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: draw-svg-file (filespec &optional context) ¶

Draw a SVG file on a Cairo surface. Return its width and height.

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: draw-svg-sub (svg id &optional context) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: handle-close* (handle) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: handle-get-base-uri (handle) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-get-desc (handle) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-get-dimension-values (handle) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: handle-get-metadata (handle) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-get-sub-dimension-values (handle id) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: handle-get-sub-position-values (handle id) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: handle-get-title (handle) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-has-sub (handle id) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-new () ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-set-base-uri (handle base-uri) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-set-dpi (handle dpi) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-set-dpi-x-y (handle dpi-x dpi-y) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-write-data (handle buf count) ¶

Package: cl-rsvg2.
Source: cl-rsvg2.lisp.

Function: set-default-dpi (dpi) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: set-default-dpi-x-y (dpi-x dpi-y) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.3 Generic functions

Generic Reader: handle (object) ¶

Package

cl-rsvg2.

Methods

Reader Method: handle ((handle-data-stream handle-data-stream)) ¶

automatically generated reader method

Source: cl-rsvg2.lisp.
Target Slot: handle.

Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.4 Standalone methods

Method: close ((stream handle-data-stream) &key abort) ¶

Source: cl-rsvg2.lisp.

Method: stream-element-type ((stream handle-data-stream)) ¶

Source: cl-rsvg2.lisp.

Method: stream-write-byte ((stream handle-data-stream) integer) ¶

Package: sb-gray.
Source: cl-rsvg2.lisp.

Method: stream-write-sequence ((stream handle-data-stream) sequence start end &key) ¶

Package: trivial-gray-streams.
Source: cl-rsvg2.lisp.

Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.5 Classes

Class: handle-data-stream ¶

Package

cl-rsvg2.

Source

cl-rsvg2.lisp.

Direct superclasses

fundamental-binary-output-stream.
trivial-gray-stream-mixin.

Direct methods

close.
handle.
stream-element-type.
stream-write-byte.
stream-write-sequence.

Direct slots

Slot: handle ¶

Initargs: :handle
Readers: handle.
Writers: This slot is read-only.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions
Classes

Next: Classes, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: handle-close (handle error) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-get-dimensions (handle dimension-data) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-get-dimensions-sub (handle dimension-data id) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-get-position-sub (handle position-data id) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-new-from-data (data data_len error) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-new-from-file (file_name error) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-render-cairo (handle cr) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-render-cairo-sub (handle cr id) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Function: handle-write (handle buf count error) ¶

Package: cl-rsvg2.
Source: cl-rsvg2-ffi.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.2 Classes

Class: dimension-data-tclass ¶

Package

cl-rsvg2.

Source

cl-rsvg2-ffi.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: position-data-tclass ¶

Package

cl-rsvg2.

Source

cl-rsvg2-ffi.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Previous: Definitions, Up: The cl-rsvg2 Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	C D F G H M S W

	Index Entry	Section

C
	`close`:	Public standalone methods

D
	`draw-svg`:	Public ordinary functions
	`draw-svg-data`:	Public ordinary functions
	`draw-svg-file`:	Public ordinary functions
	`draw-svg-sub`:	Public ordinary functions

F
	`Function, draw-svg`:	Public ordinary functions
	`Function, draw-svg-data`:	Public ordinary functions
	`Function, draw-svg-file`:	Public ordinary functions
	`Function, draw-svg-sub`:	Public ordinary functions
	`Function, handle-close`:	Private ordinary functions
	`Function, handle-close*`:	Public ordinary functions
	`Function, handle-get-base-uri`:	Public ordinary functions
	`Function, handle-get-desc`:	Public ordinary functions
	`Function, handle-get-dimension-values`:	Public ordinary functions
	`Function, handle-get-dimensions`:	Private ordinary functions
	`Function, handle-get-dimensions-sub`:	Private ordinary functions
	`Function, handle-get-metadata`:	Public ordinary functions
	`Function, handle-get-position-sub`:	Private ordinary functions
	`Function, handle-get-sub-dimension-values`:	Public ordinary functions
	`Function, handle-get-sub-position-values`:	Public ordinary functions
	`Function, handle-get-title`:	Public ordinary functions
	`Function, handle-has-sub`:	Public ordinary functions
	`Function, handle-new`:	Public ordinary functions
	`Function, handle-new-from-data`:	Private ordinary functions
	`Function, handle-new-from-file`:	Private ordinary functions
	`Function, handle-render-cairo`:	Private ordinary functions
	`Function, handle-render-cairo-sub`:	Private ordinary functions
	`Function, handle-set-base-uri`:	Public ordinary functions
	`Function, handle-set-dpi`:	Public ordinary functions
	`Function, handle-set-dpi-x-y`:	Public ordinary functions
	`Function, handle-write`:	Private ordinary functions
	`Function, handle-write-data`:	Public ordinary functions
	`Function, set-default-dpi`:	Public ordinary functions
	`Function, set-default-dpi-x-y`:	Public ordinary functions

G
	`Generic Function, handle`:	Public generic functions

H
	`handle`:	Public generic functions
	`handle`:	Public generic functions
	`handle-close`:	Private ordinary functions
	`handle-close*`:	Public ordinary functions
	`handle-get-base-uri`:	Public ordinary functions
	`handle-get-desc`:	Public ordinary functions
	`handle-get-dimension-values`:	Public ordinary functions
	`handle-get-dimensions`:	Private ordinary functions
	`handle-get-dimensions-sub`:	Private ordinary functions
	`handle-get-metadata`:	Public ordinary functions
	`handle-get-position-sub`:	Private ordinary functions
	`handle-get-sub-dimension-values`:	Public ordinary functions
	`handle-get-sub-position-values`:	Public ordinary functions
	`handle-get-title`:	Public ordinary functions
	`handle-has-sub`:	Public ordinary functions
	`handle-new`:	Public ordinary functions
	`handle-new-from-data`:	Private ordinary functions
	`handle-new-from-file`:	Private ordinary functions
	`handle-render-cairo`:	Private ordinary functions
	`handle-render-cairo-sub`:	Private ordinary functions
	`handle-set-base-uri`:	Public ordinary functions
	`handle-set-dpi`:	Public ordinary functions
	`handle-set-dpi-x-y`:	Public ordinary functions
	`handle-write`:	Private ordinary functions
	`handle-write-data`:	Public ordinary functions

M
	`Macro, with-handle`:	Public macros
	`Macro, with-handle-data-stream`:	Public macros
	`Macro, with-handle-from-data`:	Public macros
	`Macro, with-handle-from-file`:	Public macros
	`Method, close`:	Public standalone methods
	`Method, handle`:	Public generic functions
	`Method, stream-element-type`:	Public standalone methods
	`Method, stream-write-byte`:	Public standalone methods
	`Method, stream-write-sequence`:	Public standalone methods

S
	`set-default-dpi`:	Public ordinary functions
	`set-default-dpi-x-y`:	Public ordinary functions
	`stream-element-type`:	Public standalone methods
	`stream-write-byte`:	Public standalone methods
	`stream-write-sequence`:	Public standalone methods

W
	`with-handle`:	Public macros
	`with-handle-data-stream`:	Public macros
	`with-handle-from-data`:	Public macros
	`with-handle-from-file`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	H S

	Index Entry	Section

H
	`handle`:	Public classes

S
	`Slot, handle`:	Public classes

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C D F H P S

	Index Entry	Section

C
	`cl-rsvg2`:	The cl-rsvg2 system
	`cl-rsvg2`:	The cl-rsvg2 package
	`cl-rsvg2-ffi.lisp`:	The cl-rsvg2/cl-rsvg2-ffi․lisp file
	`cl-rsvg2.asd`:	The cl-rsvg2/cl-rsvg2․asd file
	`cl-rsvg2.lisp`:	The cl-rsvg2/cl-rsvg2․lisp file
	`Class, dimension-data-tclass`:	Private classes
	`Class, handle-data-stream`:	Public classes
	`Class, position-data-tclass`:	Private classes

D
	`dimension-data-tclass`:	Private classes

F
	`File, cl-rsvg2-ffi.lisp`:	The cl-rsvg2/cl-rsvg2-ffi․lisp file
	`File, cl-rsvg2.asd`:	The cl-rsvg2/cl-rsvg2․asd file
	`File, cl-rsvg2.lisp`:	The cl-rsvg2/cl-rsvg2․lisp file
	`File, package.lisp`:	The cl-rsvg2/package․lisp file

H
	`handle-data-stream`:	Public classes

P
	`Package, cl-rsvg2`:	The cl-rsvg2 package
	`package.lisp`:	The cl-rsvg2/package․lisp file
	`position-data-tclass`:	Private classes

S
	`System, cl-rsvg2`:	The cl-rsvg2 system

The cl-rsvg2 Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-rsvg2

3 Files

3.1 Lisp

3.1.1 cl-rsvg2/cl-rsvg2.asd

3.1.2 cl-rsvg2/package.lisp

3.1.3 cl-rsvg2/cl-rsvg2-ffi.lisp

3.1.4 cl-rsvg2/cl-rsvg2.lisp

4 Packages

4.1 cl-rsvg2

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Standalone methods

5.1.5 Classes

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-rsvg2`

3.1.1 `cl-rsvg2/cl-rsvg2.asd`

3.1.2 `cl-rsvg2/package.lisp`

3.1.3 `cl-rsvg2/cl-rsvg2-ffi.lisp`

3.1.4 `cl-rsvg2/cl-rsvg2.lisp`

4.1 `cl-rsvg2`