figl/gl/types.scm

   1 ;;; figl
   2 ;;; Copyright (C) 2013 Daniel Hartwig <mandyke@gmail.com>
   3 ;;;
   4 ;;; Figl is free software: you can redistribute it and/or modify it
   5 ;;; under the terms of the GNU Lesser General Public License as
   6 ;;; published by the Free Software Foundation, either version 3 of the
   7 ;;; License, or (at your option) any later version.
   8 ;;;
   9 ;;; Figl is distributed in the hope that it will be useful, but WITHOUT
  10 ;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11 ;;; or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
  12 ;;; Public License for more details.
  13 ;;;
  14 ;;; You should have received a copy of the GNU Lesser General Public
  15 ;;; License along with this program.  If not, see
  16 ;;; <http://www.gnu.org/licenses/>.
  17
  18 ;;; Commentary:
  19 ;;
  20 ;; Mappings from OpenGL to FFI types.
  21 ;;
  22 ;;; Code:
  23
  24 (define-module (figl gl types)
  25   #:use-module (figl runtime)
  26   #:use-module (rnrs bytevectors)
  27   #:use-module ((system foreign) #:renamer (symbol-prefix-proc 'ffi:))
  28   #:export (void
  29             GLboolean
  30             GLbyte
  31             GLubyte
  32             GLchar
  33             GLshort
  34             GLushort
  35             GLint
  36             GLuint
  37             GLsizei
  38             GLenum
  39             GLintptr
  40             GLsizeiptr
  41             GLbitfield
  42             GLfloat
  43             GLclampf
  44             GLdouble
  45             GLclampd
  46
  47             GLboolean-*
  48             GLbyte-*
  49             GLubyte-*
  50             GLchar-*
  51             GLshort-*
  52             GLushort-*
  53             GLint-*
  54             GLuint-*
  55             GLsizei-*
  56             GLenum-*
  57             GLfloat-*
  58             GLclampf-*
  59             GLdouble-*
  60             GLclampd-*
  61             GLvoid-*
  62             GLvoid-**
  63
  64             const-GLboolean-*
  65             const-GLbyte-*
  66             const-GLubyte-*
  67             const-GLubyte*
  68             const-GLchar-*
  69             const-GLchar-**
  70             const-GLshort-*
  71             const-GLushort-*
  72             const-GLint-*
  73             const-GLuint-*
  74             const-GLsizei-*
  75             const-GLenum-*
  76             const-GLfloat-*
  77             const-GLclampf-*
  78             const-GLdouble-*
  79             const-GLclampd-*
  80             const-GLvoid-*
  81             const-GLvoid-**
  82             void-*))
  83
  84 ;; TODO: Taken from Mesa headers for some types below.  Not clear what
  85 ;; these types are on other platforms.
  86 (define %ptr ffi:ptrdiff_t)
  87
  88 (define-simple-foreign-type void ffi:void)
  89 (define-simple-foreign-type GLboolean ffi:uint8)
  90 (define-simple-foreign-type GLbyte ffi:int8)
  91 (define-simple-foreign-type GLubyte ffi:uint8)
  92 (define-simple-foreign-type GLchar ffi:int8)
  93 (define-simple-foreign-type GLshort ffi:int16)
  94 (define-simple-foreign-type GLushort ffi:uint16)
  95 (define-simple-foreign-type GLint ffi:int32)
  96 (define-simple-foreign-type GLuint ffi:uint32)
  97 (define-simple-foreign-type GLsizei ffi:int32)
  98 (define-simple-foreign-type GLenum ffi:uint32)
  99 (define-simple-foreign-type GLintptr %ptr)
 100 (define-simple-foreign-type GLsizeiptr %ptr)
 101 (define-simple-foreign-type GLbitfield ffi:uint32)
 102 (define-simple-foreign-type GLfloat ffi:float)
 103 (define-simple-foreign-type GLclampf ffi:float)
 104 (define-simple-foreign-type GLdouble ffi:double)
 105 (define-simple-foreign-type GLclampd ffi:double)
 106 (define-simple-foreign-type GLvoid-* '*)
 107 (define-simple-foreign-type void-* '*)
 108 (define-simple-foreign-type const-GLvoid-* '*)
 109
 110 (define (coerce-array-pointer x)
 111   (cond
 112    ((ffi:pointer? x)
 113     x)
 114    ((bytevector? x)
 115     (ffi:bytevector->pointer x))
 116    ;; TODO: (typed-array? x element-type)
 117    ((not x)
 118     ffi:%null-pointer)
 119    (else
 120     (error "unhandled array-pointer type" x))))
 121
 122 (define-syntax define-array-foreign-type
 123   (syntax-rules ()
 124     ((_ name element-type)
 125      (define-foreign-type name '*
 126        coerce-array-pointer
 127        (lambda (x) x)))))
 128
 129 (define-array-foreign-type GLboolean-* GLboolean)
 130 (define-array-foreign-type GLbyte-* GLbyte)
 131 (define-array-foreign-type GLubyte-* GLubyte)
 132 (define-array-foreign-type GLchar-* GLchar)
 133 (define-array-foreign-type GLshort-* GLshort)
 134 (define-array-foreign-type GLushort-* GLushort)
 135 (define-array-foreign-type GLint-* GLint)
 136 (define-array-foreign-type GLuint-* GLuint)
 137 (define-array-foreign-type GLsizei-* GLsizei)
 138 (define-array-foreign-type GLenum-* GLenum)
 139 (define-array-foreign-type GLfloat-* GLfloat)
 140 (define-array-foreign-type GLclampf-* GLclampf)
 141 (define-array-foreign-type GLdouble-* GLdouble)
 142 (define-array-foreign-type GLclampd-* GLclampd)
 143
 144 (define-array-foreign-type const-GLboolean-* GLboolean)
 145 (define-array-foreign-type const-GLbyte-* GLbyte)
 146 (define-array-foreign-type const-GLubyte-* GLubyte)
 147 (define-array-foreign-type const-GLshort-* GLshort)
 148 (define-array-foreign-type const-GLushort-* GLushort)
 149 (define-array-foreign-type const-GLint-* GLint)
 150 (define-array-foreign-type const-GLuint-* GLuint)
 151 (define-array-foreign-type const-GLsizei-* GLsizei)
 152 (define-array-foreign-type const-GLenum-* GLenum)
 153 (define-array-foreign-type const-GLfloat-* GLfloat)
 154 (define-array-foreign-type const-GLclampf-* GLclampf)
 155 (define-array-foreign-type const-GLdouble-* GLdouble)
 156 (define-array-foreign-type const-GLclampd-* GLclampd)
 157 (define-array-foreign-type const-GLvoid-* GLvoid)
 158
 159 (define-foreign-type const-GLchar-* '*
 160   ffi:string->pointer
 161   ffi:pointer->string)
 162
 163 ;; Functions with these types will need special help.
 164 (define-simple-foreign-type GLvoid-** '*)
 165 (define-simple-foreign-type const-GLchar-** '*)
 166 (define-simple-foreign-type const-GLvoid-** '*)
 167
 168 ;; TODO: Hacked for a typo in glGetString.xml.
 169 (define-array-foreign-type const-GLubyte* GLubyte)