Next: Introduction, Previous: (dir), 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 Mon Feb 26 16:17:51 2024 GMT+0.

Table of Contents

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

1 Introduction

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

2 Systems

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

dirt

Previous: Systems, 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

Child Components

package.lisp (file).
dirt.lisp (file).

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

3 Files

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

Lisp

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

3.1 Lisp

dirt/dirt.asd
dirt/package.lisp
dirt/dirt.lisp

Next: dirt/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `dirt/dirt.asd`

Source: dirt.asd.
Parent Component: dirt (system).
ASDF Systems: dirt.

Next: dirt/dirt.lisp, Previous: dirt/dirt.asd, Up: Lisp [Contents][Index]

3.1.2 `dirt/package.lisp`

Source: dirt.asd.
Parent Component: dirt (system).
Packages: dirt.

Previous: dirt/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `dirt/dirt.lisp`

Dependency

package.lisp (file).

Source

Parent Component

dirt (system).

Public Interface

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

Internals

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

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

4 Packages

Packages are listed by definition order.

dirt

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

4.1 `dirt`

Source

package.lisp.

Use List

common-lisp.

Public Interface

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

Internals

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

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

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions
Generic functions

Next: Generic functions, Previous: Public Interface, 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: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.2 Generic functions

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

Package

Source

Methods

Method: save-as-image ((texture texture) file-path &optional format) ¶

Method: save-as-image ((image c-array) file-path &optional format) ¶

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

5.2 Internals

Special variables

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

5.2.1 Special variables

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

Package: dirt.
Source: dirt.lisp.

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

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	F G L M S

	Index Entry		Section

F
	`Function, load-image-to-c-array`:		Public ordinary functions
	`Function, load-image-to-texture`:		Public ordinary functions

G
	`Generic Function, save-as-image`:		Public generic functions

L
	`load-image-to-c-array`:		Public ordinary functions
	`load-image-to-texture`:		Public ordinary functions

M
	`Method, save-as-image`:		Public generic functions
	`Method, save-as-image`:		Public generic functions

S
	`save-as-image`:		Public generic functions
	`save-as-image`:		Public generic functions
	`save-as-image`:		Public generic functions

Next: Data types, Previous: Functions, 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

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

A.4 Data types

Jump to:	D F P S

	Index Entry		Section

D
	`dirt`:		The dirt system
	`dirt`:		The dirt package
	`dirt.asd`:		The dirt/dirt․asd file
	`dirt.lisp`:		The dirt/dirt․lisp file

F
	`File, dirt.asd`:		The dirt/dirt․asd file
	`File, dirt.lisp`:		The dirt/dirt․lisp file
	`File, package.lisp`:		The dirt/package․lisp file

P
	`Package, dirt`:		The dirt package
	`package.lisp`:		The dirt/package․lisp file

S
	`System, dirt`:		The dirt system