The 3bgl-shader Reference Manual

Table of Contents

The 3bgl-shader Reference Manual

This is the 3bgl-shader Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:41:29 2018 GMT+0.

1 Introduction

3bgl-shader: a Common Lisp DSL for generating GLSL shaders

Features

• looks more-or-less like CL
• type inference
• hooks for interactive use
• automatic overloaded functions

Minimal Example shader program

Just transform the vertex, and send color to be interpolated. (More examples can be found here.)

;; define a package for the shader functions, :USEing :3BGL-GLSL/CL
(cl:defpackage #:shader
  (:use :3bgl-glsl/cl)
(cl:in-package #:shader)

;; vertex attributes, need to specify types for all 'external'
;; interfaces and globals (inputs, outputs, uniforms, varyings)
(input position :vec4 :location 0)
(input color :vec4 :location 1)

;; final output
(output out-color :vec4 :stage :fragment)

;; model-view-projection matrix
(uniform mvp :mat4)

;; interface between vertex and fragment shader
(interface varyings (:out (:vertex outs)
                     :in (:fragment ins))
  (color :vec4))

;; vertex shader (names are arbitrary)
(defun vertex ()
  (setf (@ outs color) color
        gl-position (* mvp position)))

;; fragment shader
(defun boring-fragment ()
  (setf out-color (@ ins color)))

 ;; not quite CL:defconstant, need to specify a type
(defconstant +scale+ 2.0 :float)
;; a helper function
(defun invert-and-scale (x)
  ;; RETURN is GLSL return rather than CL:RETURN, and is required for
  ;; functions that return a value
  (return (* +scale+ (- 1 x))))

;; an alternate fragment shader
(defun inverted-fragment ()
  (setf out-color (invert-and-scale (@ ins color))))

Convert to glsl

(3bgl-shaders:generate-stage :vertex 'shader::vertex)
(3bgl-shaders:generate-stage :fragment 'shader::boring-fragment)
(3bgl-shaders:generate-stage :fragment 'shader::inverted-fragment)

results:

// vertex shader:
#version 450
out varyings {
  vec4 color;
} outs;

layout(location = 1) in vec4 color;

uniform mat4 mvp;

layout(location = 0) in vec4 position;

void main () {
  outs.color = color;
  gl_Position = (mvp * position);
}

// boring fragment shader:
#version 450
out vec4 outColor;

in varyings {
  vec4 color;
} ins;

void main () {
  outColor = ins.color;
}

// inverted fragment shader
#version 450
out vec4 outColor;

const float SCALE = 2.0;
in varyings {
  vec4 color;
} ins;

vec4 invertAndScale (vec4 x) {
  return (SCALE * (1 - x));
}

void main () {
  outColor = invertAndScale(ins.color);
}

Hooks for interactive use

Programs using 3bgl-shader can add a function to 3bgl-shaders::*modified-function-hook*, which will be called when shader functions are redefined. It will be passed a list of names of updated functions. For example in the shaders above, if the (defconstant +scale+ 2.0 :float) form were recompiled in slime with C-c C-c, the hook functions would be passed the list (SHADER::INVERTED-FRAGMENT SHADER::INVERT-AND-SCALE) since invert-and-scale depends on the constant, and inverted-fragment depends on the function invert-and-scale. The hook function could then see one of the fragment shaders it is using had been modified, and arrange for a running program to try to recompile the shader program next frame.

Current status

The compiler and type inference mostly work, including some fairly complicated shaders.

Built-in functions/types/variables from glsl version 4.50 are available, and older versions might work to the extent they are compatible with the subset of 4.50 used in a particular shader. The type inference doesn't distinguish between versions, so might allow casts that wouldn't be valid in an older version.

Error messages are mostly horrible, so most type inference failures will give incomprehensible errors.

CL style type declarations are allowed and should mostly be respected.

API isn't completely finished, so some parts may change (in particular the base types like :vec3 may be renamed to 3bgl-glsl:vec3 at some point.)

The external API needs more work, in particular some way to query uniforms, inputs, outputs, etc.

Currently no way to translate line/column numbers from glsl error messages back to source.

Performance is acceptable for shaders I've tested it on, but not sure how it scales. It currently WARNs if it takes more than 2000 passes for type inference, which may need adjusted or disabled for larger shaders.

Currently all functions that depend on a function/global will be recompiled when things they depend on are recompiled, which can make changing function signatures or types difficult if they aren't compatible with the uses.

Recompilation may be more aggressive than it needs to be, for example if the value of a constant is changed, it shouldn't need to re-run type inference of functions that use that constant if the type didn't change.

Dependencies on uniforms are sometimes missed, dumping a bare reference to it in main function is a simple workaround.

Misc notes

Concrete types

GLSL types are currently named with keywords (though that may change in the future), like :vec2, :vec3, :vec4, :mat2x4, :sampler-2d-array-shadow etc. see the source for details for now, though most are fairly obvious.

Component swizzles

Components of GLSL vector types like :vec4 can be accessed with 'swizzle' functions like .xyz, so for example glsl someVec.rraa would be (.rraa some-vec). Type inference should correctly use the swizzle to determine minimum size of the vector if not specified.

Structure/interface slots

(@ var slot-name) is a shortcut for (slot-value var 'slot-name), and either will compile to var.slot. GLSL doesn't allow specifying a slot through a variable, so slot name must be a quoted compile-time literal.

RETURN

Functions are required to use RETURN to return values, they will not return the value of the last form as in CL. A function without a RETURN will have a void return type. (return (values)) can also be used to force a void return type, and for early exit from a void function.

Overloaded functions

If a function doesn't have a specific derived or specified type, it can be used with any compatible types, and the generated GLSL will have a version for each type.

For example the previous code could have had

 ;; X can be any type that works with scalar `*` and `-`
(defun invert-and-scale (x)
  (return (* +scale+ (- 1 x))))

(defun inverted-fragment ()
  (setf out-color (+ (invert-and-scale 1) ;; call 'int' version
                     (invert-and-scale (@ ins color))))) ;; call 'vec4' version

which would generate the glsl code

#version 450
out vec4 outColor;

const float SCALE = 2.0;
in varyings {
  vec4 color;
} ins;

// returns a vec4 because the input is vec4
vec4 invertAndScale (vec4 x) {
  return (SCALE * (1 - x));
}

// returns float because SCALE is a float
float invertAndScale (int x) {
  return (SCALE * (1 - x));
}

void main () {
  outColor = (invertAndScale(1) + invertAndScale(ins.color));
}

Type declarations

CL-style type declarations are allowed, and should interact correctly with type inference.

for example

(defun foo (x y)
  (declare (values :float) (:float x))
  (let ((a (+ x y)))
     (declare (:vec2 a))
     (return (.x a))))

specifies that foo returns a float, the first argument is also specified to be float, while the second isn't explicitly restricted. The local variable A is specified to be a vec2, which implicitly restricts Y to also be something that casts to vec2.

(declare (values)) can be used to explicitly specify void return type for a function.

Uniforms, input, output, interface

Uniforms are specified with (UNIFORM name type &key stage location layout qualifiers).
:stage specifies in which shader stages (:vertex,:fragment etc) the uniform is visible (by default the uniform is visible in all stages, though will only be included in generated GLSL for stages in which it is referenced).
:location N is a shortcut for specifying the location layout qualifier.
:layout (...) allows specifying arbitrary layout qualifiers, argument is a plist containing qualifier and value (specify value = t for qualifiers that don't take arguments) :qualifiers (...) allows specifying other qualifiers like restrict, argument is a list of qualifiers.

;; a simple 'int' uniform, location chosen by driver or GL side of API
(uniform flag :int)
;; -> uniform int flag;

;; an image2D uniform, with format, location and `restrict` specified
(uniform tex :image-2d :location 1 :layout (:rg32f t) :qualifiers (:restrict))
;; -> layout(location = 1,rg32f) uniform restrict image2D tex;

;; an atomic counter, with binding and offset specified
(uniform counter :atomic-uint :layout (:binding 0 :offset 0))
;; -> layout(binding = 0,offset = 0) uniform atomic_uint counter;

Inputs and outputs are specified with (INPUT name type &key stage location) and (OUTPUT name type &key stage location) where stage specifies in which shader stages (:vertex,:fragment etc) the input is visible, and location is an integer which will be output as layout(location = 1) in GLSL.

Interfaces between stages are specified as (INTERFACE name (&key in out uniform) &body slots). slots is a list of (slot-name type). in, out and uniform specify how the interface will be visible, and are either T to make it visible to all stages as name, or a plist of stage names and names to use for the interface in that stage.

For example (interface varyings (:out (:vertex outs) :in (:fragment ins :geometry (ins "ins" :*))) ...) will be visible as an output named out in the vertex shader, as an input array named ins in the geometry shader, and as an input named ins in the fragment shader.

name and slot-name in uniform/input/output/interface can either be a symbol which will be automatically converted from lisp-style to glslStyle, or it can be a list of (lisp-name "glslName") to provide an explicit translation.

Running the example programs

Example program uses GLUT and GLU, and expects GLSL version 330. Most lisp dependencies should be available in quicklisp, aside from possibly mathkit.

Load 3bgl-shader-example.asd through ASDF or Quicklisp, then run (3bgl-shader-example:run-example). That should create a window with a spinning teapot, hit 0-5 keys to try the various example shaders.

If that is working, you can open example-shaders.lisp in emacs and edit them and recompile as usual from slime (C-c C-c etc).

Getting names of uniforms/vertex attributes

In addition to generated GLSL source, GENERATE-STAGE returns a list of uniforms as 2nd value, and attributes in 3rd value. Both are in form (lisp-name "glslName" TYPE) for each entry. There isn't currently any dead-code elimination, so listed names may not actually be active in the final shader program.

Macros

DEFMACRO and MACROLET work as in CL code, and expansion runs on host so can use arbitrary CL.

Array variables

There is partial support for arrays, though type inference doesn't work completely correctly on them and local array variables can't be initialized when bound.

Currently, array types are specified as (<base-type> <size>). (CL style array/vector types may be supported at some point in the future)

(defun foo ()
  (let ((a)) ;; can't currently initialize local array variables
    (declare ((:float 8) a)) ;; specify size/base type
    (setf (aref a 1) 1.23) ;; access as in CL
    (return (aref a 1)))

Compute Shaders

Compute shaders work pretty much like other stages, except you can't specify inputs/outputs, and must specify the workgroup size for kernel invocations. The workgroup sizes are specified with the layout declaration on the main kernel entrypoint. Compute shaders also expose a number of constants describing an individual invocation's relationship to the entire run: gl-local-invocation-id, gl-global-invocation-id, gl-work-group-id, gl-num-work-groups, and gl-work-group-size, all :uvec3, and gl-local-invocation-index, an :int.

;; define a kernel that runs in units of 8x8x8 blocks
(defun some-kernel ()
  (declare (layout (:in nil :local-size-x 8 :local-size-y 8 :local-size-z 8)))
  ;; xyz takes values from (uvec3 0 0 0) to (uvec3 7 7 7)
  (let ((xyz (.xyz gl-local-invocation-id)))
    ...))

Shared variables in compute shaders

Compute shader shared variables are defined with SHARED, which takes a name and type (including array types) as arguments

;; define a shared array with 256 :float elements
;; can be accessed with (aref temp x) or (setf (aref temp x) ...) as in CL
(shared temp (:float 256))
;; a shared uint
(shared foo :uint)

Shader Storage Buffer Objects

Limited support for SSBO, use (interface <name> (:buffer t) ...)

;; makes FOO and BAR available in shaders for read/write
;; BAR is an array of mat4, size depends on size of bound buffer
(interface ssbo (:buffer t :layout (:binding 0 :std430 t))
  (foo :vec4)
  (bar (:mat4 :*)))

Structures

Preliminary support for defining structures with |defstruct|, doesn't currently accept any of the extra options from |cl:defstruct|, and slot syntax is |(slot-name type)|.

Can't currently infer type of structs, so need to |declare| them by hand.

;; define a struct with a float, array of 8 int, and arbitrary
;; length array of vec4
(defstruct foo
  (a :float)
  (b (:int 8))
  (c (:vec4 :*)))

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 3bgl-shader

Author

Bart Botta <00003b at gmail.com>

License

MIT

Description

CL-hosted CL-like DSL for generating GLSL

Dependencies

• alexandria
• bordeaux-threads
• cl-opengl

Source

3bgl-shader.asd (file)

Components

• package.lisp (file)
• ir.lisp (file)
• walker.lisp (file)
• types.lisp (file)
• infer.lisp (file)
• glsl-base.lisp (file)
• cl-functions.lisp (file)
• glsl.lisp (file)
• finalize-inference.lisp (file)
• printer.lisp (file)
• compiler.lisp (file)
• api.lisp (file)
• old-utils.lisp (file)
• utils.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 3bgl-shader.asd

Location

3bgl-shader.asd

Systems

3bgl-shader (system)

3.1.2 3bgl-shader/package.lisp

Parent

3bgl-shader (system)

Location

package.lisp

Packages

• 3bgl-glsl/cl
• 3bgl-glsl
• 3bgl-shaders

3.1.3 3bgl-shader/ir.lisp

Dependency

package.lisp (file)

Parent

3bgl-shader (system)

Location

ir.lisp

Internal Definitions

• allow-casts (method)
• (setf allow-casts) (method)
• argument-environment (method)
• (setf argument-environment) (method)
• argument-environment (method)
• (setf argument-environment) (method)
• arguments (method)
• (setf arguments) (method)
• arguments (method)
• (setf arguments) (method)
• array-access (class)
• array-initialization (class)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (class)
• binding-scope (class)
• binding-with-dependencies (class)
• bindings (method)
• (setf bindings) (method)
• bindings (class)
• bindings-used-by (method)
• bindings-using (method)
• body (method)
• (setf body) (method)
• builtin-function (class)
• called-function (method)
• (setf called-function) (method)
• condition-forms (method)
• (setf condition-forms) (method)
• conflicts (method)
• (setf conflicts) (method)
• constant-binding (class)
• declarations (method)
• (setf declarations) (method)
• declarations (method)
• (setf declarations) (method)
• declared-type (method)
• (setf declared-type) (method)
• declared-type (method)
• (setf declared-type) (method)
• else-form (method)
• (setf else-form) (method)
• environment (method)
• (setf environment) (method)
• expander (method)
• (setf expander) (method)
• expander (method)
• (setf expander) (method)
• expansion (method)
• (setf expansion) (method)
• explicit-progn (class)
• expression (method)
• (setf expression) (method)
• field (method)
• (setf field) (method)
• field (method)
• (setf field) (method)
• final-binding-type-cache (method)
• (setf final-binding-type-cache) (method)
• for-loop (class)
• function-argument (class)
• function-binding (class)
• function-binding-function (class)
• function-call (class)
• function-signature-changed (function)
• global-function (class)
• global-variable (class)
• glsl-name (method)
• (setf glsl-name) (method)
• glsl-name (method)
• (setf glsl-name) (method)
• if-form (class)
• implicit-progn (class)
• index (method)
• (setf index) (method)
• init-forms (method)
• (setf init-forms) (method)
• initial-value-form (method)
• (setf initial-value-form) (method)
• initialized-binding (class)
• internal (method)
• (setf internal) (method)
• internal-function (class)
• lambda-list (method)
• (setf lambda-list) (method)
• layout-qualifiers (method)
• (setf layout-qualifiers) (method)
• local-binding-type-data (method)
• (setf local-binding-type-data) (method)
• local-variable (class)
• macro-definition (class)
• min-size (method)
• (setf min-size) (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• (setf name) (method)
• (setf name) (method)
• old-lambda-list (method)
• (setf old-lambda-list) (method)
• place (class)
• progn-body (class)
• qualifiers (method)
• (setf qualifiers) (method)
• raw-arguments (method)
• (setf raw-arguments) (method)
• raw-arguments (method)
• (setf raw-arguments) (method)
• slot-access (class)
• step-forms (method)
• (setf step-forms) (method)
• swizzle-access (class)
• symbol-macro (class)
• test-form (method)
• (setf test-form) (method)
• then-form (method)
• (setf then-form) (method)
• type-inference-state (method)
• (setf type-inference-state) (method)
• unknown-function-binding (class)
• valid-stages (method)
• (setf valid-stages) (method)
• value (method)
• (setf value) (method)
• value-type (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• variable-binding (class)
• variable-read (class)
• variable-write (class)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)

3.1.4 3bgl-shader/walker.lisp

Dependency

ir.lisp (file)

Parent

3bgl-shader (system)

Location

walker.lisp

Internal Definitions

• *add-conflict-vars* (special variable)
• *check-conflict-vars* (special variable)
• *cl-environment* (special variable)
• *depth* (special variable)
• *environment* (special variable)
• *global-environment* (special variable)
• *glsl-base-environment* (special variable)
• *max-depth* (special variable)
• *package-environments* (special variable)
• *verbose* (special variable)
• add-compiler-macro (function)
• add-function (function)
• add-function-arguments (function)
• add-macro (function)
• add-symbol-macro (function)
• add-unknown-function (function)
• add-variable (function)
• check-locked (function)
• cl-walker (class)
• compiler-macro-bindings (method)
• default-env (function)
• defclmacro (macro)
• defwalker (macro)
• ensure-package-environment (function)
• environment (class)
• function-bindings (method)
• get-compiler-macro-binding (function)
• get-compiler-macro-function (function)
• get-function-binding (function)
• get-macro-function (function)
• get-symbol-macro (function)
• get-type-binding (function)
• get-variable-binding (function)
• global-env (function)
• lambda-list-vars (function)
• locked (method)
• (setf locked) (method)
• make-&key-expander (function)
• name (method)
• parent-scope (method)
• remove-function (function)
• types (method)
• variable-bindings (method)
• walk (generic function)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk-cons (generic function)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-function-body (function)
• walker (class)
• with-environment-scope (macro)
• with-lambda-list-vars (macro)

3.1.5 3bgl-shader/types.lisp

Dependency

walker.lisp (file)

Parent

3bgl-shader (system)

Location

types.lisp

Exported Definitions

• stage (method)
• (setf stage) (method)

Internal Definitions

• %glsl-compiler-macro (macro)
• %glsl-macro (macro)
• *current-shader-stage* (special variable)
• *known-declarations* (special variable)
• add-concrete-type (function)
• aggregate-type (class)
• array-size (method)
• (setf array-size) (method)
• array-size (method)
• (setf array-size) (method)
• array-size (method)
• (setf array-size) (method)
• array-type (class)
• base-type (method)
• (setf base-type) (method)
• base-type (method)
• (setf base-type) (method)
• bind-interface (function)
• binding (method)
• (setf binding) (method)
• concrete-type (class)
• default (method)
• (setf default) (method)
• explicit-casts (method)
• (setf explicit-casts) (method)
• generic-type (class)
• glsl-name (method)
• (setf glsl-name) (method)
• implicit-casts-from (method)
• implicit-casts-from (method)
• (setf implicit-casts-from) (method)
• implicit-casts-to (method)
• implicit-casts-to (method)
• (setf implicit-casts-to) (method)
• in/out/uniform/attrib (function)
• interface-binding (class)
• interface-block (method)
• (setf interface-block) (method)
• interface-qualifier (method)
• (setf interface-qualifier) (method)
• interface-stage-binding (class)
• interface-type (class)
• internal (method)
• (setf internal) (method)
• internal (method)
• (setf internal) (method)
• layout-qualifier (method)
• (setf layout-qualifier) (method)
• name (method)
• (setf name) (method)
• process-type-declarations-for-scope (method)
• scalar/vector-set (method)
• (setf scalar/vector-set) (method)
• scalar/vector-size (method)
• (setf scalar/vector-size) (method)
• stage-binding (method)
• stage-binding (method)
• stage-bindings (method)
• (setf stage-bindings) (method)
• struct-type (class)
• value-type (method)
• value-type (method)
• value-type (method)

3.1.6 3bgl-shader/infer.lisp

Dependency

types.lisp (file)

Parent

3bgl-shader (system)

Location

infer.lisp

Internal Definitions

• *copy-constraints-hash* (special variable)
• *current-function-local-types* (special variable)
• *current-function-return-type* (special variable)
• *current-function-stages* (special variable)
• *inference-worklist* (special variable)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• any-type (class)
• arg-type (method)
• (setf arg-type) (method)
• argument-types (method)
• (setf argument-types) (method)
• argument-types (method)
• (setf argument-types) (method)
• array-access-constraint (class)
• base-type (method)
• (setf base-type) (method)
• called-function (method)
• (setf called-function) (method)
• cast-constraint (class)
• cast-to-boolean (function)
• cast-type (method)
• (setf cast-type) (method)
• constrained-type (class)
• constraint (class)
• constraints (method)
• (setf constraints) (method)
• constraints (method)
• (setf constraints) (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-unify-constraints (function)
• ctype (method)
• (setf ctype) (method)
• ctype/other-constraint (class)
• debug-local-binding-type-data (function)
• debug-type-names (function)
• defmethod2 (macro)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• equiv (method)
• (setf equiv) (method)
• expand-optional-arg-type (function)
• flag-modified-constraint (function)
• flag-modified-type (function)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• function-application (class)
• function-types (method)
• (setf function-types) (method)
• function-types-by-arity (method)
• (setf function-types-by-arity) (method)
• get-equiv-type (method)
• get-equiv-type (method)
• get-only-hash-key (function)
• global-function (method)
• (setf global-function) (method)
• global-function-constraint (class)
• in-type (method)
• (setf in-type) (method)
• incomplete-dependent (condition)
• infer (function)
• infer-build-constraints (class)
• infer-modified-functions (function)
• inference-call-site (class)
• inference-failure (condition)
• is-type (method)
• is-type (method)
• max-arity (method)
• (setf max-arity) (method)
• min-arity (method)
• (setf min-arity) (method)
• min-size (method)
• (setf min-size) (method)
• min-size (method)
• (setf min-size) (method)
• modified (method)
• (setf modified) (method)
• name (method)
• name (method)
• name (method)
• (setf name) (method)
• (setf name) (method)
• (setf name) (method)
• optional-arg-type (class)
• other-type (method)
• (setf other-type) (method)
• out-size (method)
• (setf out-size) (method)
• out-type (method)
• (setf out-type) (method)
• print-bindings/ret (function)
• ref-type (class)
• return-type (method)
• (setf return-type) (method)
• return-type (method)
• (setf return-type) (method)
• run-type-inference (function)
• same-base-type-different-size-constraint (class)
• same-size-different-base-type-constraint (class)
• same-type-or-scalar-constraint (class)
• scalar-type-of-constraint (class)
• set-type (function)
• topo-sort-dependencies (function)
• types (method)
• types (method)
• (setf types) (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• variable-arity-function-application (class)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)

3.1.7 3bgl-shader/glsl-base.lisp

Dependency

infer.lisp (file)

Parent

3bgl-shader (system)

Location

glsl-base.lisp

Exported Definitions

• glsl-attribute (macro)
• glsl-defconstant (macro)
• glsl-defun (macro)
• glsl-input (macro)
• glsl-interface (macro)
• glsl-output (macro)
• glsl-uniform (macro)

Internal Definitions

• *current-function* (special variable)
• call-with-package-environment (function)
• filter-progn (function)
• glsl-bind-interface (macro)
• glsl-walker (class)
• walk (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• with-package-environment (macro)

3.1.8 3bgl-shader/cl-functions.lisp

Dependency

glsl-base.lisp (file)

Parent

3bgl-shader (system)

Location

cl-functions.lisp

Internal Definitions

• add-internal-function/full (function)
• add-internal-function/mat (function)
• add-internal-function/s (function)

3.1.9 3bgl-shader/glsl.lisp

Dependency

cl-functions.lisp (file)

Parent

3bgl-shader (system)

Location

glsl.lisp

3.1.10 3bgl-shader/finalize-inference.lisp

Dependency

glsl.lisp (file)

Parent

3bgl-shader (system)

Location

finalize-inference.lisp

Internal Definitions

• *binding-types* (special variable)
• *instantiated-overloads* (special variable)
• cache-binding (function)
• finalize (class)
• finalize-inference (function)
• flatten-function (function)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• get-concrete-type (method)
• get-concrete-type (method)
• get-concrete-type (method)
• get-concrete-type (method)
• get-concrete-type (method)

3.1.11 3bgl-shader/printer.lisp

Dependency

finalize-inference.lisp (file)

Parent

3bgl-shader (system)

Location

printer.lisp

Internal Definitions

• %print (generic function)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %translate-name (function)
• *in-expression* (special variable)
• *interface-qualifier-order* (special variable)
• *internal-function-printers* (special variable)
• *live-variables* (special variable)
• *pprint-glsl* (special variable)
• *print-as-main* (special variable)
• array-suffix (method)
• array-suffix (method)
• array-suffix (method)
• array-suffix (method)
• assert-statement (macro)
• defprint (macro)
• defprint-binop (macro)
• defprinti (macro)
• integral-type (method)
• integral-type (method)
• pprint-glsl (function)
• print-main-layout-qualifiers (function)
• sort-interface-qualifiers (function)
• translate-interface-qualifiers (function)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• vector->{} (function)

3.1.12 3bgl-shader/compiler.lisp

Dependency

printer.lisp (file)

Parent

3bgl-shader (system)

Location

compiler.lisp

Internal Definitions

• *function-stages* (special variable)
• *new-function-definitions* (special variable)
• *new-global-definitions* (special variable)
• *new-type-definitions* (special variable)
• *tree-shaker-current-object* (special variable)
• *tree-shaker-hook* (special variable)
• *tree-shaker-type-hook* (special variable)
• check-slot-stages (method)
• check-stages (method)
• extract-functions (class)
• modified (method)
• tree-shaker (function)
• tree-shaker (class)
• update-calls (class)
• update-dependencies (function)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)

3.1.13 3bgl-shader/api.lisp

Dependency

compiler.lisp (file)

Parent

3bgl-shader (system)

Location

api.lisp

Exported Definitions

• *default-version* (special variable)
• *modified-function-hook* (special variable)
• attribute (macro)
• bind-interface (macro)
• compile-form (function)
• defconstant (macro)
• defmacro (macro)
• defstruct (macro)
• defun (macro)
• generate-stage (function)
• input (macro)
• interface (macro)
• output (macro)
• shared (macro)
• uniform (macro)

Internal Definitions

• *compiler-lock* (special variable)
• *default-backend* (special variable)
• *default-extensions* (special variable)
• *shader-type->stage* (special variable)
• expand-buffers (function)
• expand-extension-keyword (function)
• expand-structs (function)
• expand-uniform-slots (method)
• expand-uniform-slots (method)
• expand-uniform-slots (method)
• expand-uniform-slots (method)
• expand-uniforms (function)
• generate-output (method)

3.1.14 3bgl-shader/old-utils.lisp

Dependency

api.lisp (file)

Parent

3bgl-shader (system)

Location

old-utils.lisp

Internal Definitions

• reload-program (function)
• uniform-index (function)
• uniform-matrix (function)
• uniformf (function)
• uniformfv (function)
• uniformi (function)

3.1.15 3bgl-shader/utils.lisp

Dependency

old-utils.lisp (file)

Parent

3bgl-shader (system)

Location

utils.lisp

Internal Definitions

• %reload-program (function)
• (setf %uniform) (method)
• *bound-program* (special variable)
• *default-recompilation-callback* (special variable)
• *print-shaders* (special variable)
• *shader-program-hook* (special variable)
• *stage-name-map* (special variable)
• dirty (method)
• ensure-compiled (function)
• flag-shader (function)
• live-uniforms (method)
• (setf live-uniforms) (method)
• name-map (method)
• program (method)
• recompilation-callbacks (method)
• (setf recompilation-callbacks) (method)
• reset-program (function)
• shader-program (function)
• shader-program (class)
• ssbos (method)
• stages (method)
• structs (method)
• (setf uniform) (function)
• uniform (generic function)
• uniform (method)
• (setf uniform) (function)
• uniform-matrix-2fv (function)
• uniform-matrix-2x3-fv (function)
• uniform-matrix-2x4-fv (function)
• uniform-matrix-3fv (function)
• uniform-matrix-3x2-fv (function)
• uniform-matrix-3x4-fv (function)
• uniform-matrix-4fv (function)
• uniform-matrix-4x2-fv (function)
• uniform-matrix-4x3-fv (function)
• uniforms (method)
• use-program (method)
• version (method)
• (setf version) (method)
• with-program (macro)

4 Packages

Packages are listed by definition order.

4.1 3bgl-glsl/cl

Source

package.lisp (file)

Use List

• 3bgl-glsl
• common-lisp

4.2 3bgl-glsl

Source

package.lisp (file)

Use List

common-lisp

Used By List

3bgl-glsl/cl

Exported Definitions

• attribute (macro)
• bind-interface (macro)
• defconstant (macro)
• defmacro (macro)
• defstruct (macro)
• defun (macro)
• glsl-attribute (macro)
• glsl-defconstant (macro)
• glsl-defun (macro)
• glsl-input (macro)
• glsl-interface (macro)
• glsl-output (macro)
• glsl-uniform (macro)
• input (macro)
• interface (macro)
• output (macro)
• shared (macro)
• uniform (macro)

Internal Definitions

• *current-function* (special variable)
• *glsl-base-environment* (special variable)
• call-with-package-environment (function)
• filter-progn (function)
• glsl-bind-interface (macro)
• glsl-walker (class)
• with-package-environment (macro)

4.3 3bgl-shaders

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *default-version* (special variable)
• *modified-function-hook* (special variable)
• compile-form (function)
• generate-stage (function)
• stage (generic function)
• stage (method)
• (setf stage) (method)
• (setf stage) (generic function)

Internal Definitions

• %glsl-compiler-macro (macro)
• %glsl-macro (macro)
• %print (generic function)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %print (method)
• %reload-program (function)
• %translate-name (function)
• (setf %uniform) (generic function)
• (setf %uniform) (method)
• *add-conflict-vars* (special variable)
• *binding-types* (special variable)
• *bound-program* (special variable)
• *check-conflict-vars* (special variable)
• *cl-environment* (special variable)
• *compiler-lock* (special variable)
• *copy-constraints-hash* (special variable)
• *current-function-local-types* (special variable)
• *current-function-return-type* (special variable)
• *current-function-stages* (special variable)
• *current-shader-stage* (special variable)
• *default-backend* (special variable)
• *default-extensions* (special variable)
• *default-recompilation-callback* (special variable)
• *depth* (special variable)
• *environment* (special variable)
• *function-stages* (special variable)
• *global-environment* (special variable)
• *in-expression* (special variable)
• *inference-worklist* (special variable)
• *instantiated-overloads* (special variable)
• *interface-qualifier-order* (special variable)
• *internal-function-printers* (special variable)
• *known-declarations* (special variable)
• *live-variables* (special variable)
• *max-depth* (special variable)
• *new-function-definitions* (special variable)
• *new-global-definitions* (special variable)
• *new-type-definitions* (special variable)
• *package-environments* (special variable)
• *pprint-glsl* (special variable)
• *print-as-main* (special variable)
• *print-shaders* (special variable)
• *shader-program-hook* (special variable)
• *shader-type->stage* (special variable)
• *stage-name-map* (special variable)
• *tree-shaker-current-object* (special variable)
• *tree-shaker-hook* (special variable)
• *tree-shaker-type-hook* (special variable)
• *verbose* (special variable)
• add-compiler-macro (function)
• add-concrete-type (function)
• add-constraint (generic function)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• add-function (function)
• add-function-arguments (function)
• add-internal-function/full (function)
• add-internal-function/mat (function)
• add-internal-function/s (function)
• add-macro (function)
• add-symbol-macro (function)
• add-unknown-function (function)
• add-variable (function)
• aggregate-type (class)
• allow-casts (generic function)
• allow-casts (method)
• (setf allow-casts) (method)
• (setf allow-casts) (generic function)
• any-type (class)
• arg-type (generic function)
• arg-type (method)
• (setf arg-type) (method)
• (setf arg-type) (generic function)
• argument-environment (generic function)
• argument-environment (method)
• (setf argument-environment) (method)
• argument-environment (method)
• (setf argument-environment) (method)
• (setf argument-environment) (generic function)
• argument-types (generic function)
• argument-types (method)
• (setf argument-types) (method)
• argument-types (method)
• (setf argument-types) (method)
• (setf argument-types) (generic function)
• arguments (generic function)
• arguments (method)
• (setf arguments) (method)
• arguments (method)
• (setf arguments) (method)
• (setf arguments) (generic function)
• array-access (class)
• array-access-constraint (class)
• array-initialization (class)
• array-size (generic function)
• array-size (method)
• (setf array-size) (method)
• array-size (method)
• (setf array-size) (method)
• array-size (method)
• (setf array-size) (method)
• (setf array-size) (generic function)
• array-suffix (generic function)
• array-suffix (method)
• array-suffix (method)
• array-suffix (method)
• array-suffix (method)
• array-type (class)
• assert-statement (macro)
• base-type (generic function)
• base-type (method)
• (setf base-type) (method)
• base-type (method)
• (setf base-type) (method)
• base-type (method)
• (setf base-type) (method)
• (setf base-type) (generic function)
• bind-interface (function)
• binding (generic function)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• binding (method)
• (setf binding) (method)
• (setf binding) (generic function)
• binding (class)
• binding-scope (class)
• binding-with-dependencies (class)
• bindings (generic function)
• bindings (method)
• (setf bindings) (method)
• (setf bindings) (generic function)
• bindings (class)
• bindings-used-by (generic function)
• bindings-used-by (method)
• bindings-using (generic function)
• bindings-using (method)
• body (generic function)
• body (method)
• (setf body) (method)
• (setf body) (generic function)
• builtin-function (class)
• cache-binding (function)
• called-function (generic function)
• called-function (method)
• (setf called-function) (method)
• called-function (method)
• (setf called-function) (method)
• (setf called-function) (generic function)
• cast-constraint (class)
• cast-to-boolean (function)
• cast-type (generic function)
• cast-type (method)
• (setf cast-type) (method)
• (setf cast-type) (generic function)
• check-locked (function)
• check-slot-stages (generic function)
• check-slot-stages (method)
• check-stages (generic function)
• check-stages (method)
• cl-walker (class)
• compiler-macro-bindings (generic function)
• compiler-macro-bindings (method)
• concrete-type (class)
• condition-forms (generic function)
• condition-forms (method)
• (setf condition-forms) (method)
• (setf condition-forms) (generic function)
• conflicts (generic function)
• conflicts (method)
• (setf conflicts) (method)
• (setf conflicts) (generic function)
• constant-binding (class)
• constrained-type (class)
• constraint (class)
• constraints (generic function)
• constraints (method)
• (setf constraints) (method)
• constraints (method)
• (setf constraints) (method)
• (setf constraints) (generic function)
• copy-constraints (generic function)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-constraints (method)
• copy-unify-constraints (function)
• ctype (generic function)
• ctype (method)
• (setf ctype) (method)
• (setf ctype) (generic function)
• ctype/other-constraint (class)
• debug-local-binding-type-data (function)
• debug-type-names (function)
• declarations (generic function)
• declarations (method)
• (setf declarations) (method)
• declarations (method)
• (setf declarations) (method)
• (setf declarations) (generic function)
• declared-type (generic function)
• declared-type (method)
• (setf declared-type) (method)
• declared-type (method)
• (setf declared-type) (method)
• (setf declared-type) (generic function)
• default (generic function)
• default (method)
• (setf default) (method)
• (setf default) (generic function)
• default-env (function)
• defclmacro (macro)
• defmethod2 (macro)
• defprint (macro)
• defprint-binop (macro)
• defprinti (macro)
• defwalker (macro)
• dirty (generic function)
• dirty (method)
• dump-constraint (generic function)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• dump-constraint (method)
• else-form (generic function)
• else-form (method)
• (setf else-form) (method)
• (setf else-form) (generic function)
• ensure-compiled (function)
• ensure-package-environment (function)
• environment (generic function)
• environment (method)
• (setf environment) (method)
• (setf environment) (generic function)
• environment (class)
• equiv (generic function)
• equiv (method)
• (setf equiv) (method)
• (setf equiv) (generic function)
• expand-buffers (function)
• expand-extension-keyword (function)
• expand-optional-arg-type (function)
• expand-structs (function)
• expand-uniform-slots (generic function)
• expand-uniform-slots (method)
• expand-uniform-slots (method)
• expand-uniform-slots (method)
• expand-uniform-slots (method)
• expand-uniforms (function)
• expander (generic function)
• expander (method)
• (setf expander) (method)
• expander (method)
• (setf expander) (method)
• (setf expander) (generic function)
• expansion (generic function)
• expansion (method)
• (setf expansion) (method)
• (setf expansion) (generic function)
• explicit-casts (generic function)
• explicit-casts (method)
• (setf explicit-casts) (method)
• (setf explicit-casts) (generic function)
• explicit-progn (class)
• expression (generic function)
• expression (method)
• (setf expression) (method)
• (setf expression) (generic function)
• extract-functions (class)
• field (generic function)
• field (method)
• (setf field) (method)
• field (method)
• (setf field) (method)
• (setf field) (generic function)
• final-binding-type-cache (generic function)
• final-binding-type-cache (method)
• (setf final-binding-type-cache) (method)
• (setf final-binding-type-cache) (generic function)
• finalize (class)
• finalize-inference (function)
• flag-modified-constraint (function)
• flag-modified-type (function)
• flag-shader (function)
• flatten-function (function)
• flatten-type (generic function)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• flatten-type (method)
• flatten-types (generic function)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• flatten-types (method)
• for-loop (class)
• function-application (class)
• function-argument (class)
• function-binding (class)
• function-binding-function (class)
• function-bindings (generic function)
• function-bindings (method)
• function-call (class)
• function-signature-changed (function)
• function-types (generic function)
• function-types (method)
• (setf function-types) (method)
• (setf function-types) (generic function)
• function-types-by-arity (generic function)
• function-types-by-arity (method)
• (setf function-types-by-arity) (method)
• (setf function-types-by-arity) (generic function)
• generate-output (generic function)
• generate-output (method)
• generic-type (class)
• get-compiler-macro-binding (function)
• get-compiler-macro-function (function)
• get-concrete-type (generic function)
• get-concrete-type (method)
• get-concrete-type (method)
• get-concrete-type (method)
• get-concrete-type (method)
• get-concrete-type (method)
• get-equiv-type (generic function)
• get-equiv-type (method)
• get-equiv-type (method)
• get-function-binding (function)
• get-macro-function (function)
• get-only-hash-key (function)
• get-symbol-macro (function)
• get-type-binding (function)
• get-variable-binding (function)
• global-env (function)
• global-function (generic function)
• global-function (method)
• (setf global-function) (method)
• (setf global-function) (generic function)
• global-function (class)
• global-function-constraint (class)
• global-variable (class)
• glsl-name (generic function)
• glsl-name (method)
• (setf glsl-name) (method)
• glsl-name (method)
• (setf glsl-name) (method)
• glsl-name (method)
• (setf glsl-name) (method)
• (setf glsl-name) (generic function)
• if-form (class)
• implicit-casts-from (generic function)
• implicit-casts-from (method)
• implicit-casts-from (method)
• (setf implicit-casts-from) (method)
• (setf implicit-casts-from) (generic function)
• implicit-casts-to (generic function)
• implicit-casts-to (method)
• implicit-casts-to (method)
• (setf implicit-casts-to) (method)
• (setf implicit-casts-to) (generic function)
• implicit-progn (class)
• in-type (generic function)
• in-type (method)
• (setf in-type) (method)
• (setf in-type) (generic function)
• in/out/uniform/attrib (function)
• incomplete-dependent (condition)
• index (generic function)
• index (method)
• (setf index) (method)
• (setf index) (generic function)
• infer (function)
• infer-build-constraints (class)
• infer-modified-functions (function)
• inference-call-site (class)
• inference-failure (condition)
• init-forms (generic function)
• init-forms (method)
• (setf init-forms) (method)
• (setf init-forms) (generic function)
• initial-value-form (generic function)
• initial-value-form (method)
• (setf initial-value-form) (method)
• (setf initial-value-form) (generic function)
• initialized-binding (class)
• integral-type (generic function)
• integral-type (method)
• integral-type (method)
• interface-binding (class)
• interface-block (generic function)
• interface-block (method)
• (setf interface-block) (method)
• (setf interface-block) (generic function)
• interface-qualifier (generic function)
• interface-qualifier (method)
• (setf interface-qualifier) (method)
• (setf interface-qualifier) (generic function)
• interface-stage-binding (class)
• interface-type (class)
• internal (generic function)
• internal (method)
• (setf internal) (method)
• internal (method)
• (setf internal) (method)
• internal (method)
• (setf internal) (method)
• (setf internal) (generic function)
• internal-function (class)
• is-type (generic function)
• is-type (method)
• is-type (method)
• lambda-list (generic function)
• lambda-list (method)
• (setf lambda-list) (method)
• (setf lambda-list) (generic function)
• lambda-list-vars (function)
• layout-qualifier (generic function)
• layout-qualifier (method)
• (setf layout-qualifier) (method)
• (setf layout-qualifier) (generic function)
• layout-qualifiers (generic function)
• layout-qualifiers (method)
• (setf layout-qualifiers) (method)
• (setf layout-qualifiers) (generic function)
• live-uniforms (generic function)
• live-uniforms (method)
• (setf live-uniforms) (method)
• (setf live-uniforms) (generic function)
• local-binding-type-data (generic function)
• local-binding-type-data (method)
• (setf local-binding-type-data) (method)
• (setf local-binding-type-data) (generic function)
• local-variable (class)
• locked (generic function)
• locked (method)
• (setf locked) (method)
• (setf locked) (generic function)
• macro-definition (class)
• make-&key-expander (function)
• max-arity (generic function)
• max-arity (method)
• (setf max-arity) (method)
• (setf max-arity) (generic function)
• min-arity (generic function)
• min-arity (method)
• (setf min-arity) (method)
• (setf min-arity) (generic function)
• min-size (generic function)
• min-size (method)
• (setf min-size) (method)
• min-size (method)
• (setf min-size) (method)
• min-size (method)
• (setf min-size) (method)
• (setf min-size) (generic function)
• modified (generic function)
• modified (method)
• modified (method)
• (setf modified) (method)
• (setf modified) (generic function)
• name (generic function)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• (setf name) (generic function)
• (setf name) (method)
• (setf name) (method)
• (setf name) (method)
• (setf name) (method)
• (setf name) (method)
• (setf name) (method)
• name-map (generic function)
• name-map (method)
• old-lambda-list (generic function)
• old-lambda-list (method)
• (setf old-lambda-list) (method)
• (setf old-lambda-list) (generic function)
• optional-arg-type (class)
• other-type (generic function)
• other-type (method)
• (setf other-type) (method)
• (setf other-type) (generic function)
• out-size (generic function)
• out-size (method)
• (setf out-size) (method)
• (setf out-size) (generic function)
• out-type (generic function)
• out-type (method)
• (setf out-type) (method)
• (setf out-type) (generic function)
• parent-scope (generic function)
• parent-scope (method)
• place (class)
• pprint-glsl (function)
• print-bindings/ret (function)
• print-main-layout-qualifiers (function)
• process-type-declarations-for-scope (generic function)
• process-type-declarations-for-scope (method)
• progn-body (class)
• program (generic function)
• program (method)
• qualifiers (generic function)
• qualifiers (method)
• (setf qualifiers) (method)
• (setf qualifiers) (generic function)
• raw-arguments (generic function)
• raw-arguments (method)
• (setf raw-arguments) (method)
• raw-arguments (method)
• (setf raw-arguments) (method)
• (setf raw-arguments) (generic function)
• recompilation-callbacks (generic function)
• recompilation-callbacks (method)
• (setf recompilation-callbacks) (method)
• (setf recompilation-callbacks) (generic function)
• ref-type (class)
• reload-program (function)
• remove-function (function)
• reset-program (function)
• return-type (generic function)
• return-type (method)
• (setf return-type) (method)
• return-type (method)
• (setf return-type) (method)
• (setf return-type) (generic function)
• run-type-inference (function)
• same-base-type-different-size-constraint (class)
• same-size-different-base-type-constraint (class)
• same-type-or-scalar-constraint (class)
• scalar-type-of-constraint (class)
• scalar/vector-set (generic function)
• scalar/vector-set (method)
• (setf scalar/vector-set) (method)
• (setf scalar/vector-set) (generic function)
• scalar/vector-size (generic function)
• scalar/vector-size (method)
• (setf scalar/vector-size) (method)
• (setf scalar/vector-size) (generic function)
• set-type (function)
• shader-program (function)
• shader-program (class)
• slot-access (class)
• sort-interface-qualifiers (function)
• ssbos (generic function)
• ssbos (method)
• stage-binding (generic function)
• stage-binding (method)
• stage-binding (method)
• stage-bindings (generic function)
• stage-bindings (method)
• (setf stage-bindings) (method)
• (setf stage-bindings) (generic function)
• stages (generic function)
• stages (method)
• step-forms (generic function)
• step-forms (method)
• (setf step-forms) (method)
• (setf step-forms) (generic function)
• struct-type (class)
• structs (generic function)
• structs (method)
• swizzle-access (class)
• symbol-macro (class)
• test-form (generic function)
• test-form (method)
• (setf test-form) (method)
• (setf test-form) (generic function)
• then-form (generic function)
• then-form (method)
• (setf then-form) (method)
• (setf then-form) (generic function)
• topo-sort-dependencies (function)
• translate-interface-qualifiers (function)
• translate-name (generic function)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-name (method)
• translate-slot-name (generic function)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-slot-name (method)
• translate-type (generic function)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• translate-type (method)
• tree-shaker (function)
• tree-shaker (class)
• type-inference-state (generic function)
• type-inference-state (method)
• (setf type-inference-state) (method)
• (setf type-inference-state) (generic function)
• types (generic function)
• types (method)
• types (method)
• (setf types) (method)
• types (method)
• (setf types) (generic function)
• unifiable-types-p (generic function)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• unifiable-types-p (method)
• (setf uniform) (function)
• uniform (generic function)
• uniform (method)
• (setf uniform) (function)
• uniform-index (function)
• uniform-matrix (function)
• uniform-matrix-2fv (function)
• uniform-matrix-2x3-fv (function)
• uniform-matrix-2x4-fv (function)
• uniform-matrix-3fv (function)
• uniform-matrix-3x2-fv (function)
• uniform-matrix-3x4-fv (function)
• uniform-matrix-4fv (function)
• uniform-matrix-4x2-fv (function)
• uniform-matrix-4x3-fv (function)
• uniformf (function)
• uniformfv (function)
• uniformi (function)
• uniforms (generic function)
• uniforms (method)
• unify (generic function)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unify (method)
• unknown-function-binding (class)
• update-calls (class)
• update-constraint (generic function)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-constraint (method)
• update-dependencies (function)
• use-program (generic function)
• use-program (method)
• valid-stages (generic function)
• valid-stages (method)
• (setf valid-stages) (method)
• (setf valid-stages) (generic function)
• value (generic function)
• value (method)
• (setf value) (method)
• (setf value) (generic function)
• value-type (generic function)
• value-type (method)
• value-type (method)
• value-type (method)
• value-type (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• value-type (method)
• (setf value-type) (method)
• (setf value-type) (generic function)
• variable-arity-function-application (class)
• variable-binding (class)
• variable-bindings (generic function)
• variable-bindings (method)
• variable-read (class)
• variable-write (class)
• vector->{} (function)
• version (generic function)
• version (method)
• (setf version) (method)
• (setf version) (generic function)
• walk (generic function)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk (method)
• walk-cons (generic function)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-cons (method)
• walk-function-body (function)
• walker (class)
• with-environment-scope (macro)
• with-lambda-list-vars (macro)
• with-program (macro)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *default-version*

Package

3bgl-shaders

Source

api.lisp (file)

Special Variable: *modified-function-hook*

list of functions to call when shader functions are
modified. Passed a list of names of functions that have been modified. May be called multiple times for same function if a whole file using the 3bgl-glsl:defun macro is recompiled, so probably should store names and only update shader programs at next frame rather than updating programs directly from hook function.

Package

3bgl-shaders

Source

api.lisp (file)

5.1.2 Macros

Macro: attribute NAME TYPE &rest ARGS &key LOCATION

Package

3bgl-glsl

Source

api.lisp (file)

Macro: bind-interface STAGE BLOCK-NAME INTERFACE-QUALIFIER INSTANCE-NAME

Package

3bgl-glsl

Source

api.lisp (file)

Macro: defconstant NAME VALUE TYPE

Package

3bgl-glsl

Source

api.lisp (file)

Macro: defmacro NAME ARGS &body BODY

Package

3bgl-glsl

Source

api.lisp (file)

Macro: defstruct NAME &rest SLOTS

Package

3bgl-glsl

Source

api.lisp (file)

Macro: defun NAME ARGS &body BODY

Package

3bgl-glsl

Source

api.lisp (file)

Macro: glsl-attribute NAME TYPE &rest ARGS &key LOCATION

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Macro: glsl-defconstant NAME VALUE TYPE

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Macro: glsl-defun NAME ARGS &body BODY

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Macro: glsl-input NAME TYPE &rest ARGS &key STAGE LOCATION

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Macro: glsl-interface NAME (&rest ARGS &key IN OUT UNIFORM) &body SLOTS

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Macro: glsl-output NAME TYPE &rest ARGS &key STAGE LOCATION

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Macro: glsl-uniform NAME TYPE &rest ARGS &key STAGE LOCATION

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Macro: input NAME TYPE &rest ARGS &key STAGE LOCATION QUALIFIERS

Package

3bgl-glsl

Source

api.lisp (file)

Macro: interface NAME (&rest ARGS &key IN OUT UNIFORM BUFFER LAYOUT) &body SLOTS

Package

3bgl-glsl

Source

api.lisp (file)

Macro: output NAME TYPE &rest ARGS &key STAGE LOCATION QUALIFIERS

Package

3bgl-glsl

Source

api.lisp (file)

Macro: shared NAME TYPE &rest ARGS &key STAGE LAYOUT QUALIFIERS &allow-other-keys

Package

3bgl-glsl

Source

api.lisp (file)

Macro: uniform NAME TYPE &rest ARGS &key STAGE LOCATION INTERNAL LAYOUT QUALIFIERS DEFAULT &allow-other-keys

Package

3bgl-glsl

Source

api.lisp (file)

5.1.3 Functions

Function: compile-form FORM

Run first passes of compilation on specified form. (Wrap with PROGN to process multiple forms). Calls functions in *MODIFIED-FUNCTION-HOOK* with names of any functions whose definitions are possibly affected by compiling FORM (for example functions that call a function defined/updated by FORM, and the (re)defined function itself).

Package

3bgl-shaders

Source

api.lisp (file)

Function: generate-stage STAGE MAIN &key BACKEND VERSION EXTENSIONS EXPAND-UNIFORMS

Generate GLSL shader for specified STAGE, using function named by MAIN as glsl ’main’ function. ROOT and all functions/variables/etc it depends on should already have been successfully compiled with COMPILE-FORM. STAGE is :VERTEX, :FRAGMENT, :GEOMETRY, :TESS-EVAL, :TESS-CONTROL, or :COMPUTE. VERSION specifies the value of the version pragma in generated shader, but doesn’t otherwise affect generated code currently. Returns a list of active uniforms in the
form (LISP-NAME "glslName" type . PROPERTIES) as second value, and a list of active attributes in same format as third value. (GL shader types like :VERTEX-SHADER are also accepted for STAGE)

For uniforms, PROPERTIES is a plist containing 0 or more of:

:COMPONENTS : (when EXPAND-UNIFORMS is true) for composite uniforms (structs, etc), a list containing a list of uniform name and slot names or array indices for each leaf uniform represented by the type, for example a struct uniform containing an array of structs might have entries that look like (foo bar 1 baz) corresponding to the uniform "foo.bar[1].baz".

Package

3bgl-shaders

Source

api.lisp (file)

5.1.4 Generic functions

Generic Function: stage OBJECT

Generic Function: (setf stage) NEW-VALUE OBJECT

Package

3bgl-shaders

Methods

Method: stage (INTERFACE-STAGE-BINDING interface-stage-binding)

automatically generated reader method

Source

types.lisp (file)

Method: (setf stage) NEW-VALUE (INTERFACE-STAGE-BINDING interface-stage-binding)

automatically generated writer method

Source

types.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *add-conflict-vars*

if bound, should be a hash of variable names to flag as conflicts when adding variable if value in hash is :CONFLICT.

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *binding-types*

Package

3bgl-shaders

Source

finalize-inference.lisp (file)

Special Variable: *bound-program*

Package

3bgl-shaders

Source

utils.lisp (file)

Special Variable: *check-conflict-vars*

if bound, should be a hash of variable names to flag as conflicts when looking up variable. Names are flagged by setting value in hash to :CONFLICT.

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *cl-environment*

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *compiler-lock*

Package

3bgl-shaders

Source

api.lisp (file)

Special Variable: *copy-constraints-hash*

used to track already copied constraints when copying type inference data

Package

3bgl-shaders

Source

infer.lisp (file)

Special Variable: *current-function*

current function being compiled if any

Package

3bgl-glsl

Source

glsl-base.lisp (file)

Special Variable: *current-function-local-types*

Package

3bgl-shaders

Source

infer.lisp (file)

Special Variable: *current-function-return-type*

Package

3bgl-shaders

Source

infer.lisp (file)

Special Variable: *current-function-stages*

Package

3bgl-shaders

Source

infer.lisp (file)

Special Variable: *current-shader-stage*

Package

3bgl-shaders

Source

types.lisp (file)

Special Variable: *default-backend*

Package

3bgl-shaders

Source

api.lisp (file)

Special Variable: *default-extensions*

Package

3bgl-shaders

Source

api.lisp (file)

Special Variable: *default-recompilation-callback*

Package

3bgl-shaders

Source

utils.lisp (file)

Special Variable: *depth*

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *environment*

current local environment

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *function-stages*

Package

3bgl-shaders

Source

compiler.lisp (file)

Special Variable: *global-environment*

current global environment

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *glsl-base-environment*

Package

3bgl-glsl

Source

walker.lisp (file)

Special Variable: *in-expression*

Package

3bgl-shaders

Source

printer.lisp (file)

Special Variable: *inference-worklist*

Package

3bgl-shaders

Source

infer.lisp (file)

Special Variable: *instantiated-overloads*

Package

3bgl-shaders

Source

finalize-inference.lisp (file)

Special Variable: *interface-qualifier-order*

Package

3bgl-shaders

Source

printer.lisp (file)

Special Variable: *internal-function-printers*

Package

3bgl-shaders

Source

printer.lisp (file)

Special Variable: *known-declarations*

Package

3bgl-shaders

Source

types.lisp (file)

Special Variable: *live-variables*

Package

3bgl-shaders

Source

printer.lisp (file)

Special Variable: *max-depth*

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *new-function-definitions*

Package

3bgl-shaders

Source

compiler.lisp (file)

Special Variable: *new-global-definitions*

Package

3bgl-shaders

Source

compiler.lisp (file)

Special Variable: *new-type-definitions*

Package

3bgl-shaders

Source

compiler.lisp (file)

Special Variable: *package-environments*

Package

3bgl-shaders

Source

walker.lisp (file)

Special Variable: *pprint-glsl*

Package

3bgl-shaders

Source

printer.lisp (file)

Special Variable: *print-as-main*

Package

3bgl-shaders

Source

printer.lisp (file)

Special Variable: *print-shaders*

Package

3bgl-shaders

Source

utils.lisp (file)

Special Variable: *shader-program-hook*

Package

3bgl-shaders

Source

utils.lisp (file)

Special Variable: *shader-type->stage*

Package

3bgl-shaders

Source

api.lisp (file)

Special Variable: *stage-name-map*

Package

3bgl-shaders

Source

utils.lisp (file)

Special Variable: *tree-shaker-current-object*

Package

3bgl-shaders

Source

compiler.lisp (file)

Special Variable: *tree-shaker-hook*

Package

3bgl-shaders

Source

compiler.lisp (file)

Special Variable: *tree-shaker-type-hook*

Package

3bgl-shaders

Source

compiler.lisp (file)

Special Variable: *verbose*

enable debugging printouts

Package

3bgl-shaders

Source

walker.lisp (file)

5.2.2 Macros

Macro: %glsl-compiler-macro NAME LAMBDA-LIST &body BODY

Package

3bgl-shaders

Source

types.lisp (file)

Macro: %glsl-macro NAME LAMBDA-LIST &body BODY

Package

3bgl-shaders

Source

types.lisp (file)

Macro: assert-statement ()

Package

3bgl-shaders

Source

printer.lisp (file)

Macro: defclmacro NAME LAMBDA-LIST &body BODY

Package

3bgl-shaders

Source

walker.lisp (file)

Macro: defmethod2 NAME (A B) &body BODY

Package

3bgl-shaders

Source

infer.lisp (file)

Macro: defprint TYPE (OBJECT) &body BODY

Package

3bgl-shaders

Source

printer.lisp (file)

Macro: defprint-binop OP C-OP 0-ARG 1-ARG

Package

3bgl-shaders

Source

printer.lisp (file)

Macro: defprinti (FORM &rest ARGS) (&optional CALL) &body BODY

Package

3bgl-shaders

Source

printer.lisp (file)

Macro: defwalker WALKER (FORM &rest ARGS) &body BODY

Package

3bgl-shaders

Source

walker.lisp (file)

Macro: glsl-bind-interface STAGE BLOCK-NAME INTERFACE-QUALIFIER INSTANCE-NAME

Package

3bgl-glsl

Source

glsl-base.lisp (file)