The easing Reference Manual

This is the easing Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 04:28:07 2022 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.

easing

2.1 `easing`

Easing functions.

Author

Danilo Vidovic (vydd)

License

MIT

Dependency

alexandria (system).

Source

easing.asd.

Child 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.

Lisp

3.1.1 `easing/easing.asd`

Source: easing.asd.
Parent Component: easing (system).
ASDF Systems: easing.

3.1.2 `easing/package.lisp`

Source

easing.asd.

Parent Component

easing (system).

Packages

easing.
easing-f.

3.1.3 `easing/easing.lisp`

Dependency

package.lisp (file).

Source

easing.asd.

Parent Component

easing (system).

Public Interface

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).

Source

easing.asd.

Parent Component

easing (system).

Public Interface

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).

Internals

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

4 Packages

Packages are listed by definition order.

easing
easing-f

4.1 `easing`

Source

package.lisp.

Nickname

ease

Use List

common-lisp.

Public Interface

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).

4.2 `easing-f`

Source

package.lisp.

Nickname

ease-f

Use List

common-lisp.

Public Interface

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).

Internals

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

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Macros
Ordinary functions

5.1.1 Macros

Macro: defeasing (name args &body body) ¶

Package: easing.
Source: easing.lisp.

5.1.2 Ordinary functions

Function: in-back (x &optional s) ¶

Package: easing.
Source: easing.lisp.

Function: in-back () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-bounce (x &optional c1) ¶

Package: easing.
Source: easing.lisp.

Function: in-bounce () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-circ (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-circ () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-cubic (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-cubic () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-elastic (x &optional p s) ¶

Package: easing.
Source: easing.lisp.

Function: in-elastic () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-exp (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-exp () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-back (x &optional s) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-back () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-bounce (x &optional c1) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-bounce () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-circ (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-circ () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-cubic (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-cubic () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-elastic (x &optional p s) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-elastic () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-exp (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-exp () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-quad (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-quad () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-quart (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-quart () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-quint (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-quint () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-out-sine (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-out-sine () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-quad (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-quad () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-quart (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-quart () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-quint (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-quint () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: in-sine (x) ¶

Package: easing.
Source: easing.lisp.

Function: in-sine () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: linear (x) ¶

Package: easing.
Source: easing.lisp.

Function: linear () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-back (x &optional s) ¶

Package: easing.
Source: easing.lisp.

Function: out-back () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-bounce (x &optional c1) ¶

Package: easing.
Source: easing.lisp.

Function: out-bounce () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-circ (x) ¶

Package: easing.
Source: easing.lisp.

Function: out-circ () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-cubic (x) ¶

Package: easing.
Source: easing.lisp.

Function: out-cubic () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-elastic (x &optional p s) ¶

Package: easing.
Source: easing.lisp.

Function: out-elastic () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-exp (x) ¶

Package: easing.
Source: easing.lisp.

Function: out-exp () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-quad (x) ¶

Package: easing.
Source: easing.lisp.

Function: out-quad () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-quart (x) ¶

Package: easing.
Source: easing.lisp.

Function: out-quart () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-quint (x) ¶

Package: easing.
Source: easing.lisp.

Function: out-quint () ¶

Package: easing-f.
Source: easing-single-float.lisp.

Function: out-sine (x) ¶

Package: easing.
Source: easing.lisp.

Function: out-sine () ¶

Package: easing-f.
Source: easing-single-float.lisp.

5.2 Internals

Constants
Macros

5.2.1 Constants

Constant: pi-sf ¶

Package: easing-f.
Source: easing-single-float.lisp.

5.2.2 Macros

Macro: defeasing-f (name args &body body) ¶

Package: easing-f.
Source: easing-single-float.lisp.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	D F I L M O

	Index Entry	Section

D
	`defeasing`:	Public macros
	`defeasing-f`:	Private macros

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

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

L
	`linear`:	Public ordinary functions
	`linear`:	Public ordinary functions

M
	`Macro, defeasing`:	Public macros
	`Macro, defeasing-f`:	Private macros

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

Jump to:	D F I L M O

A.3 Variables

Jump to:	C P

	Index Entry	Section

C
	`Constant, pi-sf`:	Private constants

P
	`pi-sf`:	Private constants

Jump to:	C P

A.4 Data types

Jump to:	E F P S

	Index Entry	Section

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

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

P
	`Package, easing`:	The easing package
	`Package, easing-f`:	The easing-f package
	`package.lisp`:	The easing/package․lisp file

S
	`System, easing`:	The easing system

Jump to:	E F P S

The easing Reference Manual

The easing Reference Manual

Table of Contents

1 Introduction

Easing

Functions

2 Systems

2.1 easing

3 Files

3.1 Lisp

3.1.1 easing/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

4.2 easing-f

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.2 Internals

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/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`

4.2 `easing-f`