The dirt Reference Manual

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

The dirt Reference Manual

This is the dirt Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:37:52 2022 GMT+0.

Table of Contents

Next: , Previous: , Up: The dirt Reference Manual   [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: The dirt Reference Manual   [Contents][Index]

2 Systems

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

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

2.1 dirt

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

Author

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

License

BSD 2 Clause

Dependencies
  • cepl (system).
  • cl-soil (system).
Source

dirt.asd.

Child Components

Next: , Previous: , Up: The dirt Reference Manual   [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   [Contents][Index]

3.1.1 dirt/dirt.asd

Source

dirt.asd.

Parent Component

dirt (system).

ASDF Systems

dirt.

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

3.1.2 dirt/package.lisp

Source

dirt.asd.

Parent Component

dirt (system).

Packages

dirt.

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

3.1.3 dirt/dirt.lisp

Dependency

package.lisp (file).

Source

dirt.asd.

Parent Component

dirt (system).

Public Interface
Internals

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

Next: , Previous: , Up: The dirt Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

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

4.1 dirt

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

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

Next: , Previous: , Up: The dirt Reference Manual   [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 Public Interface

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.1 Ordinary functions

Function: load-image-to-c-array (filename &optional image-format)
Package

dirt.

Source

dirt.lisp.

Function: load-image-to-texture (filename &optional image-format mipmap generate-mipmaps)
Package

dirt.

Source

dirt.lisp.

Previous: , Up: Public Interface   [Contents][Index]

5.1.2 Generic functions

Generic Function: save-as-image (texture file-path &optional format)
Package

dirt.

Source

dirt.lisp.

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 Internals

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

5.2.1 Special variables

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

dirt.

Source

dirt.lisp.

Previous: , Up: The dirt Reference Manual   [Contents][Index]

Appendix A Indexes

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

A.1 Concepts

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section
*
*valid-save-image-formats*: Private special variables
S
Special Variable, *valid-save-image-formats*: Private special variables
Jump to:   *  
S