The dirt Reference Manual

Table of Contents

The dirt Reference Manual

This is the dirt Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:38:37 2022 GMT+0.

1 Introduction

dirt

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

2 Systems

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

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

• cepl
• cl-soil

Source

dirt.asd (file)

Components

• package.lisp (file)
• dirt.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 dirt.asd

Location

dirt.asd

Systems

dirt (system)

3.1.2 dirt/package.lisp

Parent

dirt (system)

Location

package.lisp

Packages

dirt

3.1.3 dirt/dirt.lisp

Dependency

package.lisp (file)

Parent

dirt (system)

Location

dirt.lisp

Exported Definitions

• load-image-to-c-array (function)
• load-image-to-texture (function)
• save-as-image (generic function)
• save-as-image (method)
• save-as-image (method)

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 dirt

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• load-image-to-c-array (function)
• load-image-to-texture (function)
• save-as-image (generic function)
• save-as-image (method)
• save-as-image (method)

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

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)

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

5.2 Internal definitions

5.2.1 Special variables

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

Package

dirt

Source

dirt.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types