The skippy-renderer Reference Manual

This is the skippy-renderer Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:17:50 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 skippy-renderer

GIF renderer for SKIPPY

Author

Michał "phoe" Herda

License

MIT

Dependency

skippy (system).

Source

skippy-renderer.asd.

Child Component

skippy-renderer.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 skippy-renderer/skippy-renderer.asd

Source

skippy-renderer.asd.

Parent Component

skippy-renderer (system).

ASDF Systems

skippy-renderer.


3.1.2 skippy-renderer/skippy-renderer.lisp

Source

skippy-renderer.asd.

Parent Component

skippy-renderer (system).

Packages

skippy-renderer.

Public Interface

render (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 skippy-renderer

Source

skippy-renderer.lisp.

Use List
  • common-lisp.
  • skippy.
Public Interface

render (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: render (data-stream &key byte-order)

Given a GIF data stream, returns a rendered image.

The BYTE-ORDER keyword argument is one of :ARGB or :BGRA. It states the order of bytes in the resulting vectors.

Three values are returned.
The first value is a list of vectors containing resulting ARGB data in row-first order and each second element
The second value is a list of integer values for the frame delays in milliseconds.
The third value is a list of three values: image width, image height and a generalized boolean signifying if the GIF should loop.

Package

skippy-renderer.

Source

skippy-renderer.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: index-argb (color-table index transparency-index)
Package

skippy-renderer.

Source

skippy-renderer.lisp.

Function: index-bgra (color-table index transparency-index)
Package

skippy-renderer.

Source

skippy-renderer.lisp.

Function: render-image-to-frame (frame frame-width image color-table &key byte-order)
Package

skippy-renderer.

Source

skippy-renderer.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables