The glsl-packing Reference Manual

Table of Contents

The glsl-packing Reference Manual

This is the glsl-packing Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:10:49 2020 GMT+0.

1 Systems

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

1.1 glsl-packing

Author

Bart Botta <00003b at gmail.com>

License

MIT

Description

calculate std140/std430 layout for a glsl UBO/SSBO

Dependency

alexandria

Source

glsl-packing.asd (file)

Components

• glsl-packing.lisp (file)
• base-types.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 glsl-packing.asd

Location

glsl-packing.asd

Systems

glsl-packing (system)

2.1.2 glsl-packing/glsl-packing.lisp

Parent

glsl-packing (system)

Location

glsl-packing.lisp

Packages

glsl-packing

Exported Definitions

pack-structs (function)

Internal Definitions

• *dump-base-types* (special variable)
• *dumped-types* (special variable)
• *known-types* (special variable)
• *major* (special variable)
• *output* (special variable)
• *packing* (special variable)
• *type-dependencies* (special variable)
• *used-types* (special variable)
• align (function)
• align* (generic function)
• align* (method)
• align* (method)
• align* (method)
• align* (method)
• align* (method)
• base-type (type)
• block/buffer/struct (type)
• dump (function)
• dump* (generic function)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• get-type (function)
• lit (function)
• round-to-multiple-of (function)
• scalar (type)
• size (function)
• size* (generic function)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• stride (function)
• stride* (generic function)
• stride* (method)
• stride* (method)
• stride* (method)
• type-description (type)

2.1.3 glsl-packing/base-types.lisp

Dependency

glsl-packing.lisp (file)

Parent

glsl-packing (system)

Location

base-types.lisp

Exported Definitions

• *base-types* (special variable)
• expand-glsl-type (function)
• expand-glsl-types (function)

3 Packages

Packages are listed by definition order.

3.1 glsl-packing

Source

glsl-packing.lisp (file)

Use List

common-lisp

Exported Definitions

• *base-types* (special variable)
• expand-glsl-type (function)
• expand-glsl-types (function)
• pack-structs (function)

Internal Definitions

• *dump-base-types* (special variable)
• *dumped-types* (special variable)
• *known-types* (special variable)
• *major* (special variable)
• *output* (special variable)
• *packing* (special variable)
• *type-dependencies* (special variable)
• *used-types* (special variable)
• align (function)
• align* (generic function)
• align* (method)
• align* (method)
• align* (method)
• align* (method)
• align* (method)
• base-type (type)
• block/buffer/struct (type)
• dump (function)
• dump* (generic function)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• dump* (method)
• get-type (function)
• lit (function)
• round-to-multiple-of (function)
• scalar (type)
• size (function)
• size* (generic function)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• size* (method)
• stride (function)
• stride* (generic function)
• stride* (method)
• stride* (method)
• stride* (method)
• type-description (type)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *base-types*

Package

glsl-packing

Source

base-types.lisp (file)

4.1.2 Functions

Function: expand-glsl-type TYPE &key DEFAULT

Package

glsl-packing

Source

base-types.lisp (file)

Function: expand-glsl-types SLOTS

Expand glsl types like :vec4 to style expected by pack-structs in list of slot definitions. Types of the form (TYPE X) are treated as arrays, with dimension X, where * or :* means unspecified size.

Package

glsl-packing

Source

base-types.lisp (file)

Function: pack-structs TYPES &key ROOTS DUMP-BASE-TYPES

TYPES is a list of lists (NAME TYPE) which is processed like a sequence of calls to PACK-STRUCT, except with the ability to refer to previous types by name. if NAME is :packing or :major, TYPE is interpreted as new default value for corresponding arguments to PACK-STRUCT for following definitions. If ROOTS is specified, it should be a list of block names to use as roots when removing unused types from output. If DUMP-BASE-TYPES is true, output will include data for used scalar/vec/mat types types.

Package

glsl-packing

Source

glsl-packing.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *dump-base-types*

Package

glsl-packing

Source

glsl-packing.lisp (file)

Special Variable: *dumped-types*

Package

glsl-packing

Source

glsl-packing.lisp (file)

Special Variable: *known-types*

Package

glsl-packing

Source

glsl-packing.lisp (file)

Special Variable: *major*

Package

glsl-packing

Source

glsl-packing.lisp (file)

Special Variable: *output*

Package

glsl-packing

Source

glsl-packing.lisp (file)

Special Variable: *packing*

Package

glsl-packing

Source

glsl-packing.lisp (file)

Special Variable: *type-dependencies*

Package

glsl-packing

Source

glsl-packing.lisp (file)

Special Variable: *used-types*

Package

glsl-packing

Source

glsl-packing.lisp (file)

4.2.2 Functions

Function: align TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

Function: dump TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

Function: get-type TYPE &key ERRORP

Package

glsl-packing

Source

glsl-packing.lisp (file)

Function: lit N

Package

glsl-packing

Source

glsl-packing.lisp (file)

Function: round-to-multiple-of VALUE GRANULARITY

Package

glsl-packing

Source

glsl-packing.lisp (file)

Function: size TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

Function: stride TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

4.2.3 Generic functions

Generic Function: align* BASE TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

Methods

Method: align* (BASE (eql struct)) TYPE

Method: align* (BASE (eql array)) TYPE

Method: align* (BASE (eql mat)) TYPE

Method: align* (BASE (eql vec)) TYPE

Method: align* BASE TYPE

Generic Function: dump* BASE TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

Methods

Method: dump* (BASE (eql buffer-block)) TYPE

Method: dump* (BASE (eql block)) TYPE

Method: dump* (BASE (eql struct)) TYPE

Method: dump* (BASE (eql array)) TYPE

Method: dump* (BASE (eql mat)) TYPE

Method: dump* (BASE (eql vec)) TYPE

Method: dump* BASE TYPE

Generic Function: size* BASE TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

Methods

Method: size* (BASE (eql buffer-block)) TYPE

Method: size* (BASE (eql block)) TYPE

Method: size* (BASE (eql array)) TYPE

Method: size* (BASE (eql mat)) TYPE

Method: size* (BASE (eql vec)) TYPE

Method: size* (BASE (eql float)) TYPE

Method: size* (BASE (eql uint)) TYPE

Method: size* (BASE (eql int)) TYPE

Method: size* (BASE (eql bool)) TYPE

Generic Function: stride* BASE TYPE

Package

glsl-packing

Source

glsl-packing.lisp (file)

Methods

Method: stride* (BASE (eql array)) TYPE

Method: stride* (BASE (eql mat)) TYPE

Method: stride* BASE TYPE

4.2.4 Types

Type: base-type ()

Package

glsl-packing

Source

glsl-packing.lisp (file)

Type: block/buffer/struct ()

Package

glsl-packing

Source

glsl-packing.lisp (file)

Type: scalar ()

Package

glsl-packing

Source

glsl-packing.lisp (file)

Type: type-description ()

Package

glsl-packing

Source

glsl-packing.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types