summaryrefslogtreecommitdiff
path: root/chickadee/graphics/color.scm
blob: e2766dfba4cd81b89af7583d39fa21cae421e9f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
;;; Chickadee Game Toolkit
;;; Copyright © 2016, 2018, 2021 David Thompson <davet@gnu.org>
;;;
;;; Chickadee is free software: you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published
;;; by the Free Software Foundation, either version 3 of the License,
;;; or (at your option) any later version.
;;;
;;; Chickadee is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;;; General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with this program.  If not, see
;;; <http://www.gnu.org/licenses/>.

;;; Commentary:
;;
;; Colors!
;;
;;; Code:

(define-module (chickadee graphics color)
  #:use-module (chickadee graphics engine)
  #:use-module (chickadee graphics gl)
  #:use-module (chickadee math)
  #:use-module (ice-9 match)
  #:use-module (srfi srfi-9)
  #:use-module (srfi srfi-1)
  #:export (make-color
            make-color8
            color?
            color-r
            color-g
            color-b
            color-a
            rgba
            rgb
            transparency
            string->color
            color*
            color+
            color-
            color-inverse
            color-lerp

            white
            black
            red
            green
            blue
            yellow
            magenta
            cyan

            tango-light-butter
            tango-butter
            tango-dark-butter
            tango-light-orange
            tango-orange
            tango-dark-orange
            tango-light-chocolate
            tango-chocolate
            tango-dark-chocolate
            tango-light-chameleon
            tango-chameleon
            tango-dark-chameleon
            tango-light-sky-blue
            tango-sky-blue
            tango-dark-sky-blue
            tango-light-plum
            tango-plum
            tango-dark-plum
            tango-light-scarlet-red
            tango-scarlet-red
            tango-dark-scarlet-red
            tango-aluminium-1
            tango-aluminium-2
            tango-aluminium-3
            tango-aluminium-4
            tango-aluminium-5
            tango-aluminium-6

            db32-black
            db32-valhalla
            db32-loulou
            db32-oiled-cedar
            db32-rope
            db32-tahiti-gold
            db32-twine
            db32-pancho
            db32-golden-fizz
            db32-atlantis
            db32-christi
            db32-elf-green
            db32-dell
            db32-verdigris
            db32-opal
            db32-deep-koamaru
            db32-venice-blue
            db32-royal-blue
            db32-cornflower
            db32-viking
            db32-light-steel-blue
            db32-white
            db32-heather
            db32-topaz
            db32-dim-gray
            db32-smokey-ash
            db32-clairvoyant
            db32-brown
            db32-mandy
            db32-plum
            db32-stinger

            default-color-mask
            null-color-mask
            current-color-mask
            color-mask?
            color-mask-red?
            color-mask-green?
            color-mask-blue?
            color-mask-alpha?))

(define-record-type <color>
  (wrap-color bv)
  color?
  (bv unwrap-color))

(define-inlinable (color-r color)
  (f32vector-ref (unwrap-color color) 0))

(define-inlinable (color-g color)
  (f32vector-ref (unwrap-color color) 1))

(define-inlinable (color-b color)
  (f32vector-ref (unwrap-color color) 2))

(define-inlinable (color-a color)
  (f32vector-ref (unwrap-color color) 3))

(define* (make-color r g b #:optional (a 1.0))
  (wrap-color
   (f32vector
    (clamp 0.0 1.0 r)
    (clamp 0.0 1.0 g)
    (clamp 0.0 1.0 b)
    (clamp 0.0 1.0 a))))

(define* (make-color8 r g b #:optional (a 255))
  (make-color (/ r 255.0) (/ g 255.0) (/ b 255.0) (/ a 255.0)))

(define (color-component color-code offset)
  "Return the value of an 8-bit color channel in the range [0,1] for
the integer COLOR-CODE, given an OFFSET in bits."
  (let ((mask (ash #xff offset)))
    (/ (ash (logand mask color-code)
            (- offset))
       255.0)))

(define (rgba color-code)
  "Translate an RGBA format string COLOR-CODE into a color object.
For example: #xffffffff will return a color with RGBA values 1, 1, 1,
1."
  (make-color (color-component color-code 24)
              (color-component color-code 16)
              (color-component color-code 8)
              (color-component color-code 0)))

(define (rgb color-code)
  "Translate an RGB format string COLOR-CODE into a color object.
For example: #xffffff will return a color with RGBA values 1, 1, 1,
1."
  (make-color (color-component color-code 16)
              (color-component color-code 8)
              (color-component color-code 0)
              1.0))

(define (transparency alpha)
  "Create a new color that is white with a transparency value of
ALPHA.  ALPHA is clamped to the range [0, 1]."
  (make-color 1 1 1 alpha))

(define (string->color s)
  "Convert the color code string S, in a format like \"#RRGGBBAA\", to
a color object."
  (define (parse-digit i)
    (match (string-ref s i)
      (#\0 0)
      (#\1 1)
      (#\2 2)
      (#\3 3)
      (#\4 4)
      (#\5 5)
      (#\6 6)
      (#\7 7)
      (#\8 8)
      (#\9 9)
      ((or #\a #\A) 10)
      ((or #\b #\B) 11)
      ((or #\c #\C) 12)
      ((or #\d #\D) 13)
      ((or #\e #\E) 14)
      ((or #\f #\F) 15)))
  (define (parse-channel i)
    (/ (+ (* (parse-digit i) 16)
          (parse-digit (+ i 1)))
       255.0))
  ;; Support color codes with or without a "#" prefix and with or
  ;; without an alpha channel.
  (let* ((start (if (string-prefix? "#" s) 1 0))
         (alpha? (> (string-length s) (+ start 6)))
         (red (parse-channel start))
         (green (parse-channel (+ start 2)))
         (blue (parse-channel (+ start 4)))
         (alpha (if alpha?
                    (parse-channel (+ start 6))
                    1.0)))
    (make-color red green blue alpha)))

(define-inlinable (color* a b)
  (if (color? b)
      (make-color (* (color-r a) (color-r b))
                  (* (color-g a) (color-g b))
                  (* (color-b a) (color-b b))
                  (* (color-a a) (color-a b)))
      ;; Scalar multiplication.
      (make-color (* (color-r a) b)
                  (* (color-g a) b)
                  (* (color-b a) b)
                  (* (color-a a) b))))

(define-inlinable (color+ a b)
  (make-color (+ (color-r a) (color-r b))
              (+ (color-g a) (color-g b))
              (+ (color-b a) (color-b b))
              (+ (color-a a) (color-a b))))

(define-inlinable (color- a b)
  (make-color (- (color-r a) (color-r b))
              (- (color-g a) (color-g b))
              (- (color-b a) (color-b b))
              (- (color-a a) (color-a b))))

(define-inlinable (color-inverse color)
  (make-color (- 1.0 (color-r color))
              (- 1.0 (color-g color))
              (- 1.0 (color-b color))
              ;; Do not alter alpha channel.
              (color-a color)))

(define-inlinable (color-lerp start end alpha)
  (color+ (color* start (- 1.0 alpha))
          (color* end alpha)))


;;;
;;; Pre-defined Colors
;;;

;; Basic
(define white (make-color 1.0 1.0 1.0))
(define black (make-color 0.0 0.0 0.0))
(define red (make-color 1.0 0.0 0.0))
(define green (make-color 0.0 1.0 0.0))
(define blue (make-color 0.0 0.0 1.0))
(define yellow (make-color 1.0 1.0 0.0))
(define magenta (make-color 1.0 0.0 1.0))
(define cyan (make-color 0.0 1.0 1.0))

;; Tango color pallete
;; http://tango.freedesktop.org
(define tango-light-butter (rgb #xfce94f))
(define tango-butter (rgb #xedd400))
(define tango-dark-butter (rgb #xc4a000))
(define tango-light-orange (rgb #xfcaf3e))
(define tango-orange (rgb #xf57900))
(define tango-dark-orange (rgb #xce5c00))
(define tango-light-chocolate (rgb #xe9b96e))
(define tango-chocolate (rgb #xc17d11))
(define tango-dark-chocolate (rgb #x8f5902))
(define tango-light-chameleon (rgb #x8ae234))
(define tango-chameleon (rgb #x73d216))
(define tango-dark-chameleon (rgb #x4e9a06))
(define tango-light-sky-blue (rgb #x729fcf))
(define tango-sky-blue (rgb #x3465a4))
(define tango-dark-sky-blue (rgb #x204a87))
(define tango-light-plum (rgb #xad7fa8))
(define tango-plum (rgb #x75507b))
(define tango-dark-plum (rgb #x5c3566))
(define tango-light-scarlet-red (rgb #xef2929))
(define tango-scarlet-red (rgb #xcc0000))
(define tango-dark-scarlet-red (rgb #xa40000))
(define tango-aluminium-1 (rgb #xeeeeec))
(define tango-aluminium-2 (rgb #xd3d7cf))
(define tango-aluminium-3 (rgb #xbabdb6))
(define tango-aluminium-4 (rgb #x888a85))
(define tango-aluminium-5 (rgb #x555753))
(define tango-aluminium-6 (rgb #x2e3436))

;; DawnBringer 32 color palette
;; http://pixeljoint.com/forum/forum_posts.asp?TID=16247
;; Color names taken from: http://privat.bahnhof.se/wb364826/pic/db32.gpl
(define db32-black (make-color8 0 0 0))
(define db32-valhalla (make-color8 34 32 52))
(define db32-loulou (make-color8 69 40 60))
(define db32-oiled-cedar (make-color8 102 57 49))
(define db32-rope (make-color8 143 86 59))
(define db32-tahiti-gold (make-color8 223 113 38))
(define db32-twine (make-color8 217 160 102))
(define db32-pancho (make-color8 238 195 154))
(define db32-golden-fizz (make-color8 251 242 54))
(define db32-atlantis (make-color8 153 229 80))
(define db32-christi (make-color8 106 190 48))
(define db32-elf-green (make-color8 55 148 110))
(define db32-dell (make-color8 75 105 47))
(define db32-verdigris (make-color8 82 75 36))
(define db32-opal (make-color8 50 60 57))
(define db32-deep-koamaru (make-color8 63 63 116))
(define db32-venice-blue (make-color8 48 96 130))
(define db32-royal-blue (make-color8 91 110 225))
(define db32-cornflower (make-color8 99 155 255))
(define db32-viking (make-color8 95 205 228))
(define db32-light-steel-blue (make-color8 203 219 252))
(define db32-white (make-color8 255 255 255))
(define db32-heather (make-color8 155 173 183))
(define db32-topaz (make-color8 132 126 135))
(define db32-dim-gray (make-color8 105 106 106))
(define db32-smokey-ash (make-color8 89 86 82))
(define db32-clairvoyant (make-color8 118 66 138))
(define db32-brown (make-color8 172 50 50))
(define db32-mandy (make-color8 217 87 99))
(define db32-plum (make-color8 215 123 186))
(define db32-rain-forest (make-color8 143 151 74))
(define db32-stinger (make-color8 138 111 48))


;;;
;;; Color Masks
;;;

(define-record-type <color-mask>
  (make-color-mask red? green? blue? alpha?)
  color-mask?
  (red? color-mask-red?)
  (green? color-mask-green?)
  (blue? color-mask-blue?)
  (alpha? color-mask-alpha?))

(define default-color-mask (make-color-mask #t #t #t #t))
(define null-color-mask (make-color-mask #f #f #f #f))

(define (bind-color-mask mask)
  (gl-color-mask (color-mask-red? mask)
                 (color-mask-green? mask)
                 (color-mask-blue? mask)
                 (color-mask-alpha? mask)))

(define-graphics-state color-mask
  current-color-mask
  #:default default-color-mask
  #:bind bind-color-mask)