The easing Reference Manual

This is the easing Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:21:38 2020 GMT+0.

1 Introduction

Easing

This library includes commonly used easing functions (defined by Robert Penner), implemented in Common Lisp. Included with the library is an example program (implemented using Sketch).

Easing

Functions

linear in-sine out-sine in-out-sine in-cubic out-cubic in-out-cubic in-quad out-quad in-out-quad in-quart out-quart in-out-quart in-quint out-quint in-out-quint in-exp out-exp in-out-exp in-circ out-circ in-out-circ in-elastic out-elastic in-out-elastic in-back out-back in-out-back in-bounce out-bounce in-out-bounce

2 Systems

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

2.1 `easing`

Author

Danilo Vidovic (vydd)

License

MIT

Description

Easing functions.

Dependency

alexandria

Source

easing.asd (file)

Components

package.lisp (file)
easing.lisp (file)
easing-single-float.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 `easing.asd`

Location: /home/quickref/quicklisp/dists/quicklisp/software/easing-20180228-git/easing.asd
Systems: easing (system)

3.1.2 `easing/package.lisp`

Parent

easing (system)

Location

package.lisp

Packages

easing-f
easing

3.1.3 `easing/easing.lisp`

Dependency

package.lisp (file)

Parent

easing (system)

Location

easing.lisp

Exported Definitions

defeasing (macro)
in-back (function)
in-bounce (function)
in-circ (function)
in-cubic (function)
in-elastic (function)
in-exp (function)
in-out-back (function)
in-out-bounce (function)
in-out-circ (function)
in-out-cubic (function)
in-out-elastic (function)
in-out-exp (function)
in-out-quad (function)
in-out-quart (function)
in-out-quint (function)
in-out-sine (function)
in-quad (function)
in-quart (function)
in-quint (function)
in-sine (function)
linear (function)
out-back (function)
out-bounce (function)
out-circ (function)
out-cubic (function)
out-elastic (function)
out-exp (function)
out-quad (function)
out-quart (function)
out-quint (function)
out-sine (function)

3.1.4 `easing/easing-single-float.lisp`

Dependency

easing.lisp (file)

Parent

easing (system)

Location

easing-single-float.lisp

Exported Definitions

in-back (function)
in-bounce (function)
in-circ (function)
in-cubic (function)
in-elastic (function)
in-exp (function)
in-out-back (function)
in-out-bounce (function)
in-out-circ (function)
in-out-cubic (function)
in-out-elastic (function)
in-out-exp (function)
in-out-quad (function)
in-out-quart (function)
in-out-quint (function)
in-out-sine (function)
in-quad (function)
in-quart (function)
in-quint (function)
in-sine (function)
linear (function)
out-back (function)
out-bounce (function)
out-circ (function)
out-cubic (function)
out-elastic (function)
out-exp (function)
out-quad (function)
out-quart (function)
out-quint (function)
out-sine (function)

Internal Definitions

defeasing-f (macro)
pi-sf (constant)

4 Packages

Packages are listed by definition order.

4.1 `easing-f`

Source

package.lisp (file)

Nickname

ease-f

Use List

common-lisp

Exported Definitions

in-back (function)
in-bounce (function)
in-circ (function)
in-cubic (function)
in-elastic (function)
in-exp (function)
in-out-back (function)
in-out-bounce (function)
in-out-circ (function)
in-out-cubic (function)
in-out-elastic (function)
in-out-exp (function)
in-out-quad (function)
in-out-quart (function)
in-out-quint (function)
in-out-sine (function)
in-quad (function)
in-quart (function)
in-quint (function)
in-sine (function)
linear (function)
out-back (function)
out-bounce (function)
out-circ (function)
out-cubic (function)
out-elastic (function)
out-exp (function)
out-quad (function)
out-quart (function)
out-quint (function)
out-sine (function)

Internal Definitions

defeasing-f (macro)
pi-sf (constant)

4.2 `easing`

Source

package.lisp (file)

Nickname

ease

Use List

common-lisp

Exported Definitions

