path: root/sdl2/render.scm

;;; guile-sdl2 --- FFI bindings for SDL2
;;; Copyright © 2015 David Thompson <davet@gnu.org>
;;; Copyright © 2019 Pierre-Antoine Rouby <contact@parouby.fr>
;;;
;;; This file is part of guile-sdl2.
;;;
;;; Guile-sdl2 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-sdl2 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 Lesser General Public
;;; License along with guile-sdl2.  If not, see
;;; <http://www.gnu.org/licenses/>.

;;; Commentary:
;;
;; SDL 2D accelerated rendering.
;;
;;; Code:

(define-module (sdl2 render)
  #:use-module (ice-9 format)
  #:use-module (ice-9 match)
  #:use-module (system foreign)
  #:use-module (rnrs bytevectors)
  #:use-module (sdl2)
  #:use-module ((sdl2 bindings) #:prefix ffi:)
  #:export (make-renderer
            renderer?
            delete-renderer!
            call-with-renderer
            clear-renderer
            present-renderer
            renderer-logical-size
            renderer-scale
            renderer-integer-scale
            renderer-viewport
            renderer-target
            set-renderer-logical-size!
            set-renderer-scale!
            set-renderer-integer-scale!
            set-renderer-viewport!
            set-renderer-target!
            set-renderer-draw-color!
            set-renderer-draw-blend-mode!

            render-copy
            draw-line
            draw-lines
            draw-point
            draw-points
            draw-rect
            draw-rects
            render-fill-rect
            render-fill-rects

            texture-color-mod
            texture-alpha-mod
            set-texture-color-mod!
            set-texture-alpha-mod!
            set-texture-blend-mode!

            make-texture
            update-texture
            delete-texture!
            surface->texture
            query-texture))


;;;
;;; Renderer
;;;

(define-wrapped-pointer-type <renderer>
  renderer?
  wrap-renderer unwrap-renderer
  (lambda (context port)
    (format port "#<renderer ~x>"
            (pointer-address (unwrap-renderer context)))))

