The dirt Reference Manual

Table of Contents

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

The dirt Reference Manual

This is the dirt Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:42:02 2018 GMT+0.


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

1 Introduction

dirt

A front-end for cl-soil which loads images straight to cepl:c-arrays and cepl:textures


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

2 Systems

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


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

2.1 dirt

Author

Chris Bagley (Baggers) <techsnuffle@gmail.com>

License

BSD 2 Clause

Description

A front-end for cl-soil which loads images straight to cepl:c-arrays and cepl:textures

Dependencies
Source

dirt.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 dirt.asd

Location

dirt.asd

Systems

dirt (system)


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

3.1.2 dirt/package.lisp

Parent

dirt (system)

Location

package.lisp

Packages

dirt


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

3.1.3 dirt/dirt.lisp

Dependency

package.lisp (file)

Parent

dirt (system)

Location

dirt.lisp

Exported Definitions
Internal Definitions

*valid-save-image-formats* (special variable)


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

4 Packages

Packages are listed by definition order.


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

4.1 dirt

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

*valid-save-image-formats* (special variable)


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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: load-image-to-c-array FILENAME &optional IMAGE-FORMAT
Package

dirt

Source

dirt.lisp (file)

Function: load-image-to-texture FILENAME &optional IMAGE-FORMAT MIPMAP GENERATE-MIPMAPS
Package

dirt

Source

dirt.lisp (file)


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

5.1.2 Generic functions

Generic Function: save-as-image TEXTURE FILE-PATH &optional FORMAT
Package

dirt

Source

dirt.lisp (file)

Methods
Method: save-as-image (TEXTURE texture) FILE-PATH &optional FORMAT
Method: save-as-image (IMAGE c-array) FILE-PATH &optional FORMAT

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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *valid-save-image-formats*
Package

dirt

Source

dirt.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   D   F   L  
Index Entry  Section

D
dirt.asd: The dirt<dot>asd file
dirt/dirt.lisp: The dirt/dirt<dot>lisp file
dirt/package.lisp: The dirt/package<dot>lisp file

F
File, Lisp, dirt.asd: The dirt<dot>asd file
File, Lisp, dirt/dirt.lisp: The dirt/dirt<dot>lisp file
File, Lisp, dirt/package.lisp: The dirt/package<dot>lisp file

L
Lisp File, dirt.asd: The dirt<dot>asd file
Lisp File, dirt/dirt.lisp: The dirt/dirt<dot>lisp file
Lisp File, dirt/package.lisp: The dirt/package<dot>lisp file

Jump to:   D   F   L  

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

A.2 Functions

Jump to:   F   G   L   M   S  
Index Entry  Section

F
Function, load-image-to-c-array: Exported functions
Function, load-image-to-texture: Exported functions

G
Generic Function, save-as-image: Exported generic functions

L
load-image-to-c-array: Exported functions
load-image-to-texture: Exported functions

M
Method, save-as-image: Exported generic functions
Method, save-as-image: Exported generic functions

S
save-as-image: Exported generic functions
save-as-image: Exported generic functions
save-as-image: Exported generic functions

Jump to:   F   G   L   M   S  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*valid-save-image-formats*: Internal special variables

S
Special Variable, *valid-save-image-formats*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   D   P   S  
Index Entry  Section

D
dirt: The dirt system
dirt: The dirt package

P
Package, dirt: The dirt package

S
System, dirt: The dirt system

Jump to:   D   P   S