defeasing (macro)
in-back (function)
in-bounce (function)
in-circ (function)
in-cubic (function)
in-elastic (function)
in-exp (function)
in-out-back (function)
in-out-bounce (function)
in-out-circ (function)
in-out-cubic (function)
in-out-elastic (function)
in-out-exp (function)
in-out-quad (function)
in-out-quart (function)
in-out-quint (function)
in-out-sine (function)
in-quad (function)
in-quart (function)
in-quint (function)
in-sine (function)
linear (function)
out-back (function)
out-bounce (function)
out-circ (function)
out-cubic (function)
out-elastic (function)
out-exp (function)
out-quad (function)
out-quart (function)
out-quint (function)
out-sine (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: defeasing NAME ARGS &body BODY

Package: easing
Source: easing.lisp (file)

5.1.2 Functions

Function: in-back ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-back X &optional S

Package: easing
Source: easing.lisp (file)

Function: in-bounce ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-bounce X &optional C1

Package: easing
Source: easing.lisp (file)

Function: in-circ ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-circ X

Package: easing
Source: easing.lisp (file)

Function: in-cubic ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-cubic X

Package: easing
Source: easing.lisp (file)

Function: in-elastic ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-elastic X &optional P S

Package: easing
Source: easing.lisp (file)

Function: in-exp ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-exp X

Package: easing
Source: easing.lisp (file)

Function: in-out-back ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-back X &optional S

Package: easing
Source: easing.lisp (file)

Function: in-out-bounce ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-bounce X &optional C1

Package: easing
Source: easing.lisp (file)

Function: in-out-circ ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-circ X

Package: easing
Source: easing.lisp (file)

Function: in-out-cubic ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-cubic X

Package: easing
Source: easing.lisp (file)

Function: in-out-elastic ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-elastic X &optional P S

Package: easing
Source: easing.lisp (file)

Function: in-out-exp ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-exp X

Package: easing
Source: easing.lisp (file)

Function: in-out-quad ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-quad X

Package: easing
Source: easing.lisp (file)

Function: in-out-quart ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-quart X

Package: easing
Source: easing.lisp (file)

Function: in-out-quint ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-quint X

Package: easing
Source: easing.lisp (file)

Function: in-out-sine ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-out-sine X

Package: easing
Source: easing.lisp (file)

Function: in-quad ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-quad X

Package: easing
Source: easing.lisp (file)

Function: in-quart ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-quart X

Package: easing
Source: easing.lisp (file)

Function: in-quint ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-quint X

Package: easing
Source: easing.lisp (file)

Function: in-sine ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: in-sine X

Package: easing
Source: easing.lisp (file)

Function: linear ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: linear X

Package: easing
Source: easing.lisp (file)

Function: out-back ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-back X &optional S

Package: easing
Source: easing.lisp (file)

Function: out-bounce ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-bounce X &optional C1

Package: easing
Source: easing.lisp (file)

Function: out-circ ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-circ X

Package: easing
Source: easing.lisp (file)

Function: out-cubic ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-cubic X

Package: easing
Source: easing.lisp (file)

Function: out-elastic ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-elastic X &optional P S

Package: easing
Source: easing.lisp (file)

Function: out-exp ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-exp X

Package: easing
Source: easing.lisp (file)

Function: out-quad ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-quad X

Package: easing
Source: easing.lisp (file)

Function: out-quart ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-quart X

Package: easing
Source: easing.lisp (file)

Function: out-quint ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-quint X

Package: easing
Source: easing.lisp (file)

Function: out-sine ()

Package: easing-f
Source: easing-single-float.lisp (file)

Function: out-sine X

Package: easing
Source: easing.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: pi-sf

Package: easing-f
Source: easing-single-float.lisp (file)

5.2.2 Macros

Macro: defeasing-f NAME ARGS &body BODY

Package: easing-f
Source: easing-single-float.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	E F L

	Index Entry	Section

E
	`easing.asd`:	The easing․asd file
	`easing/easing-single-float.lisp`:	The easing/easing-single-float․lisp file
	`easing/easing.lisp`:	The easing/easing․lisp file
	`easing/package.lisp`:	The easing/package․lisp file

F
	File, Lisp, `easing.asd`:	The easing․asd file
	File, Lisp, `easing/easing-single-float.lisp`:	The easing/easing-single-float․lisp file
	File, Lisp, `easing/easing.lisp`:	The easing/easing․lisp file
	File, Lisp, `easing/package.lisp`:	The easing/package․lisp file

L
	Lisp File, `easing.asd`:	The easing․asd file
	Lisp File, `easing/easing-single-float.lisp`:	The easing/easing-single-float․lisp file
	Lisp File, `easing/easing.lisp`:	The easing/easing․lisp file
	Lisp File, `easing/package.lisp`:	The easing/package․lisp file

Jump to:	E F L

A.2 Functions

Jump to:	D F I L M O

	Index Entry	Section

D
	`defeasing`:	Exported macros
	`defeasing-f`:	Internal macros

F
	`Function, in-back`:	Exported functions
	`Function, in-back`:	Exported functions
	`Function, in-bounce`:	Exported functions
	`Function, in-bounce`:	Exported functions
	`Function, in-circ`:	Exported functions
	`Function, in-circ`:	Exported functions
	`Function, in-cubic`:	Exported functions
	`Function, in-cubic`:	Exported functions
	`Function, in-elastic`:	Exported functions
	`Function, in-elastic`:	Exported functions
	`Function, in-exp`:	Exported functions
	`Function, in-exp`:	Exported functions
	`Function, in-out-back`:	Exported functions
	`Function, in-out-back`:	Exported functions
	`Function, in-out-bounce`:	Exported functions
	`Function, in-out-bounce`:	Exported functions
	`Function, in-out-circ`:	Exported functions
	`Function, in-out-circ`:	Exported functions
	`Function, in-out-cubic`:	Exported functions
	`Function, in-out-cubic`:	Exported functions
	`Function, in-out-elastic`:	Exported functions
	`Function, in-out-elastic`:	Exported functions
	`Function, in-out-exp`:	Exported functions
	`Function, in-out-exp`:	Exported functions
	`Function, in-out-quad`:	Exported functions
	`Function, in-out-quad`:	Exported functions
	`Function, in-out-quart`:	Exported functions
	`Function, in-out-quart`:	Exported functions
	`Function, in-out-quint`:	Exported functions
	`Function, in-out-quint`:	Exported functions
	`Function, in-out-sine`:	Exported functions
	`Function, in-out-sine`:	Exported functions
	`Function, in-quad`:	Exported functions
	`Function, in-quad`:	Exported functions
	`Function, in-quart`:	Exported functions
	`Function, in-quart`:	Exported functions
	`Function, in-quint`:	Exported functions
	`Function, in-quint`:	Exported functions
	`Function, in-sine`:	Exported functions
	`Function, in-sine`:	Exported functions
	`Function, linear`:	Exported functions
	`Function, linear`:	Exported functions
	`Function, out-back`:	Exported functions
	`Function, out-back`:	Exported functions
	`Function, out-bounce`:	Exported functions
	`Function, out-bounce`:	Exported functions
	`Function, out-circ`:	Exported functions
	`Function, out-circ`:	Exported functions
	`Function, out-cubic`:	Exported functions
	`Function, out-cubic`:	Exported functions
	`Function, out-elastic`:	Exported functions
	`Function, out-elastic`:	Exported functions
	`Function, out-exp`:	Exported functions
	`Function, out-exp`:	Exported functions
	`Function, out-quad`:	Exported functions
	`Function, out-quad`:	Exported functions
	`Function, out-quart`:	Exported functions
	`Function, out-quart`:	Exported functions
	`Function, out-quint`:	Exported functions
	`Function, out-quint`:	Exported functions
	`Function, out-sine`:	Exported functions
	`Function, out-sine`:	Exported functions

I
	`in-back`:	Exported functions
	`in-back`:	Exported functions
	`in-bounce`:	Exported functions
	`in-bounce`:	Exported functions
	`in-circ`:	Exported functions
	`in-circ`:	Exported functions
	`in-cubic`:	Exported functions
	`in-cubic`:	Exported functions
	`in-elastic`:	Exported functions
	`in-elastic`:	Exported functions
	`in-exp`:	Exported functions
	`in-exp`:	Exported functions
	`in-out-back`:	Exported functions
	`in-out-back`:	Exported functions
	`in-out-bounce`:	Exported functions
	`in-out-bounce`:	Exported functions
	`in-out-circ`:	Exported functions
	`in-out-circ`:	Exported functions
	`in-out-cubic`:	Exported functions
	`in-out-cubic`:	Exported functions
	`in-out-elastic`:	Exported functions
	`in-out-elastic`:	Exported functions
	`in-out-exp`:	Exported functions
	`in-out-exp`:	Exported functions
	`in-out-quad`:	Exported functions
	`in-out-quad`:	Exported functions
	`in-out-quart`:	Exported functions
	`in-out-quart`:	Exported functions
	`in-out-quint`:	Exported functions
	`in-out-quint`:	Exported functions
	`in-out-sine`:	Exported functions
	`in-out-sine`:	Exported functions
	`in-quad`:	Exported functions
	`in-quad`:	Exported functions
	`in-quart`:	Exported functions
	`in-quart`:	Exported functions
	`in-quint`:	Exported functions
	`in-quint`:	Exported functions
	`in-sine`:	Exported functions
	`in-sine`:	Exported functions

L
	`linear`:	Exported functions
	`linear`:	Exported functions

M
	`Macro, defeasing`:	Exported macros
	`Macro, defeasing-f`:	Internal macros

O
	`out-back`:	Exported functions
	`out-back`:	Exported functions
	`out-bounce`:	Exported functions
	`out-bounce`:	Exported functions
	`out-circ`:	Exported functions
	`out-circ`:	Exported functions
	`out-cubic`:	Exported functions
	`out-cubic`:	Exported functions
	`out-elastic`:	Exported functions
	`out-elastic`:	Exported functions
	`out-exp`:	Exported functions
	`out-exp`:	Exported functions
	`out-quad`:	Exported functions
	`out-quad`:	Exported functions
	`out-quart`:	Exported functions
	`out-quart`:	Exported functions
	`out-quint`:	Exported functions
	`out-quint`:	Exported functions
	`out-sine`:	Exported functions
	`out-sine`:	Exported functions

Jump to:	D F I L M O

A.3 Variables

Jump to:	C P

	Index Entry	Section

C
	`Constant, pi-sf`:	Internal constants

P
	`pi-sf`:	Internal constants

Jump to:	C P

A.4 Data types

Jump to:	E P S

	Index Entry	Section

E
	`easing`:	The easing system
	`easing`:	The easing package
	`easing-f`:	The easing-f package

P
	`Package, easing`:	The easing package
	`Package, easing-f`:	The easing-f package

S
	`System, easing`:	The easing system

Jump to:	E P S

• Introduction		What easing is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The easing.asd file
• The easing/package.lisp file
• The easing/easing.lisp file
• The easing/easing-single-float.lisp file

• Concept index
• Function index
• Variable index
• Data type index

The easing Reference Manual

Table of Contents

The easing Reference Manual

1 Introduction

Easing

Functions

2 Systems

2.1 easing

3 Files

3.1 Lisp

3.1.1 easing.asd

3.1.2 easing/package.lisp

3.1.3 easing/easing.lisp

3.1.4 easing/easing-single-float.lisp

4 Packages

4.1 easing-f

4.2 easing

5 Definitions

5.1 Exported definitions

5.1.1 Macros

5.1.2 Functions

5.2 Internal definitions

5.2.1 Constants

5.2.2 Macros

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `easing`

3.1.1 `easing.asd`

3.1.2 `easing/package.lisp`

3.1.3 `easing/easing.lisp`

3.1.4 `easing/easing-single-float.lisp`

4.1 `easing-f`

4.2 `easing`