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 Wed May 15 04:26:12 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-rsvg2

Bindings for RSVG Library.

Maintainer

Rörd Hinrichsen <>

Author

Sasha Kovar <>

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

3 Files

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


3.1 Lisp


3.1.1 cl-rsvg2/cl-rsvg2.asd

Source

cl-rsvg2.asd.

Parent Component

cl-rsvg2 (system).

ASDF Systems

cl-rsvg2.


3.1.2 cl-rsvg2/package.lisp

Source

cl-rsvg2.asd.

Parent Component

cl-rsvg2 (system).

Packages

cl-rsvg2.


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

Dependency

package.lisp (file).

Source

cl-rsvg2.asd.

Parent Component

cl-rsvg2 (system).

Public Interface
Internals

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

4 Packages

Packages are listed by definition order.


4.1 cl-rsvg2

Source

package.lisp.

Nickname

rsvg2

Use List
  • cffi.
  • common-lisp.
  • glib.
  • gobject.ffi.
  • trivial-gray-streams.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


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.


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.


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.


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.


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
Direct slots
Slot: handle
Initargs

:handle

Readers

handle.

Writers

This slot is read-only.


5.2 Internals


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.


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.

Appendix A Indexes


A.1 Concepts


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


A.3 Variables

Jump to:   H   S  
Index Entry  Section

H
handle: Public classes

S
Slot, handle: Public classes