summaryrefslogtreecommitdiff
path: root/2d/sprite.scm
blob: e6dd3aefe245b07a45d4d784ef4f6c13e08274a6 (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
;;; guile-2d
;;; Copyright (C) 2013 David Thompson <dthompson2@worcester.edu>
;;;
;;; Guile-2d is free software: you can redistribute it and/or modify it
;;; under the terms of the GNU Lesser General Public License as
;;; published by the Free Software Foundation, either version 3 of the
;;; License, or (at your option) any later version.
;;;
;;; Guile-2d 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
;;; Lesser General Public License for more details.
;;;
;;; You should have received a copy of the GNU Lesser General Public
;;; License along with this program.  If not, see
;;; <http://www.gnu.org/licenses/>.

;;; Commentary:
;;
;; Sprites are typically the most important part of a 2D game. This
;; module provides sprites as an abstraction around OpenGL textures.
;;
;;; Code:

(define-module (2d sprite)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-9)
  #:use-module (figl gl)
  #:use-module (figl contrib packed-struct)
  #:use-module ((sdl sdl) #:prefix SDL:)
  #:use-module (2d agenda)
  #:use-module (2d animation)
  #:use-module (2d color)
  #:use-module (2d config)
  #:use-module (2d game)
  #:use-module (2d helpers)
  #:use-module (2d math)
  #:use-module (2d shader)
  #:use-module (2d signal)
  #:use-module (2d texture)
  #:use-module (2d vector2)
  #:use-module (2d window)
  #:use-module (2d wrappers gl)
  #:export (make-sprite
            sprite?
            animated-sprite?
            sprite-drawable
            sprite-position
            set-sprite-drawable!
            set-sprite-position!
            set-sprite-scale!
            set-sprite-rotation!
            set-sprite-color!
            set-sprite-anchor!
            sprite-scale
            sprite-rotation
            sprite-color
            sprite-anchor
            load-sprite
            draw-sprite))

;;;
;;; Sprites
;;;

(define sprite-shader
  (make-shader-program
   (load-vertex-shader (string-append %pkgdatadir
                                      "/shaders/sprite-vertex.glsl"))
   (load-fragment-shader (string-append %pkgdatadir
                                        "/shaders/sprite-fragment.glsl"))))

;; The <sprite> type represents a drawable object (texture,
;; texture-region, animation, etc.) with a given position, scale,
;; rotation, and color.
(define-record-type <sprite>
  (%make-sprite drawable position scale rotation color anchor vertices animator)
  sprite?
  (drawable sprite-drawable set-sprite-drawable!)
  (position sprite-position set-sprite-position!)
  (scale sprite-scale set-sprite-scale!)
  (rotation sprite-rotation set-sprite-rotation!)
  (color sprite-color set-sprite-color!)
  (anchor sprite-anchor %set-sprite-anchor!)
  (vertices sprite-vertices)
  (animator sprite-animator))

(define (update-sprite-vertices! sprite)
  (let ((texture (sprite-texture sprite)))
    (pack-texture-vertices (sprite-vertices sprite)
                           0
                           (texture-width texture)
                           (texture-height texture)
                           (texture-s1 texture)
                           (texture-t1 texture)
                           (texture-s2 texture)
                           (texture-t2 texture))))

(define* (make-sprite drawable #:optional #:key
                      (position (vector2 0 0)) (scale (vector2 1 1))
                      (rotation 0) (color white) (anchor 'center))
  "Create a new sprite object. DRAWABLE is either a texture or
animation object.  All keyword arguments are optional. POSITION is a
vector2 object with a default of (0, 0).  SCALE is a vector2 object
that describes how much DRAWABLE should be strected on the x and y
axes, with a default of 1x scale.  ROTATION is an angle in degrees
with a default of 0.  COLOR is a color object with a default of white.
ANCHOR is either a vector2 that represents the center point of the
sprite, or 'center which will place the anchor at the center of
DRAWABLE.  Sprites are centered by default."
  (let* ((vertices (make-packed-array texture-vertex 4))
         (animator (if (animation? drawable)
                       (make-animator drawable)
                       #f))
         (anchor (anchor-texture (drawable-texture drawable animator) anchor))
         (sprite (%make-sprite drawable position scale rotation color
                               anchor vertices animator)))
    (update-sprite-vertices! sprite)
    sprite))

(define* (load-sprite filename #:optional #:key
                      (position (vector2 0 0)) (scale (vector2 1 1))
                      (rotation 0) (color white) (anchor 'center))
  "Load a sprite from the file at FILENAME. See make-sprite for
optional keyword arguments."
  (make-sprite (load-texture filename)
               #:position position
               #:scale scale
               #:rotation rotation
               #:color color
               #:anchor anchor))

(define (animated-sprite? sprite)
  "Return #t if SPRITE has an animation as its drawable object."
  (animation? (sprite-drawable sprite)))

(define (drawable-texture drawable animator)
  (cond ((texture? drawable)
         drawable)
        ((animation? drawable)
         (animator-texture animator))))

(define (sprite-texture sprite)
  "Return the texture for the SPRITE's drawable object."
  (let ((drawable (sprite-drawable sprite)))
    (drawable-texture (sprite-drawable sprite)
                      (sprite-animator sprite))))

(define (set-sprite-anchor! sprite anchor)
  (%set-sprite-anchor! sprite (anchor-texture (sprite-texture sprite) anchor)))

(define (update-sprite-animator! sprite)
  (animator-update! (sprite-animator sprite))
  (update-sprite-vertices! sprite))

(define (draw-sprite sprite)
  "Render SPRITE to the screen. A sprite batch will be used if one is
currently bound."
  (register-animated-sprite-maybe sprite)
  (with-shader-program sprite-shader
    (uniforms ((position (sprite-position sprite))
               (anchor (sprite-anchor sprite))
               (scale (sprite-scale sprite))
               (rotation (sprite-rotation sprite))
               (color (sprite-color sprite))
               (projection (signal-ref window-projection)))
      (draw-texture-vertices (sprite-texture sprite)
                             (sprite-vertices sprite)
                             1))))

;; A hash table for all of the animated sprites that have been drawn
;; since the last game update.  It is cleared after every game-agenda
;; tick.
(define animated-sprites (make-hash-table))

(define (register-animated-sprite-maybe sprite)
  (when (animated-sprite? sprite)
    (hash-set! animated-sprites sprite sprite)))

(define (update-animated-sprites!)
  "Update all animators for sprites that have been drawn this frame."
  (hash-for-each (lambda (key val)
                   (update-sprite-animator! val))
                 animated-sprites)
  (hash-clear! animated-sprites))

;; Update animated sprites upon every update.
(schedule-each game-agenda update-animated-sprites!)