The 3bgl-shader Reference Manual

This is the 3bgl-shader Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:09:29 2022 GMT+0.

1 Introduction
2 Systems
- 2.1 3bgl-shader
3 Files
- 3.1 Lisp
4 Packages
5 Definitions
- 5.1 Public Interface
- 5.2 Internals
Appendix A Indexes

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

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.

3bgl-shader

2.1 `3bgl-shader`

CL-hosted CL-like DSL for generating GLSL

Author

Bart Botta

License

MIT

Dependencies

alexandria (system).
bordeaux-threads (system).
cl-opengl (system).

Source

3bgl-shader.asd.

Child 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.

Lisp

3.1.1 `3bgl-shader/3bgl-shader.asd`

Source: 3bgl-shader.asd.
Parent Component: 3bgl-shader (system).
ASDF Systems: 3bgl-shader.

3.1.2 `3bgl-shader/package.lisp`

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Packages

3bgl-glsl/cl.
3bgl-glsl.
3bgl-shaders.

3.1.3 `3bgl-shader/ir.lisp`

Dependency

package.lisp (file).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Public Interface

initialize-instance (method).

Internals

allow-casts (reader method).
(setf allow-casts) (writer method).
argument-environment (reader method).
argument-environment (reader method).
(setf argument-environment) (writer method).
(setf argument-environment) (writer method).
arguments (reader method).
arguments (reader method).
(setf arguments) (writer method).
(setf arguments) (writer method).
array-access (class).
array-initialization (class).
binding (reader method).
binding (reader method).
binding (reader method).
binding (reader method).
binding (reader method).
(setf binding) (writer method).
(setf binding) (writer method).
(setf binding) (writer method).
(setf binding) (writer method).
(setf binding) (writer method).
binding (class).
binding-scope (class).
binding-with-dependencies (class).
bindings (reader method).
(setf bindings) (writer method).
bindings (class).
bindings-used-by (reader method).
bindings-using (reader method).
body (reader method).
(setf body) (writer method).
builtin-function (class).
called-function (reader method).
(setf called-function) (writer method).
condition-forms (reader method).
(setf condition-forms) (writer method).
conflicts (reader method).
(setf conflicts) (writer method).
constant-binding (class).
declarations (reader method).
declarations (reader method).
(setf declarations) (writer method).
(setf declarations) (writer method).
declared-type (reader method).
declared-type (reader method).
(setf declared-type) (writer method).
(setf declared-type) (writer method).
else-form (reader method).
(setf else-form) (writer method).
environment (reader method).
(setf environment) (writer method).
expander (reader method).
expander (reader method).
(setf expander) (writer method).
(setf expander) (writer method).
expansion (reader method).
(setf expansion) (writer method).
explicit-progn (class).
expression (reader method).
(setf expression) (writer method).
field (reader method).
field (reader method).
(setf field) (writer method).
(setf field) (writer method).
final-binding-type-cache (reader method).
(setf final-binding-type-cache) (writer 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 (reader method).
glsl-name (reader method).
(setf glsl-name) (writer method).
(setf glsl-name) (writer method).
if-form (class).
implicit-progn (class).
index (reader method).
(setf index) (writer method).
init-forms (reader method).
(setf init-forms) (writer method).
initial-value-form (reader method).
(setf initial-value-form) (writer method).
initialized-binding (class).
internal (reader method).
(setf internal) (writer method).
internal-function (class).
lambda-list (reader method).
(setf lambda-list) (writer method).
layout-qualifiers (reader method).
(setf layout-qualifiers) (writer method).
local-binding-type-data (reader method).
(setf local-binding-type-data) (writer method).
local-variable (class).
macro-definition (class).
min-size (reader method).
(setf min-size) (writer method).
name (method).
name (method).
name (method).
name (method).
name (method).
name (method).
name (reader method).
name (reader method).
name (method).
(setf name) (writer method).
(setf name) (writer method).
old-lambda-list (reader method).
(setf old-lambda-list) (writer method).
place (class).
progn-body (class).
qualifiers (reader method).
(setf qualifiers) (writer method).
raw-arguments (reader method).
raw-arguments (reader method).
(setf raw-arguments) (writer method).
(setf raw-arguments) (writer method).
slot-access (class).
step-forms (reader method).
(setf step-forms) (writer method).
swizzle-access (class).
symbol-macro (class).
test-form (reader method).
(setf test-form) (writer method).
then-form (reader method).
(setf then-form) (writer method).
type-inference-state (reader method).
(setf type-inference-state) (writer method).
unknown-function-binding (class).
valid-stages (reader method).
(setf valid-stages) (writer method).
value (reader method).
(setf value) (writer method).
value-type (method).
value-type (reader method).
value-type (reader method).
value-type (reader method).
value-type (reader method).
value-type (reader method).
(setf value-type) (writer method).
(setf value-type) (writer method).
(setf value-type) (writer method).
(setf value-type) (writer method).
(setf value-type) (writer 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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

*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 (reader method).
default-env (function).
defclmacro (macro).
defwalker (macro).
ensure-package-environment (function).
environment (class).
function-bindings (reader 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 (reader method).
(setf locked) (writer method).
make-&key-expander (function).
name (reader method).
parent-scope (reader method).
remove-function (function).
types (reader method).
variable-bindings (reader method).
walk (generic function).
walk-cons (generic function).
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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Public Interface

(setf modified) (writer method).
modified (reader method).
stage (reader method).
(setf stage) (writer method).

Internals

%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 (reader method).
array-size (reader method).
array-size (reader method).
(setf array-size) (writer method).
(setf array-size) (writer method).
(setf array-size) (writer method).
array-type (class).
base-type (reader method).
base-type (reader method).
(setf base-type) (writer method).
(setf base-type) (writer method).
bind-interface (function).
binding (reader method).
(setf binding) (writer method).
concrete-type (class).
default (reader method).
(setf default) (writer method).
explicit-casts (reader method).
(setf explicit-casts) (writer method).
generic-type (class).
glsl-name (reader method).
(setf glsl-name) (writer method).
implicit-casts-from (method).
implicit-casts-from (reader method).
(setf implicit-casts-from) (writer method).
implicit-casts-to (method).
implicit-casts-to (reader method).
(setf implicit-casts-to) (writer method).
in/out/uniform/attrib (function).
interface-binding (class).
interface-block (reader method).
(setf interface-block) (writer method).
interface-qualifier (reader method).
(setf interface-qualifier) (writer method).
interface-stage-binding (class).
interface-type (class).
internal (reader method).
internal (reader method).
(setf internal) (writer method).
(setf internal) (writer method).
layout-qualifier (reader method).
(setf layout-qualifier) (writer method).
name (reader method).
(setf name) (writer method).
process-type-declarations-for-scope (method).
scalar/vector-set (reader method).
(setf scalar/vector-set) (writer method).
scalar/vector-size (reader method).
(setf scalar/vector-size) (writer method).
stage-binding (method).
stage-binding (method).
stage-bindings (reader method).
(setf stage-bindings) (writer method).
struct-type (class).
value-type (method).
value-type (method).
value-type (method).

3.1.6 `3bgl-shader/infer.lisp`

Dependency

types.lisp (file).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

*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 (reader method).
(setf arg-type) (writer method).
argument-types (reader method).
argument-types (reader method).
(setf argument-types) (writer method).
(setf argument-types) (writer method).
array-access-constraint (class).
base-type (reader method).
(setf base-type) (writer method).
called-function (reader method).
(setf called-function) (writer method).
cast-constraint (class).
cast-to-boolean (function).
cast-type (reader method).
(setf cast-type) (writer method).
constrained-type (class).
constraint (class).
constraints (reader method).
constraints (reader method).
(setf constraints) (writer method).
(setf constraints) (writer 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 (reader method).
(setf ctype) (writer 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 (reader method).
(setf equiv) (writer 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 (reader method).
(setf function-types) (writer method).
function-types-by-arity (reader method).
(setf function-types-by-arity) (writer method).
get-equiv-type (method).
get-equiv-type (method).
get-only-hash-key (function).
global-function (reader method).
(setf global-function) (writer method).
global-function-constraint (class).
in-type (reader method).
(setf in-type) (writer 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 (reader method).
(setf max-arity) (writer method).
min-arity (reader method).
(setf min-arity) (writer method).
min-size (reader method).
min-size (reader method).
(setf min-size) (writer method).
(setf min-size) (writer method).
modified (reader method).
(setf modified) (writer method).
name (reader method).
name (reader method).
name (reader method).
(setf name) (writer method).
(setf name) (writer method).
(setf name) (writer method).
optional-arg-type (class).
other-type (reader method).
(setf other-type) (writer method).
out-size (reader method).
(setf out-size) (writer method).
out-type (reader method).
(setf out-type) (writer method).
print-bindings/ret (function).
ref-type (class).
return-type (reader method).
return-type (reader method).
(setf return-type) (writer method).
(setf return-type) (writer 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 (reader method).
(setf types) (writer 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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Public Interface

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

Internals

*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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

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).
Source: 3bgl-shader.asd.
Parent Component: 3bgl-shader (system).

3.1.10 `3bgl-shader/finalize-inference.lisp`

Dependency

glsl.lisp (file).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

*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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

%print (generic function).
%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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

*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 (reader 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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Public Interface

*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).

Internals

*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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

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).

Source

3bgl-shader.asd.

Parent Component

3bgl-shader (system).

Internals

%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 (reader method).
ensure-compiled (function).
flag-shader (function).
live-uniforms (reader method).
(setf live-uniforms) (writer method).
name-map (reader method).
program (reader method).
recompilation-callbacks (reader method).
(setf recompilation-callbacks) (writer method).
reset-program (function).
shader-program (function).
shader-program (class).
ssbos (reader method).
stages (reader method).
structs (reader method).
uniform (generic function).
(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 (reader method).
use-program (method).
version (reader method).
(setf version) (writer method).
with-program (macro).

4 Packages

Packages are listed by definition order.

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

4.1 `3bgl-glsl/cl`

Source

package.lisp.

Use List

3bgl-glsl.
common-lisp.

4.2 `3bgl-glsl`

Source

package.lisp.

Use List

common-lisp.

Used By List

3bgl-glsl/cl.

Public Interface

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).

Internals

*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.

Use List

common-lisp.

Public Interface

*default-version* (special variable).
*modified-function-hook* (special variable).
compile-form (function).
generate-stage (function).
stage (generic reader).
(setf stage) (generic writer).

Internals

%glsl-compiler-macro (macro).
%glsl-macro (macro).
%print (generic function).
%reload-program (function).
%translate-name (function).
(setf %uniform) (generic function).
*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-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 reader).
(setf allow-casts) (generic writer).
any-type (class).
arg-type (generic reader).
(setf arg-type) (generic writer).
argument-environment (generic reader).
(setf argument-environment) (generic writer).
argument-types (generic reader).
(setf argument-types) (generic writer).
arguments (generic reader).
(setf arguments) (generic writer).
array-access (class).
array-access-constraint (class).
array-initialization (class).
array-size (generic reader).
(setf array-size) (generic writer).
array-suffix (generic function).
array-type (class).
assert-statement (macro).
base-type (generic reader).
(setf base-type) (generic writer).
bind-interface (function).
binding (generic reader).
(setf binding) (generic writer).
binding (class).
binding-scope (class).
binding-with-dependencies (class).
bindings (generic reader).
(setf bindings) (generic writer).
bindings (class).
bindings-used-by (generic reader).
bindings-using (generic reader).
body (generic reader).
(setf body) (generic writer).
builtin-function (class).
cache-binding (function).
called-function (generic reader).
(setf called-function) (generic writer).
cast-constraint (class).
cast-to-boolean (function).
cast-type (generic reader).
(setf cast-type) (generic writer).
check-locked (function).
check-slot-stages (generic function).
check-stages (generic function).
cl-walker (class).
compiler-macro-bindings (generic reader).
concrete-type (class).
condition-forms (generic reader).
(setf condition-forms) (generic writer).
conflicts (generic reader).
(setf conflicts) (generic writer).
constant-binding (class).
constrained-type (class).
constraint (class).
constraints (generic reader).
(setf constraints) (generic writer).
copy-constraints (generic function).
copy-unify-constraints (function).
ctype (generic reader).
(setf ctype) (generic writer).
ctype/other-constraint (class).
debug-local-binding-type-data (function).
debug-type-names (function).
declarations (generic reader).
(setf declarations) (generic writer).
declared-type (generic reader).
(setf declared-type) (generic writer).
default (generic reader).
(setf default) (generic writer).
default-env (function).
defclmacro (macro).
defmethod2 (macro).
defprint (macro).
defprint-binop (macro).
defprinti (macro).
defwalker (macro).
dirty (generic reader).
dump-constraint (generic function).
else-form (generic reader).
(setf else-form) (generic writer).
ensure-compiled (function).
ensure-package-environment (function).
environment (generic reader).
(setf environment) (generic writer).
environment (class).
equiv (generic reader).
(setf equiv) (generic writer).
expand-buffers (function).
expand-extension-keyword (function).
expand-optional-arg-type (function).
expand-structs (function).
expand-uniform-slots (generic function).
expand-uniforms (function).
expander (generic reader).
(setf expander) (generic writer).
expansion (generic reader).
(setf expansion) (generic writer).
explicit-casts (generic reader).
(setf explicit-casts) (generic writer).
explicit-progn (class).
expression (generic reader).
(setf expression) (generic writer).
extract-functions (class).
field (generic reader).
(setf field) (generic writer).
final-binding-type-cache (generic reader).
(setf final-binding-type-cache) (generic writer).
finalize (class).
finalize-inference (function).
flag-modified-constraint (function).
flag-modified-type (function).
flag-shader (function).
flatten-function (function).
flatten-type (generic function).
flatten-types (generic function).
for-loop (class).
function-application (class).
function-argument (class).
function-binding (class).
function-binding-function (class).
function-bindings (generic reader).
function-call (class).
function-signature-changed (function).
function-types (generic reader).
(setf function-types) (generic writer).
function-types-by-arity (generic reader).
(setf function-types-by-arity) (generic writer).
generate-output (generic function).
generic-type (class).
get-compiler-macro-binding (function).
get-compiler-macro-function (function).
get-concrete-type (generic function).
get-equiv-type (generic function).
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 reader).
(setf global-function) (generic writer).
global-function (class).
global-function-constraint (class).
global-variable (class).
glsl-name (generic reader).
(setf glsl-name) (generic writer).
if-form (class).
implicit-casts-from (generic function).
(setf implicit-casts-from) (generic writer).
implicit-casts-to (generic function).
(setf implicit-casts-to) (generic writer).
implicit-progn (class).
in-type (generic reader).
(setf in-type) (generic writer).
in/out/uniform/attrib (function).
incomplete-dependent (condition).
index (generic reader).
(setf index) (generic writer).
infer (function).
infer-build-constraints (class).
infer-modified-functions (function).
inference-call-site (class).
inference-failure (condition).
init-forms (generic reader).
(setf init-forms) (generic writer).
initial-value-form (generic reader).
(setf initial-value-form) (generic writer).
initialized-binding (class).
integral-type (generic function).
interface-binding (class).
interface-block (generic reader).
(setf interface-block) (generic writer).
interface-qualifier (generic reader).
(setf interface-qualifier) (generic writer).
interface-stage-binding (class).
interface-type (class).
internal (generic reader).
(setf internal) (generic writer).
internal-function (class).
is-type (generic function).
lambda-list (generic reader).
(setf lambda-list) (generic writer).
lambda-list-vars (function).
layout-qualifier (generic reader).
(setf layout-qualifier) (generic writer).
layout-qualifiers (generic reader).
(setf layout-qualifiers) (generic writer).
live-uniforms (generic reader).
(setf live-uniforms) (generic writer).
local-binding-type-data (generic reader).
(setf local-binding-type-data) (generic writer).
local-variable (class).
locked (generic reader).
(setf locked) (generic writer).
macro-definition (class).
make-&key-expander (function).
max-arity (generic reader).
(setf max-arity) (generic writer).
min-arity (generic reader).
(setf min-arity) (generic writer).
min-size (generic reader).
(setf min-size) (generic writer).
modified (generic reader).
(setf modified) (generic writer).
name (generic function).
(setf name) (generic writer).
name-map (generic reader).
old-lambda-list (generic reader).
(setf old-lambda-list) (generic writer).
optional-arg-type (class).
other-type (generic reader).
(setf other-type) (generic writer).
out-size (generic reader).
(setf out-size) (generic writer).
out-type (generic reader).
(setf out-type) (generic writer).
parent-scope (generic reader).
place (class).
pprint-glsl (function).
print-bindings/ret (function).
print-main-layout-qualifiers (function).
process-type-declarations-for-scope (generic function).
progn-body (class).
program (generic reader).
qualifiers (generic reader).
(setf qualifiers) (generic writer).
raw-arguments (generic reader).
(setf raw-arguments) (generic writer).
recompilation-callbacks (generic reader).
(setf recompilation-callbacks) (generic writer).
ref-type (class).
reload-program (function).
remove-function (function).
reset-program (function).
return-type (generic reader).
(setf return-type) (generic writer).
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 reader).
(setf scalar/vector-set) (generic writer).
scalar/vector-size (generic reader).
(setf scalar/vector-size) (generic writer).
set-type (function).
shader-program (function).
shader-program (class).
slot-access (class).
sort-interface-qualifiers (function).
ssbos (generic reader).
stage-binding (generic function).
stage-bindings (generic reader).
(setf stage-bindings) (generic writer).
stages (generic reader).
step-forms (generic reader).
(setf step-forms) (generic writer).
struct-type (class).
structs (generic reader).
swizzle-access (class).
symbol-macro (class).
test-form (generic reader).
(setf test-form) (generic writer).
then-form (generic reader).
(setf then-form) (generic writer).
topo-sort-dependencies (function).
translate-interface-qualifiers (function).
translate-name (generic function).
translate-slot-name (generic function).
translate-type (generic function).
tree-shaker (function).
tree-shaker (class).
type-inference-state (generic reader).
(setf type-inference-state) (generic writer).
types (generic function).
(setf types) (generic writer).
unifiable-types-p (generic function).
uniform (generic function).
(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 reader).
unify (generic function).
unknown-function-binding (class).
update-calls (class).
update-constraint (generic function).
update-dependencies (function).
use-program (generic function).
valid-stages (generic reader).
(setf valid-stages) (generic writer).
value (generic reader).
(setf value) (generic writer).
value-type (generic function).
(setf value-type) (generic writer).
variable-arity-function-application (class).
variable-binding (class).
variable-bindings (generic reader).
variable-read (class).
variable-write (class).
vector->{} (function).
version (generic reader).
(setf version) (generic writer).
walk (generic function).
walk-cons (generic function).
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.

Public Interface
Internals

5.1 Public Interface

Special variables
Macros
Ordinary functions
Generic functions
Standalone methods

5.1.1 Special variables

Special Variable: *default-version* ¶

Package: 3bgl-shaders.
Source: api.lisp.

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.

5.1.2 Macros

Macro: attribute (name type &rest args &key location) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: bind-interface (stage block-name interface-qualifier instance-name) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: defconstant (name value type) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: defmacro (name args &body body) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: defstruct (name &rest slots) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: defun (name args &body body) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: glsl-attribute (name type &rest args &key location) ¶

Package: 3bgl-glsl.
Source: glsl-base.lisp.

Macro: glsl-defconstant (name value type) ¶

Package: 3bgl-glsl.
Source: glsl-base.lisp.

Macro: glsl-defun (name args &body body) ¶

Package: 3bgl-glsl.
Source: glsl-base.lisp.

Macro: glsl-input (name type &rest args &key stage location) ¶

Package: 3bgl-glsl.
Source: glsl-base.lisp.

Macro: glsl-interface (name (&rest args &key in out uniform) &body slots) ¶

Package: 3bgl-glsl.
Source: glsl-base.lisp.

Macro: glsl-output (name type &rest args &key stage location) ¶

Package: 3bgl-glsl.
Source: glsl-base.lisp.

Macro: glsl-uniform (name type &rest args &key stage location) ¶

Package: 3bgl-glsl.
Source: glsl-base.lisp.

Macro: input (name type &rest args &key stage location qualifiers) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: interface (name (&rest args &key in out uniform buffer layout) &body slots) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: output (name type &rest args &key stage location qualifiers) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: shared (name type &rest args &key stage layout qualifiers &allow-other-keys) ¶

Package: 3bgl-glsl.
Source: api.lisp.

Macro: uniform (name type &rest args &key stage location internal layout qualifiers default &allow-other-keys) ¶

Package: 3bgl-glsl.
Source: api.lisp.

5.1.3 Ordinary 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.

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.

5.1.4 Generic functions

Generic Reader: stage (object) ¶

Package

The 3bgl-shader Reference Manual

The 3bgl-shader Reference Manual

Table of Contents

1 Introduction

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

Features

Minimal Example shader program

Convert to glsl

Hooks for interactive use

Current status

Misc notes

Concrete types

Component swizzles

Structure/interface slots

RETURN

Overloaded functions

Type declarations

Uniforms, input, output, interface

Running the example programs

Getting names of uniforms/vertex attributes

Macros

Array variables

Compute Shaders

Shared variables in compute shaders

Shader Storage Buffer Objects

Structures

2 Systems

2.1 3bgl-shader

3 Files

3.1 Lisp

3.1.1 3bgl-shader/3bgl-shader.asd

3.1.2 3bgl-shader/package.lisp

3.1.3 3bgl-shader/ir.lisp

3.1.4 3bgl-shader/walker.lisp

3.1.5 3bgl-shader/types.lisp

3.1.6 3bgl-shader/infer.lisp

3.1.7 3bgl-shader/glsl-base.lisp

3.1.8 3bgl-shader/cl-functions.lisp

3.1.9 3bgl-shader/glsl.lisp

3.1.10 3bgl-shader/finalize-inference.lisp

3.1.11 3bgl-shader/printer.lisp

3.1.12 3bgl-shader/compiler.lisp

3.1.13 3bgl-shader/api.lisp

3.1.14 3bgl-shader/old-utils.lisp

3.1.15 3bgl-shader/utils.lisp

4 Packages

4.1 3bgl-glsl/cl

4.2 3bgl-glsl

4.3 3bgl-shaders

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Macros

5.1.3 Ordinary functions

5.1.4 Generic functions

5.1.5 Standalone methods

5.2 Internals

5.2.1 Special variables

5.2.2 Macros

5.2.3 Ordinary functions

5.2.4 Generic functions

5.2.5 Conditions

5.2.6 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

2.1 `3bgl-shader`

3.1.1 `3bgl-shader/3bgl-shader.asd`

3.1.2 `3bgl-shader/package.lisp`

3.1.3 `3bgl-shader/ir.lisp`

3.1.4 `3bgl-shader/walker.lisp`

3.1.5 `3bgl-shader/types.lisp`

3.1.6 `3bgl-shader/infer.lisp`

3.1.7 `3bgl-shader/glsl-base.lisp`

3.1.8 `3bgl-shader/cl-functions.lisp`

3.1.9 `3bgl-shader/glsl.lisp`

3.1.10 `3bgl-shader/finalize-inference.lisp`

3.1.11 `3bgl-shader/printer.lisp`

3.1.12 `3bgl-shader/compiler.lisp`

3.1.13 `3bgl-shader/api.lisp`

3.1.14 `3bgl-shader/old-utils.lisp`

3.1.15 `3bgl-shader/utils.lisp`

4.1 `3bgl-glsl/cl`

4.2 `3bgl-glsl`

4.3 `3bgl-shaders`