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

The simple-rgb Reference Manual

This is the simple-rgb Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:53:34 2024 GMT+0.

Next: Systems, Previous: The simple-rgb Reference Manual, Up: The simple-rgb Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The simple-rgb Reference Manual [Contents][Index]

2 Systems

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

simple-rgb

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

2.1 `simple-rgb`

simple manipulation of {X|HT}ML RGB values

Maintainer

William S. Annis <wm.annis@gmail.com>

Author

William S. Annis <wm.annis@gmail.com>

License

MIT

Version

0.1

Source

simple-rgb.asd.

Child Components

package.lisp (file).
rgb.lisp (file).

Next: Packages, Previous: Systems, Up: The simple-rgb Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: simple-rgb/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `simple-rgb/simple-rgb.asd`

Source: simple-rgb.asd.
Parent Component: simple-rgb (system).
ASDF Systems: simple-rgb.

Next: simple-rgb/rgb.lisp, Previous: simple-rgb/simple-rgb.asd, Up: Lisp [Contents][Index]

3.1.2 `simple-rgb/package.lisp`

Source: simple-rgb.asd.
Parent Component: simple-rgb (system).
Packages: simple-rgb.

Previous: simple-rgb/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `simple-rgb/rgb.lisp`

Dependency

package.lisp (file).

Source

simple-rgb.asd.

Parent Component

simple-rgb (system).

Public Interface

complement-rgb (function).
contrast-rgb (function).
darken-rgb (function).
darken-rgb! (function).
greyscale-rgb (function).
hsv (function).
hsv (type).
hsv->rgb (function).
hsv-type-error (condition).
invert-rgb (function).
lighten-rgb (function).
lighten-rgb! (function).
mix-rgb (function).
mix-rgb! (function).
parse (function).
rgb (function).
rgb (type).
rgb->hsv (function).
rgb= (function).
rotate-hsv (function).
rotate-rgb (function).
xmlify-rgb (function).

Internals

+rgb-black+ (special variable).
+rgb-white+ (special variable).
bugged-hsv-vector (reader method).
(setf bugged-hsv-vector) (writer method).

Next: Definitions, Previous: Files, Up: The simple-rgb Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

simple-rgb

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

4.1 `simple-rgb`

Source

package.lisp.

Nickname

rgb

Use List

common-lisp.

Public Interface

complement-rgb (function).
contrast-rgb (function).
darken-rgb (function).
darken-rgb! (function).
greyscale-rgb (function).
hsv (function).
hsv (type).
hsv->rgb (function).
hsv-type-error (condition).
invert-rgb (function).
lighten-rgb (function).
lighten-rgb! (function).
mix-rgb (function).
mix-rgb! (function).
parse (function).
rgb (function).
rgb (type).
rgb->hsv (function).
rgb= (function).
rotate-hsv (function).
rotate-rgb (function).
xmlify-rgb (function).

Internals

+rgb-black+ (special variable).
+rgb-white+ (special variable).
bugged-hsv-vector (generic reader).
(setf bugged-hsv-vector) (generic writer).

Next: Indexes, Previous: Packages, Up: The simple-rgb Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions
Conditions
Types

Next: Conditions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: complement-rgb (a) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: contrast-rgb (a &optional cut) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: darken-rgb (a &key alpha) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: darken-rgb! (a &key alpha) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: greyscale-rgb (a) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: hsv (h s v) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: hsv->rgb (a) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: invert-rgb (a) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: lighten-rgb (a &key alpha) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: lighten-rgb! (a &key alpha) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: mix-rgb (a b &key alpha) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: mix-rgb! (a b &key alpha) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: parse (string) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: rgb (r g b) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: rgb->hsv (a) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: rgb= (a b) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: rotate-hsv (a rotation) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: rotate-rgb (a rotation) ¶

Package: simple-rgb.
Source: rgb.lisp.

Function: xmlify-rgb (a &optional stream) ¶

Package: simple-rgb.
Source: rgb.lisp.

Next: Types, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.2 Conditions

Condition: hsv-type-error ¶

Package

simple-rgb.

Source

rgb.lisp.

Direct superclasses

type-error.

Direct methods

(setf bugged-hsv-vector).
bugged-hsv-vector.

Direct slots

Slot: bugged-vector ¶

Initargs: :bugged
Readers: bugged-hsv-vector.
Writers: (setf bugged-hsv-vector).

Previous: Conditions, Up: Public Interface [Contents][Index]

5.1.3 Types

Type: hsv () ¶

Package: simple-rgb.
Source: rgb.lisp.

Type: rgb () ¶

Package: simple-rgb.
Source: rgb.lisp.

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

5.2 Internals

Special variables
Generic functions

Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: +rgb-black+ ¶

Package: simple-rgb.
Source: rgb.lisp.

Special Variable: +rgb-white+ ¶

Package: simple-rgb.
Source: rgb.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Generic functions

Generic Reader: bugged-hsv-vector (condition) ¶

Generic Writer: (setf bugged-hsv-vector) (condition) ¶

Package