(define (renderer-flags->bitmask flags)
  (apply logior
         (map (match-lambda
                ('software    ffi:SDL_RENDERER_SOFTWARE)
                ('accelerated ffi:SDL_RENDERER_ACCELERATED)
                ('vsync       ffi:SDL_RENDERER_PRESENTVSYNC)
                ('texture     ffi:SDL_RENDERER_TARGETTEXTURE))
              flags)))

(define* (make-renderer window #:optional (flags '(accelerated vsync)))
  "Return a new renderer for WINDOW created with the options specified
in FLAGS, a list of symbols.  The valid symbols that may appear in
FLAGS are:

* software, to use a software renderer fallback
* accelerated, to use hardware acceleration
* vsync, to synchronize rendering with the monitor's refresh rate
* texture, for render to texture support"
  (let ((ptr (ffi:sdl-create-renderer ((@@ (sdl2 video) unwrap-window)
                                       window)
                                      -1 ; pick driver automatically
                                      (renderer-flags->bitmask flags))))
    (if (null-pointer? ptr)
        (sdl-error "make-renderer" "failed to create renderer")
        (wrap-renderer ptr))))

(define (delete-renderer! renderer)
  "Delete the rendering context RENDERER."
  (ffi:sdl-destroy-renderer (unwrap-renderer renderer)))

(define (call-with-renderer renderer proc)
  "Call PROC, passing it RENDERER and closing RENDERER upon exit of
PROC."
  (dynamic-wind
    (const #t)
    (lambda ()
      (proc renderer))
    (lambda ()
      (delete-renderer! renderer))))

(define (clear-renderer renderer)
  "Clear the rendering target RENDERER with the current drawing
color."
  (unless (zero? (ffi:sdl-render-clear (unwrap-renderer renderer)))
    (sdl-error "clear-renderer!" "failed to clear renderer")))

(define (present-renderer renderer)
  "Display RENDERER."
  (ffi:sdl-render-present (unwrap-renderer renderer)))

(define (renderer-logical-size renderer)
  "Return the logical size used by RENDERER."
  (let ((bv (make-bytevector (* 2 (sizeof int)) 0)))
    (ffi:sdl-render-get-logical-size (unwrap-renderer renderer)
                                     (bytevector->pointer bv)
                                     (bytevector->pointer (sizeof int)))
    (values (bytevector-sint-ref bv 0 (native-endianness) (sizeof int))
            (bytevector-sint-ref bv (sizeof int) (native-endianness) (sizeof int)))))

(define (set-renderer-logical-size! renderer width height)
  "Set the logical size of RENDERER to WIDTH x HEIGHT."
  (unless (zero? (ffi:sdl-render-set-logical-size
                  (unwrap-renderer renderer)
                  width height))
    (sdl-error "set-renderer-logical-size!" "Failed to set logical size")))

(define (renderer-scale renderer)
  "Return the scale used by RENDERER."
  (let ((bv (make-bytevector (* 2 (sizeof float)) 0)))
    (ffi:sdl-render-get-scale (unwrap-renderer renderer)
                              (bytevector->pointer bv)
                              (bytevector->pointer bv (sizeof float)))
    (values (bytevector-ieee-single-native-ref bv 0)
            (bytevector-ieee-single-native-ref bv (sizeof float)))))

(define (set-renderer-scale! renderer scale-x scale-y)
  "Set the drawing scale of RENDERER according to SCALE-X and SCALE-Y
scaling factors."
  (unless (zero? (ffi:sdl-render-set-scale (unwrap-renderer renderer)
                                           scale-x scale-y))
    (sdl-error "set-renderer-scale!" "Failed to set scale")))

(define (renderer-integer-scale renderer)
  "Returns #t if integer scaling is forced on RENDERER."
  (not
   (zero?
    (ffi:sdl-render-get-integer-scale
     (unwrap-renderer renderer)))))

(define (set-renderer-integer-scale! renderer enabled?)
  "If ENABLED? is #t, enable integer scaling for RENDERER, otherwise
disable it."
  (unless (zero? (ffi:sdl-render-set-integer-scale
                  (unwrap-renderer renderer)
                  (ffi:boolean->sdl-bool enabled?)))
    (sdl-error "set-renderer-integer-scale!" "Failed to set integer scale")))

(define (renderer-viewport renderer)
  "Return the drawing area used by RENDERER."
  (let ((rect ((@@ (sdl2 rect) make-rect) 0 0 0 0)))
    (ffi:sdl-render-get-viewport (unwrap-renderer renderer)
                                 ((@@ (sdl2 rect) unwrap-rect) rect))
    rect))

(define (set-renderer-viewport! renderer rect)
  "Set the drawing area for RENDERER to RECT."
  (unless (zero? (ffi:sdl-render-set-viewport
                  (unwrap-renderer renderer)
                  (if rect
                      ((@@ (sdl2 rect) unwrap-rect) rect)
                      %null-pointer)))
    (sdl-error "set-renderer-viewport!" "Failed to set viewport")))

(define (set-renderer-draw-blend-mode! renderer blend-mode)
  "Set blend mode of RENDERER to BLEND-MODE."
  (ffi:sdl-set-render-draw-blend-mode
   (unwrap-renderer renderer)
   ((@@ (sdl2 blend-mode) blend-mode-bitmask) blend-mode)))

(define (set-renderer-draw-color! renderer r g b a)
  "Set draw color of RENDERER."
  (ffi:sdl-set-render-draw-color (unwrap-renderer renderer) r g b a))

(define (draw-line renderer x1 y1 x2 y2)
  "Draw line on RENDERER."
  (ffi:sdl-render-draw-line (unwrap-renderer renderer) x1 y1 x2 y2))

(define (draw-rect renderer rect)
  "Draw RECT on RENDERER."
  (ffi:sdl-render-draw-rect
   (unwrap-renderer renderer)
   (if rect
       ((@@ (sdl2 rect) unwrap-rect) rect)
       %null-pointer)))

(define (draw-point renderer x y)
  "Draw point on RENDERER."
  (ffi:sdl-render-draw-point (unwrap-renderer renderer) x y))

(define *pointer-cache* (make-weak-key-hash-table))

(define (bytevector->pointer/cached bv)
  (or (hashq-ref *pointer-cache* bv)
      (let ((ptr (bytevector->pointer bv)))
        (hashq-set! *pointer-cache* bv ptr)
        ptr)))

(define (build-point-bv points)
  (let ((bv (make-s32vector (* (length points) 2))))
    (let loop ((points points)
               (i 0))
      (match points
        (() bv)
        (((x y) . rest)
         (s32vector-set! bv (* i 2) x)
         (s32vector-set! bv (+ (* i 2) 1) y)
         (loop rest (+ i 1)))))))

(define (draw-lines renderer points)
  "Draw lines connecting POINTS on RENDERER."
  (if (bytevector? points)
      (ffi:sdl-render-draw-lines (unwrap-renderer renderer)
                                 (bytevector->pointer/cached points)
                                 (/ (bytevector-length points) 8))
      (let ((bv (build-point-bv points)))
        (ffi:sdl-render-draw-lines (unwrap-renderer renderer)
                                   (bytevector->pointer bv)
                                   (length points)))))

(define (draw-points renderer points)
  "Draw POINTS on RENDERER."
  (if (bytevector? points)
      (ffi:sdl-render-draw-points (unwrap-renderer renderer)
                                  (bytevector->pointer/cached points)
                                  (/ (bytevector-length points) 8))
      (let ((bv (build-point-bv points)))
        (ffi:sdl-render-draw-points (unwrap-renderer renderer)
                                    (bytevector->pointer bv)
                                    (length points)))))

(define (build-rect-bv rects)
  (let* ((count (length rects))
         (bv (make-s32vector (* count 4))))
    (for-each (lambda (rect i)
                (bytevector-copy! ((@@ (sdl2 rect) rect-bv) rect) 0
                                  bv (* i 4 4) (* 4 4)))
              rects (iota count))
    bv))

(define (draw-rects renderer rects)
  "Draw RECTS on RENDERER."
  (if (bytevector? rects)
      (ffi:sdl-render-draw-rects (unwrap-renderer renderer)
                                 (bytevector->pointer/cached rects)
                                 (/ (bytevector-length rects) 16))
      (let ((bv (build-rect-bv rects)))
        (ffi:sdl-render-draw-rects (unwrap-renderer renderer)
                                   (bytevector->pointer bv)
                                   (length rects)))))

(define (render-fill-rect renderer rect)
  "Fill RECT on RENDERER."
  (ffi:sdl-render-fill-rect
   (unwrap-renderer renderer)
   (if rect
       ((@@ (sdl2 rect) unwrap-rect) rect)
       %null-pointer)))

(define (render-fill-rects renderer rects)
  "Fill RECTS on RENDERER."
  (if (bytevector? rects)
      (ffi:sdl-render-fill-rects (unwrap-renderer renderer)
                                 (bytevector->pointer/cached rects)
                                 (/ (bytevector-length rects) 16))
      (let ((bv (build-rect-bv rects)))
        (ffi:sdl-render-fill-rects (unwrap-renderer renderer)
                                   (bytevector->pointer bv)
                                   (length rects)))))


;;;
;;; Texture
;;;

(define-wrapped-pointer-type <texture>
  texture?
  wrap-texture unwrap-texture
  (lambda (context port)
    (format port "#<texture ~x>"
            (pointer-address (unwrap-texture context)))))

(define (make-texture renderer format access width height)
  "Returns a new texture for RENDERER with pixel FORMAT.
ACCESS is one of the symbols:

* static: changes rarely, not lockable
* streaming: changes frequently, lockable
* target: can be used as a render target (requires that renderer was
created with 'texture')"
  (let ((ptr (ffi:sdl-create-texture (unwrap-renderer renderer)
                                     ((@@ (sdl2 surface) symbol->sdl-pixel-format) format)
                                     (match access
                                       ('static    ffi:SDL_TEXTUREACCESS_STATIC)
                                       ('streaming ffi:SDL_TEXTUREACCESS_STREAMING)
                                       ('target    ffi:SDL_TEXTUREACCESS_TARGET))
                                     width height)))
    (if (null-pointer? ptr)
        (sdl-error "make-texture" "Failed to create texture")
        (wrap-texture ptr))))

(define (update-texture texture rect pixels pitch)
  "Update the subsection of TEXTURE defined by RECT with new pixel
data in the PIXELS bytevector.  PITCH represents the number of bytes
in a row of pixel data, including any padding between rows.  This is a
fairly slow process: Better to use the lock/unlock mechanism in
streaming textures."
  (let ((ret (ffi:sdl-update-texture
                (unwrap-texture texture)
                ((@@ (sdl2 rect) unwrap-rect) rect)
                (bytevector->pointer pixels)
                pitch)))
    (if (> 0 ret)
      (sdl-error "update-texture" "failed to update texture")
      ret)))

(define (surface->texture renderer surface)
  "Convert SURFACE to a texture suitable for RENDERER."
  (let ((ptr (ffi:sdl-create-texture-from-surface
              (unwrap-renderer renderer)
              ((@@ (sdl2 surface) unwrap-surface) surface))))
    (if (null-pointer? ptr)
        (sdl-error "surface->texture" "failed to convert surface to texture")
        (wrap-texture ptr))))

(define (delete-texture! texture)
  "Free the memory used by TEXTURE."
  (ffi:sdl-destroy-texture (unwrap-texture texture)))

(define (query-texture texture)
  "Return 4 values for the format, access, width and height of
TEXTURE."
  (let ((bv (make-bytevector (+ (sizeof uint32)
                                (* 3 (sizeof int)))
                             0)))
    (unless (zero?
             (ffi:sdl-query-texture
              (unwrap-texture texture)
              (bytevector->pointer bv)
              (bytevector->pointer bv (sizeof uint32))
              (bytevector->pointer bv (+ (sizeof uint32) (sizeof int)))
              (bytevector->pointer bv (+ (sizeof uint32) (* 2 (sizeof int))))))
      (sdl-error "query-texture" "Failed to query texture"))
    (values
     (match (bytevector-uint-ref bv 0 (native-endianness) (sizeof uint32))
       (ffi:SDL_PIXELFORMAT_INDEX1LSB 'index1lsb)
       (ffi:SDL_PIXELFORMAT_INDEX1MSB 'index1msb)
       (ffi:SDL_PIXELFORMAT_INDEX4LSB 'index4lsb)
       (ffi:SDL_PIXELFORMAT_INDEX4MSB 'index4msb)
       (ffi:SDL_PIXELFORMAT_INDEX8 'index8)
       (ffi:SDL_PIXELFORMAT_RGB332 'rgb332)
       (ffi:SDL_PIXELFORMAT_RGB444 'rgb444)
       (ffi:SDL_PIXELFORMAT_RGB555 'rgb555)
       (ffi:SDL_PIXELFORMAT_BGR555 'bgr555)
       (ffi:SDL_PIXELFORMAT_ARGB4444 'argb4444)
       (ffi:SDL_PIXELFORMAT_RGBA4444 'rgba4444)
       (ffi:SDL_PIXELFORMAT_ABGR4444 'abgr4444)
       (ffi:SDL_PIXELFORMAT_BGRA4444 'bgra4444)
       (ffi:SDL_PIXELFORMAT_ARGB1555 'argb1555)
       (ffi:SDL_PIXELFORMAT_RGBA5551 'rgba5551)
       (ffi:SDL_PIXELFORMAT_ABGR1555 'abgr1555)
       (ffi:SDL_PIXELFORMAT_BGRA5551 'bgra5551)
       (ffi:SDL_PIXELFORMAT_RGB565 'rgb565)
       (ffi:SDL_PIXELFORMAT_BGR565 'bgr565)
       (ffi:SDL_PIXELFORMAT_RGB24 'rgb24)
       (ffi:SDL_PIXELFORMAT_BGR24 'bgr24)
       (ffi:SDL_PIXELFORMAT_RGB888 'rgb888)
       (ffi:SDL_PIXELFORMAT_RGBX8888 'rgbx8888)
       (ffi:SDL_PIXELFORMAT_BGR888 'bgr888)
       (ffi:SDL_PIXELFORMAT_BGRX8888 'bgrx8888)
       (ffi:SDL_PIXELFORMAT_ARGB8888 'argb8888)
       (ffi:SDL_PIXELFORMAT_RGBA8888 'rgba8888)
       (ffi:SDL_PIXELFORMAT_ABGR8888 'abgr8888)
       (ffi:SDL_PIXELFORMAT_BGRA8888 'bgra8888)
       (ffi:SDL_PIXELFORMAT_ARGB2101010 'argb2101010)
       (ffi:SDL_PIXELFORMAT_YV12 'yv12)
       (ffi:SDL_PIXELFORMAT_IYUV 'iyuv)
       (ffi:SDL_PIXELFORMAT_YUY2 'yuy2)
       (ffi:SDL_PIXELFORMAT_UYVY 'uyvy)
       (ffi:SDL_PIXELFORMAT_YVYU 'yvyu))
     (match (bytevector-uint-ref bv (sizeof int) (native-endianness) (sizeof int))
       (ffi:SDL_TEXTUREACCESS_STATIC    'static)
       (ffi:SDL_TEXTUREACCESS_STREAMING 'streaming)
       (ffi:SDL_TEXTUREACCESS_TARGET    'target))
     (bytevector-uint-ref bv (* 2 (sizeof int)) (native-endianness) (sizeof int))
     (bytevector-uint-ref bv (* 3 (sizeof int)) (native-endianness) (sizeof int)))))

(define (set-texture-blend-mode! texture blend-mode)
  (unless (zero? (ffi:sdl-set-texture-blend-mode
                  (unwrap-texture texture)
                  ((@@ (sdl2 blend-mode) blend-mode-bitmask) blend-mode)))
    (sdl-error "set-texure-blend-mode!" "Failed to set texture blend mode")))

(define (set-texture-color-mod! texture r g b)
  "Get color mod of TEXTURE as a list of the integers."
  (unless (zero? (ffi:sdl-set-texture-color-mod (unwrap-texture texture) r g b))
    (sdl-error "set-texture-color-mod!" "Failed to set texture color mod")))

(define (set-texture-alpha-mod! texture a)
  "Sets alpha mod of TEXTURE."
  (unless (zero? (ffi:sdl-set-texture-alpha-mod (unwrap-texture texture) a))
    (sdl-error "set-texture-alpha-mod!" "Failed to set texture alpha mod")))

(define (texture-alpha-mod texture)
  "Get alpha mod of TEXTURE as a single integer."
  (let ((bv (make-bytevector 1)))
    (let ((result (ffi:sdl-get-texture-alpha-mod
                   (unwrap-texture texture)
                   (bytevector->pointer bv 0))))
      (unless (zero? result)
        (sdl-error "get-texture-alpha-mod" "Failed to get texture allpha mod"))

      (bytevector-u8-ref bv 0))))

(define (texture-color-mod texture)
  "Get color mod of TEXTURE as a list of the integers."
  (let ((bv (make-bytevector 3)))
    (let ((result (ffi:sdl-get-texture-color-mod
                   (unwrap-texture texture)
                   (bytevector->pointer bv 0)
                   (bytevector->pointer bv 1)
                   (bytevector->pointer bv 2))))
      (unless (zero? result)
        (sdl-error "get-texture-color-mod" "Failed to get texture color mod"))
      (bytevector->u8-list bv))))

(define* (render-copy renderer texture
                      #:key (angle 0) srcrect dstrect center)
  "Copy TEXTURE to the rendering target of RENDERER."
  (let ((result (ffi:sdl-render-copy-ex
                 (unwrap-renderer renderer)
                 (unwrap-texture texture)
                 (if srcrect
                     ((@@ (sdl2 rect) unwrap-rect) srcrect)
                     %null-pointer)
                 (if dstrect
                     ((@@ (sdl2 rect) unwrap-rect) dstrect)
                     %null-pointer)
                 angle
                 (if center
                     ((@@ (sdl2 rect) unwrap-rect) center)
                     %null-pointer)
                 0)))
    (unless (zero? result)
      (sdl-error "render-copy" "failed to copy texture"))))

(define (set-renderer-target! renderer texture)
  "Sets the render target for RENDERER to TEXTURE, making all comming draw
requests redirect to TEXTURE.

Pass #f to reset it to the default target."
  (let ((result (ffi:sdl-set-render-target
          (unwrap-renderer renderer)
          (if texture
              (unwrap-texture texture)
              %null-pointer))))
    (unless (zero? result)
      (sdl-error "set-render-target!" "failed to set render target"))))

(define (renderer-target renderer)
  "Returns the current render target of RENDERER. #f if it's a texture."
  (let ((ptr (ffi:sdl-get-render-target (unwrap-renderer renderer))))
    (if (null-pointer? ptr)
        #f (wrap-texture ptr))))