This is the sketch Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Aug 15 06:30:02 2024 GMT+0.
sketch/sketch.asdsketch/package.lispsketch/math.lispsketch/utils.lispsketch/environment.lispsketch/resources.lispsketch/color.lispsketch/channels.lispsketch/shaders.lispsketch/pen.lispsketch/font.lispsketch/geometry.lispsketch/drawing.lispsketch/image.lispsketch/shapes.lispsketch/transforms.lispsketch/sketch.lispsketch/figures.lispsketch/controllers.lispsketch/canvas.lispThe main system appears first, followed by any subsystem dependency.
sketchSketch is a Common Lisp framework for the creation of electronic art, computer graphics, visual design, game making and more. It is inspired by Processing and OpenFrameworks.
Danilo Vidovic (vydd)
MIT
alexandria (system).
cl-geometry (system).
glkit (system).
mathkit (system).
md5 (system).
sdl2-image (system).
sdl2-ttf (system).
sdl2kit (system).
split-sequence (system).
static-vectors (system).
zpng (system).
package.lisp (file).
math.lisp (file).
utils.lisp (file).
environment.lisp (file).
resources.lisp (file).
color.lisp (file).
channels.lisp (file).
shaders.lisp (file).
pen.lisp (file).
font.lisp (file).
geometry.lisp (file).
drawing.lisp (file).
image.lisp (file).
shapes.lisp (file).
transforms.lisp (file).
sketch.lisp (file).
figures.lisp (file).
controllers.lisp (file).
canvas.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
sketch/sketch.asdsketch/package.lispsketch/math.lispsketch/utils.lispsketch/environment.lispsketch/resources.lispsketch/color.lispsketch/channels.lispsketch/shaders.lispsketch/pen.lispsketch/font.lispsketch/geometry.lispsketch/drawing.lispsketch/image.lispsketch/shapes.lispsketch/transforms.lispsketch/sketch.lispsketch/figures.lispsketch/controllers.lispsketch/canvas.lispsketch/math.lisppackage.lisp (file).
sketch (system).
sketch/utils.lispmath.lisp (file).
sketch (system).
relative-path (function).
*build* (special variable).
abs-or-rel (function).
coerce-float (function).
copy-buffer (function).
div2-inexact (function).
flatten (function).
group (function).
group-bits (function).
lerp-lists (function).
mix-lists (function).
object-to-keyword-hash (function).
order-list (function).
pad-list (function).
sketch/environment.lisputils.lisp (file).
sketch (system).
*env* (special variable).
copy-env (function).
debug-mode-p (function).
env (structure).
env-buffer-position (reader).
(setf env-buffer-position) (writer).
env-debug-key-pressed (reader).
(setf env-debug-key-pressed) (writer).
env-font (reader).
(setf env-font) (writer).
env-matrix-stack (reader).
(setf env-matrix-stack) (writer).
env-model-matrix (reader).
(setf env-model-matrix) (writer).
env-p (function).
env-pen (reader).
(setf env-pen) (writer).
env-programs (reader).
(setf env-programs) (writer).
env-red-screen (reader).
(setf env-red-screen) (writer).
env-resources (reader).
(setf env-resources) (writer).
env-vao (reader).
(setf env-vao) (writer).
env-view-matrix (reader).
(setf env-view-matrix) (writer).
env-white-color-vector (reader).
(setf env-white-color-vector) (writer).
env-white-pixel-texture (reader).
(setf env-white-pixel-texture) (writer).
env-y-axis-sgn (reader).
(setf env-y-axis-sgn) (writer).
exit-debug-mode (function).
initialize-environment (function).
initialize-gl (function).
make-env (function).
make-white-pixel-texture (function).
with-environment (macro).
sketch/resources.lispenvironment.lisp (file).
sketch (system).
image (class).
load-resource (function).
cropped-image (class).
cropped-image-from-image (function).
cropped-image-uv-rect (reader method).
(setf cropped-image-uv-rect) (writer method).
file-name-extension (function).
free-resource (generic function).
image-height (reader method).
(setf image-height) (writer method).
image-texture (reader method).
(setf image-texture) (writer method).
image-width (reader method).
(setf image-width) (writer method).
load-typed-resource (generic function).
make-image-from-surface (function).
pixel-uv-rect (function).
resource (class).
typeface (class).
typeface-filename (reader method).
(setf typeface-filename) (writer method).
typeface-pointer (reader method).
(setf typeface-pointer) (writer method).
sketch/color.lispresources.lisp (file).
sketch (system).
+black+ (special variable).
+blue+ (special variable).
+cyan+ (special variable).
+green+ (special variable).
+magenta+ (special variable).
+orange+ (special variable).
+red+ (special variable).
+white+ (special variable).
+yellow+ (special variable).
color (class).
color-alpha (reader method).
(setf color-alpha) (writer method).
color-blue (reader method).
(setf color-blue) (method).
(setf color-blue) (writer method).
color-brightness (reader method).
(setf color-brightness) (method).
(setf color-brightness) (writer method).
color-filter-grayscale (function).
color-filter-hsb (function).
color-filter-invert (function).
color-filter-rotate (function).
color-green (reader method).
(setf color-green) (method).
(setf color-green) (writer method).
color-hsba (function).
color-hue (reader method).
(setf color-hue) (method).
(setf color-hue) (writer method).
color-red (reader method).
(setf color-red) (method).
(setf color-red) (writer method).
color-rgb (function).
color-rgba (function).
color-saturation (reader method).
(setf color-saturation) (method).
(setf color-saturation) (writer method).
color-vector (function).
color-vector-255 (function).
gray (function).
gray-255 (function).
hash-color (function).
hex-to-color (function).
hsb (function).
hsb-360 (function).
hsb-to-rgb (function).
lerp-color (function).
random-color (function).
rgb (function).
rgb-255 (function).
rgb-to-hsb (function).
add-updater-to-accessor (macro).
color-bgr (function).
color-bgra (function).
color-bgra-255 (function).
color-rgba-255 (function).
update-hsb (function).
update-rgb (function).
sketch/channels.lispcolor.lisp (file).
sketch (system).
define-channel-observer (macro).
define-named-channel-observer (macro).
in (function).
out (function).
register-input (function).
reset-all-channels (function).
%define-channel-observer (function).
*channel-propagations* (special variable).
*channels* (special variable).
*propagations* (special variable).
copy-propagation (function).
delete-channel-propagation (function).
extract-input-registration (function).
find-inputs-and-outputs (function).
make-propagation (function).
out-1 (function).
propagate (function).
propagation (structure).
propagation-function (reader).
(setf propagation-function) (writer).
propagation-inputs (reader).
(setf propagation-inputs) (writer).
propagation-name (reader).
(setf propagation-name) (writer).
propagation-outputs (reader).
(setf propagation-outputs) (writer).
propagation-p (function).
reset-channel (function).
update-propagation-data (function).
sketch/pen.lispshaders.lisp (file).
sketch (system).
background (function).
copy-pen (function).
flip-pen (function).
make-pen (function).
pen (structure).
pen-fill (reader).
(setf pen-fill) (writer).
pen-stroke (reader).
(setf pen-stroke) (writer).
pen-weight (reader).
(setf pen-weight) (writer).
set-pen (function).
with-pen (macro).
make-default-pen (function).
pen-curve-steps (reader).
(setf pen-curve-steps) (writer).
pen-p (function).
sketch/font.lisppen.lisp (file).
sketch (system).
make-font (function).
set-font (function).
text (function).
text-line-image (function).
with-font (macro).
font (class).
font-align (reader method).
(setf font-align) (writer method).
font-color (reader method).
(setf font-color) (writer method).
font-face (reader method).
(setf font-face) (writer method).
font-line-height (reader method).
(setf font-line-height) (writer method).
font-size (reader method).
(setf font-size) (writer method).
make-default-font (function).
make-error-font (function).
text-align (function).
text-scale (function).
sketch/geometry.lispfont.lisp (file).
sketch (system).
bounding-box (function).
edges (function).
grow-polygon (function).
intersect-lines (function).
normalize-to-bounding-box (function).
translate-line (function).
triangulate (function).
with-lines (macro).
sketch/drawing.lispgeometry.lisp (file).
sketch (system).
with-uv-rect (macro).
*buffer-size* (special variable).
*bytes-per-vertex* (special variable).
*draw-mode* (special variable).
*draw-sequence* (special variable).
*uv-rect* (special variable).
*vertex-attributes* (special variable).
draw-shape (function).
end-draw (function).
fill-buffer (function).
fit-uv-to-rect (function).
push-vertices (method).
push-vertices (method).
shader-color-texture-values (function).
start-draw (function).
transform-vertex (function).
sketch/image.lispdrawing.lisp (file).
sketch (system).
sketch/shapes.lispimage.lisp (file).
sketch (system).
cubic-bezier-point (function).
make-line (function).
make-ngon (function).
make-polygon (function).
make-polyline (function).
make-rect (function).
make-star (function).
ngon-vertices (function).
quadratic-bezier-point (function).
translated-intersects (function).
sketch/transforms.lispshapes.lisp (file).
sketch (system).
pop-matrix (function).
push-matrix (function).
rotate (function).
scale (function).
set-matrix (function).
translate (function).
with-current-matrix (macro).
with-identity-matrix (macro).
with-matrix (macro).
with-rotate (macro).
with-scale (macro).
with-translate (macro).
set-matrix* (function).
sketch/sketch.lisptransforms.lisp (file).
sketch (system).
close-window (method).
close-window (method).
defsketch (macro).
draw (generic function).
initialize-instance (method).
initialize-instance (method).
keyboard-event (method).
render (method).
setup (generic function).
sketch (class).
sketch-copy-pixels (reader method).
(setf sketch-copy-pixels) (writer method).
sketch-fullscreen (reader method).
(setf sketch-fullscreen) (generic function).
sketch-height (reader method).
(setf sketch-height) (generic function).
sketch-title (reader method).
(setf sketch-title) (generic function).
sketch-width (reader method).
(setf sketch-width) (generic function).
sketch-y-axis (reader method).
(setf sketch-y-axis) (generic function).
update-instance-for-redefined-class (method).
window-event (method).
*default-slots* (special variable).
*initialized* (special variable).
*sketch* (special variable).
binding-accessor (function).
channel-binding-p (function).
custom-bindings (function).
custom-slots (function).
default-slot-p (function).
define-sketch-class (macro).
define-sketch-writer (macro).
draw-window (function).
first-two (function).
gl-catch (macro).
initialize-sketch (function).
intern-accessor (function).
make-channel-observer (function).
make-channel-observers (function).
make-custom-slots-setf (function).
make-reinitialize-setf (function).
make-slot-form (function).
make-window-parameter-setf (function).
prepare (generic function).
replace-channels-with-values (function).
sketch-bindings-to-slots (function).
sketch/figures.lispsketch.lisp (file).
sketch (system).
figure (class).
sketch/controllers.lispfigures.lisp (file).
sketch (system).
keyboard-event (method).
mousebutton-event (method).
mousemotion-event (method).
mousewheel-event (method).
sketch/canvas.lispcontrollers.lisp (file).
sketch (system).
canvas-image (method).
canvas-lock (method).
canvas-paint (method).
canvas-reset (method).
canvas-unlock (method).
make-canvas (function).
%canvas-image (reader method).
(setf %canvas-image) (writer method).
%canvas-locked (reader method).
(setf %canvas-locked) (writer method).
%canvas-vector (reader method).
(setf %canvas-vector) (writer method).
%canvas-vector-pointer (method).
canvas (class).
canvas-height (reader method).
canvas-width (reader method).
Packages are listed by definition order.
sketchcommon-lisp.
+black+ (special variable).
+blue+ (special variable).
+cyan+ (special variable).
+e+ (constant).
+epsilon+ (constant).
+golden-ratio+ (constant).
+green+ (special variable).
+half-pi+ (constant).
+magenta+ (special variable).
+orange+ (special variable).
+phi+ (constant).
+pi+ (constant).
+quarter-pi+ (constant).
+red+ (special variable).
+tau+ (constant).
+two-pi+ (constant).
+white+ (special variable).
+yellow+ (special variable).
background (function).
bezier (function).
canvas-image (generic function).
canvas-lock (generic function).
canvas-paint (generic function).
canvas-reset (generic function).
canvas-unlock (generic function).
circle (function).
clamp-1 (function).
color (class).
color-alpha (generic reader).
(setf color-alpha) (generic writer).
color-blue (generic reader).
(setf color-blue) (generic function).
color-brightness (generic reader).
(setf color-brightness) (generic function).
color-filter-grayscale (function).
color-filter-hsb (function).
color-filter-invert (function).
color-filter-rotate (function).
color-green (generic reader).
(setf color-green) (generic function).
color-hsba (function).
color-hue (generic reader).
(setf color-hue) (generic function).
color-red (generic reader).
(setf color-red) (generic function).
color-rgb (function).
color-rgba (function).
color-saturation (generic reader).
(setf color-saturation) (generic function).
color-vector (function).
color-vector-255 (function).
copy-pen (function).
crop (generic function).
deffigure (macro).
define-channel-observer (macro).
define-named-channel-observer (macro).
defsketch (macro).
degrees (function).
draw (generic function).
ellipse (function).
flip-pen (function).
gray (function).
gray-255 (function).
hash-color (function).
hex-to-color (function).
hsb (function).
hsb-360 (function).
hsb-to-rgb (function).
image (function).
image (class).
in (function).
lerp-color (function).
line (function).
load-resource (function).
make-canvas (function).
make-font (function).
make-pen (function).
ngon (function).
normalize (function).
out (function).
pen (structure).
pen-fill (reader).
(setf pen-fill) (writer).
pen-stroke (reader).
(setf pen-stroke) (writer).
pen-weight (reader).
(setf pen-weight) (writer).
point (function).
polygon (function).
polyline (function).
pop-matrix (function).
push-matrix (function).
radians (function).
random-color (function).
rect (function).
register-input (function).
relative-path (function).
reset-all-channels (function).
rgb (function).
rgb-255 (function).
rgb-to-hsb (function).
rotate (function).
save-png (function).
scale (function).
set-font (function).
set-matrix (function).
set-pen (function).
setup (generic function).
sketch (class).
sketch-copy-pixels (generic reader).
(setf sketch-copy-pixels) (generic writer).
sketch-fullscreen (generic reader).
(setf sketch-fullscreen) (generic function).
sketch-height (generic reader).
(setf sketch-height) (generic function).
sketch-title (generic reader).
(setf sketch-title) (generic function).
sketch-width (generic reader).
(setf sketch-width) (generic function).
sketch-y-axis (generic reader).
(setf sketch-y-axis) (generic function).
star (function).
text (function).
text-line-image (function).
translate (function).
with-current-matrix (macro).
with-font (macro).
with-identity-matrix (macro).
with-matrix (macro).
with-pen (macro).
with-rotate (macro).
with-scale (macro).
with-translate (macro).
with-uv-rect (macro).
%canvas-image (generic reader).
(setf %canvas-image) (generic writer).
%canvas-locked (generic reader).
(setf %canvas-locked) (generic writer).
%canvas-vector (generic reader).
(setf %canvas-vector) (generic writer).
%canvas-vector-pointer (generic function).
%define-channel-observer (function).
*buffer-size* (special variable).
*build* (special variable).
*bytes-per-vertex* (special variable).
*channel-propagations* (special variable).
*channels* (special variable).
*default-slots* (special variable).
*draw-mode* (special variable).
*draw-sequence* (special variable).
*env* (special variable).
*initialized* (special variable).
*propagations* (special variable).
*sketch* (special variable).
*uv-rect* (special variable).
*vertex-attributes* (special variable).
abs-or-rel (function).
add-updater-to-accessor (macro).
binding-accessor (function).
bounding-box (function).
canvas (class).
canvas-height (generic reader).
canvas-width (generic reader).
channel-binding-p (function).
coerce-float (function).
color-bgr (function).
color-bgra (function).
color-bgra-255 (function).
color-rgba-255 (function).
copy-buffer (function).
copy-env (function).
copy-propagation (function).
cropped-image (class).
cropped-image-from-image (function).
cropped-image-uv-rect (generic reader).
(setf cropped-image-uv-rect) (generic writer).
cubic-bezier-point (function).
custom-bindings (function).
custom-slots (function).
debug-mode-p (function).
default-slot-p (function).
define-sketch-class (macro).
define-sketch-writer (macro).
delete-channel-propagation (function).
div2-inexact (function).
draw-shape (function).
draw-window (function).
edges (function).
end-draw (function).
env (structure).
env-buffer-position (reader).
(setf env-buffer-position) (writer).
env-debug-key-pressed (reader).
(setf env-debug-key-pressed) (writer).
env-font (reader).
(setf env-font) (writer).
env-matrix-stack (reader).
(setf env-matrix-stack) (writer).
env-model-matrix (reader).
(setf env-model-matrix) (writer).
env-p (function).
env-pen (reader).
(setf env-pen) (writer).
env-programs (reader).
(setf env-programs) (writer).
env-red-screen (reader).
(setf env-red-screen) (writer).
env-resources (reader).
(setf env-resources) (writer).
env-vao (reader).
(setf env-vao) (writer).
env-view-matrix (reader).
(setf env-view-matrix) (writer).
env-white-color-vector (reader).
(setf env-white-color-vector) (writer).
env-white-pixel-texture (reader).
(setf env-white-pixel-texture) (writer).
env-y-axis-sgn (reader).
(setf env-y-axis-sgn) (writer).
exit-debug-mode (function).
extract-input-registration (function).
figure (class).
file-name-extension (function).
fill-buffer (function).
find-inputs-and-outputs (function).
first-two (function).
fit-uv-to-rect (function).
flatten (function).
font (class).
font-align (generic reader).
(setf font-align) (generic writer).
font-color (generic reader).
(setf font-color) (generic writer).
font-face (generic reader).
(setf font-face) (generic writer).
font-line-height (generic reader).
(setf font-line-height) (generic writer).
font-size (generic reader).
(setf font-size) (generic writer).
free-resource (generic function).
gl-catch (macro).
group (function).
group-bits (function).
grow-polygon (function).
image-height (generic reader).
(setf image-height) (generic writer).
image-texture (generic reader).
(setf image-texture) (generic writer).
image-width (generic reader).
(setf image-width) (generic writer).
initialize-environment (function).
initialize-gl (function).
initialize-sketch (function).
intern-accessor (function).
intersect-lines (function).
lerp-lists (function).
load-typed-resource (generic function).
make-channel-observer (function).
make-channel-observers (function).
make-custom-slots-setf (function).
make-default-font (function).
make-default-pen (function).
make-env (function).
make-error-font (function).
make-image-from-surface (function).
make-line (function).
make-ngon (function).
make-polygon (function).
make-polyline (function).
make-propagation (function).
make-rect (function).
make-reinitialize-setf (function).
make-slot-form (function).
make-star (function).
make-white-pixel-texture (function).
make-window-parameter-setf (function).
mix-lists (function).
ngon-vertices (function).
normalize-to-bounding-box (function).
object-to-keyword-hash (function).
order-list (function).
out-1 (function).
pad-list (function).
pen-curve-steps (reader).
(setf pen-curve-steps) (writer).
pen-p (function).
pixel-uv-rect (function).
prepare (generic function).
propagate (function).
propagation (structure).
propagation-function (reader).
(setf propagation-function) (writer).
propagation-inputs (reader).
(setf propagation-inputs) (writer).
propagation-name (reader).
(setf propagation-name) (writer).
propagation-outputs (reader).
(setf propagation-outputs) (writer).
propagation-p (function).
push-vertices (generic function).
quadratic-bezier-point (function).
replace-channels-with-values (function).
reset-channel (function).
resource (class).
set-matrix* (function).
shader-color-texture-values (function).
sketch-bindings-to-slots (function).
start-draw (function).
text-align (function).
text-scale (function).
transform-vertex (function).
translate-line (function).
translated-intersects (function).
triangulate (function).
typeface (class).
typeface-filename (generic reader).
(setf typeface-filename) (generic writer).
typeface-pointer (generic reader).
(setf typeface-pointer) (generic writer).
update-hsb (function).
update-propagation-data (function).
update-rgb (function).
with-environment (macro).
with-lines (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Makes a new pen by swapping PEN’s fill and stroke colors.
Called repeatedly after creating the sketch window, used for drawing, 60fps.
Called before creating the sketch window.
sketch) &rest initargs &key &allow-other-keys) ¶sketch) state timestamp repeatp keysym) ¶kit.sdl2.
sketch) state timestamp repeatp keysym) ¶kit.sdl2.
sketch) state timestamp button x y) ¶kit.sdl2.
sketch) timestamp button-mask x y xrel yrel) ¶kit.sdl2.
sketch) added-slots discarded-slots property-list &rest initargs) ¶sketch) (type (eql :size-changed)) timestamp data1 data2) ¶kit.sdl2.
0.0
:red
0.0
:green
0.0
:blue
0.0
:hue
0.0
:saturation
0.0
:brightness
1.0
:alpha
gl-window.
close-window.
close-window.
draw.
initialize-instance.
initialize-instance.
keyboard-event.
keyboard-event.
mousebutton-event.
mousemotion-event.
mousewheel-event.
render.
setup.
(setf sketch-copy-pixels).
sketch-copy-pixels.
(setf sketch-fullscreen).
sketch-fullscreen.
(setf sketch-height).
sketch-height.
(setf sketch-title).
sketch-title.
(setf sketch-width).
sketch-width.
(setf sketch-y-axis).
sketch-y-axis.
update-instance-for-redefined-class.
window-event.
(sketch::make-env)
t
"sketch"
:title
This slot is read-only.
400
:width
This slot is read-only.
400
:height
This slot is read-only.
:fullscreen
This slot is read-only.
:copy-pixels
:down
:y-axis
This slot is read-only.
The current sketch instance.
Sent to shaders when no image is active.
Expensive operation that turns CL objects into keywords whose names
are MD5 hashes of those objects, stringified. Uniqueness is not guaranteed,
but may be considered unique for all practical purposes.
Generate uv coordinates (0.0 to 1.0) for portion of IMG within
the rect specified by X Y W H
Image flipping can be done by using negative width and height values
name.
cropped-image)) ¶automatically generated reader method
cropped-image)) ¶automatically generated writer method
Generated by DEFSKETCH.
progn.
:most-specific-last
structure-object.
(sb-cga:identity-matrix)
1
0
(make-hash-table)
:uv-rect
:face
:color
16
:size
1.41
:line-height
:left
:align
| Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U W |
|---|
| Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U W |
|---|
| Jump to: | %
*
+
A B C D F G H I L M N O P R S T U V W Y |
|---|
| Jump to: | %
*
+
A B C D F G H I L M N O P R S T U V W Y |
|---|
| Jump to: | C D E F G I M P R S T U |
|---|
| Jump to: | C D E F G I M P R S T U |
|---|