simple-rgb.

Methods

Reader Method: bugged-hsv-vector ((condition hsv-type-error)) ¶

Writer Method: (setf bugged-hsv-vector) ((condition hsv-type-error)) ¶

Source: rgb.lisp.
Target Slot: bugged-vector.

Previous: Definitions, Up: The simple-rgb Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( B C D F G H I L M P R X

	Index Entry	Section

(
	`(setf bugged-hsv-vector)`:	Private generic functions
	`(setf bugged-hsv-vector)`:	Private generic functions

B
	`bugged-hsv-vector`:	Private generic functions
	`bugged-hsv-vector`:	Private generic functions

C
	`complement-rgb`:	Public ordinary functions
	`contrast-rgb`:	Public ordinary functions

D
	`darken-rgb`:	Public ordinary functions
	`darken-rgb!`:	Public ordinary functions

F
	`Function, complement-rgb`:	Public ordinary functions
	`Function, contrast-rgb`:	Public ordinary functions
	`Function, darken-rgb`:	Public ordinary functions
	`Function, darken-rgb!`:	Public ordinary functions
	`Function, greyscale-rgb`:	Public ordinary functions
	`Function, hsv`:	Public ordinary functions
	`Function, hsv->rgb`:	Public ordinary functions
	`Function, invert-rgb`:	Public ordinary functions
	`Function, lighten-rgb`:	Public ordinary functions
	`Function, lighten-rgb!`:	Public ordinary functions
	`Function, mix-rgb`:	Public ordinary functions
	`Function, mix-rgb!`:	Public ordinary functions
	`Function, parse`:	Public ordinary functions
	`Function, rgb`:	Public ordinary functions
	`Function, rgb->hsv`:	Public ordinary functions
	`Function, rgb=`:	Public ordinary functions
	`Function, rotate-hsv`:	Public ordinary functions
	`Function, rotate-rgb`:	Public ordinary functions
	`Function, xmlify-rgb`:	Public ordinary functions

G
	`Generic Function, (setf bugged-hsv-vector)`:	Private generic functions
	`Generic Function, bugged-hsv-vector`:	Private generic functions
	`greyscale-rgb`:	Public ordinary functions

H
	`hsv`:	Public ordinary functions
	`hsv->rgb`:	Public ordinary functions

I
	`invert-rgb`:	Public ordinary functions

L
	`lighten-rgb`:	Public ordinary functions
	`lighten-rgb!`:	Public ordinary functions

M
	`Method, (setf bugged-hsv-vector)`:	Private generic functions
	`Method, bugged-hsv-vector`:	Private generic functions
	`mix-rgb`:	Public ordinary functions
	`mix-rgb!`:	Public ordinary functions

P
	`parse`:	Public ordinary functions

R
	`rgb`:	Public ordinary functions
	`rgb->hsv`:	Public ordinary functions
	`rgb=`:	Public ordinary functions
	`rotate-hsv`:	Public ordinary functions
	`rotate-rgb`:	Public ordinary functions

X
	`xmlify-rgb`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ B S

	Index Entry	Section

+
	`+rgb-black+`:	Private special variables
	`+rgb-white+`:	Private special variables

B
	`bugged-vector`:	Public conditions

S
	`Slot, bugged-vector`:	Public conditions
	`Special Variable, +rgb-black+`:	Private special variables
	`Special Variable, +rgb-white+`:	Private special variables

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

A.4 Data types

Jump to:	C F H P R S T

	Index Entry	Section

C
	`Condition, hsv-type-error`:	Public conditions

F
	`File, package.lisp`:	The simple-rgb/package․lisp file
	`File, rgb.lisp`:	The simple-rgb/rgb․lisp file
	`File, simple-rgb.asd`:	The simple-rgb/simple-rgb․asd file

H
	`hsv`:	Public types
	`hsv-type-error`:	Public conditions

P
	`Package, simple-rgb`:	The simple-rgb package
	`package.lisp`:	The simple-rgb/package․lisp file

R
	`rgb`:	Public types
	`rgb.lisp`:	The simple-rgb/rgb․lisp file

S
	`simple-rgb`:	The simple-rgb system
	`simple-rgb`:	The simple-rgb package
	`simple-rgb.asd`:	The simple-rgb/simple-rgb․asd file
	`System, simple-rgb`:	The simple-rgb system

T
	`Type, hsv`:	Public types
	`Type, rgb`:	Public types

The simple-rgb Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 simple-rgb

3 Files

3.1 Lisp

3.1.1 simple-rgb/simple-rgb.asd

3.1.2 simple-rgb/package.lisp

3.1.3 simple-rgb/rgb.lisp

4 Packages

4.1 simple-rgb

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.1.2 Conditions

5.1.3 Types

5.2 Internals

5.2.1 Special variables

5.2.2 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `simple-rgb`

3.1.1 `simple-rgb/simple-rgb.asd`

3.1.2 `simple-rgb/package.lisp`

3.1.3 `simple-rgb/rgb.lisp`

4.1 `simple-rgb`