The glsl-packing Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The glsl-packing Reference Manual

This is the glsl-packing Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:53:12 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

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

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 glsl-packing.asd

Location

glsl-packing.asd

Systems

glsl-packing (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Previous: , Up: Lisp files   [Contents][Index]

2.1.3 glsl-packing/base-types.lisp

Dependency

glsl-packing.lisp (file)

Parent

glsl-packing (system)

Location

base-types.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

3.1 glsl-packing

Source

glsl-packing.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Special variables

Special Variable: *base-types*
Package

glsl-packing

Source

base-types.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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

Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   G   L  
Index Entry  Section

F
File, Lisp, glsl-packing.asd: The glsl-packing<dot>asd file
File, Lisp, glsl-packing/base-types.lisp: The glsl-packing/base-types<dot>lisp file
File, Lisp, glsl-packing/glsl-packing.lisp: The glsl-packing/glsl-packing<dot>lisp file

G
glsl-packing.asd: The glsl-packing<dot>asd file
glsl-packing/base-types.lisp: The glsl-packing/base-types<dot>lisp file
glsl-packing/glsl-packing.lisp: The glsl-packing/glsl-packing<dot>lisp file

L
Lisp File, glsl-packing.asd: The glsl-packing<dot>asd file
Lisp File, glsl-packing/base-types.lisp: The glsl-packing/base-types<dot>lisp file
Lisp File, glsl-packing/glsl-packing.lisp: The glsl-packing/glsl-packing<dot>lisp file

Jump to:   F   G   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   E   F   G   L   M   P   R   S  
Index Entry  Section

A
align: Internal functions
align*: Internal generic functions
align*: Internal generic functions
align*: Internal generic functions
align*: Internal generic functions
align*: Internal generic functions
align*: Internal generic functions

D
dump: Internal functions
dump*: Internal generic functions
dump*: Internal generic functions
dump*: Internal generic functions
dump*: Internal generic functions
dump*: Internal generic functions
dump*: Internal generic functions
dump*: Internal generic functions
dump*: Internal generic functions

E
expand-glsl-type: Exported functions
expand-glsl-types: Exported functions

F
Function, align: Internal functions
Function, dump: Internal functions
Function, expand-glsl-type: Exported functions
Function, expand-glsl-types: Exported functions
Function, get-type: Internal functions
Function, lit: Internal functions
Function, pack-structs: Exported functions
Function, round-to-multiple-of: Internal functions
Function, size: Internal functions
Function, stride: Internal functions

G
Generic Function, align*: Internal generic functions
Generic Function, dump*: Internal generic functions
Generic Function, size*: Internal generic functions
Generic Function, stride*: Internal generic functions
get-type: Internal functions

L
lit: Internal functions

M
Method, align*: Internal generic functions
Method, align*: Internal generic functions
Method, align*: Internal generic functions
Method, align*: Internal generic functions
Method, align*: Internal generic functions
Method, dump*: Internal generic functions
Method, dump*: Internal generic functions
Method, dump*: Internal generic functions
Method, dump*: Internal generic functions
Method, dump*: Internal generic functions
Method, dump*: Internal generic functions
Method, dump*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, size*: Internal generic functions
Method, stride*: Internal generic functions
Method, stride*: Internal generic functions
Method, stride*: Internal generic functions

P
pack-structs: Exported functions

R
round-to-multiple-of: Internal functions

S
size: Internal functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
size*: Internal generic functions
stride: Internal functions
stride*: Internal generic functions
stride*: Internal generic functions
stride*: Internal generic functions
stride*: Internal generic functions

Jump to:   A   D   E   F   G   L   M   P   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*base-types*: Exported special variables
*dump-base-types*: Internal special variables
*dumped-types*: Internal special variables
*known-types*: Internal special variables
*major*: Internal special variables
*output*: Internal special variables
*packing*: Internal special variables
*type-dependencies*: Internal special variables
*used-types*: Internal special variables

S
Special Variable, *base-types*: Exported special variables
Special Variable, *dump-base-types*: Internal special variables
Special Variable, *dumped-types*: Internal special variables
Special Variable, *known-types*: Internal special variables
Special Variable, *major*: Internal special variables
Special Variable, *output*: Internal special variables
Special Variable, *packing*: Internal special variables
Special Variable, *type-dependencies*: Internal special variables
Special Variable, *used-types*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   G   P   S   T  
Index Entry  Section

B
base-type: Internal types
block/buffer/struct: Internal types

G
glsl-packing: The glsl-packing system
glsl-packing: The glsl-packing package

P
Package, glsl-packing: The glsl-packing package

S
scalar: Internal types
System, glsl-packing: The glsl-packing system

T
Type, base-type: Internal types
Type, block/buffer/struct: Internal types
Type, scalar: Internal types
Type, type-description: Internal types
type-description: Internal types

Jump to:   B   G   P   S   T