The skippy-renderer Reference Manual

Table of Contents

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

The skippy-renderer Reference Manual

This is the skippy-renderer Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:35:11 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

SKIPPY/RENDERER

This is a GIF renderer for SKIPPY.

The only exported function is RENDER which accepts a SKIPPY data stream and a BYTE-ORDER keyword argument that states the endianness of bytes in the resulting vector (ARGB or BGRA). It returns three values - a list of vectors containing ARGB data in row-major order, a list of integer values for frame delays in milliseconds, and a list containing three values: image width, image height and a boolean signifying if the GIF should loop.

LICENSE: MIT, or whatever the original SKIPPY is licensed under.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 skippy-renderer

Author

MichaƂ "phoe" Herda

License

MIT

Description

GIF renderer for SKIPPY

Dependency

skippy

Source

skippy-renderer.asd (file)

Component

skippy-renderer.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 skippy-renderer.asd

Location

skippy-renderer.asd

Systems

skippy-renderer (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 skippy-renderer/skippy-renderer.lisp

Parent

skippy-renderer (system)

Location

skippy-renderer.lisp

Packages

skippy-renderer

Exported Definitions

render (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 skippy-renderer

Source

skippy-renderer.lisp (file)

Use List
Exported Definitions

render (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 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 (file)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: index-argb COLOR-TABLE INDEX TRANSPARENCY-INDEX
Package

skippy-renderer

Source

skippy-renderer.lisp (file)

Function: index-bgra COLOR-TABLE INDEX TRANSPARENCY-INDEX
Package

skippy-renderer

Source

skippy-renderer.lisp (file)

Function: render-image-to-frame FRAME FRAME-WIDTH IMAGE COLOR-TABLE &key BYTE-ORDER
Package

skippy-renderer

Source

skippy-renderer.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, skippy-renderer.asd: The skippy-renderer<dot>asd file
File, Lisp, skippy-renderer/skippy-renderer.lisp: The skippy-renderer/skippy-renderer<dot>lisp file

L
Lisp File, skippy-renderer.asd: The skippy-renderer<dot>asd file
Lisp File, skippy-renderer/skippy-renderer.lisp: The skippy-renderer/skippy-renderer<dot>lisp file

S
skippy-renderer.asd: The skippy-renderer<dot>asd file
skippy-renderer/skippy-renderer.lisp: The skippy-renderer/skippy-renderer<dot>lisp file

Jump to:   F   L   S  

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

A.2 Functions

Jump to:   F   I   R  
Index Entry  Section

F
Function, index-argb: Internal functions
Function, index-bgra: Internal functions
Function, render: Exported functions
Function, render-image-to-frame: Internal functions

I
index-argb: Internal functions
index-bgra: Internal functions

R
render: Exported functions
render-image-to-frame: Internal functions

Jump to:   F   I   R  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, skippy-renderer: The skippy-renderer package

S
skippy-renderer: The skippy-renderer system
skippy-renderer: The skippy-renderer package
System, skippy-renderer: The skippy-renderer system

Jump to:   P   S