The cl-tga Reference Manual

Table of Contents

The cl-tga Reference Manual

This is the cl-tga Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:25:34 2018 GMT+0.

1 Introduction

CL-TGA

Cl-tga was written to facilitate loading .tga files into OpenGL programs. It's a very simple library, and, at the moment, only supports non-RLE encoded forms of the files, though it shouldn't be hard to fix that.

Cl-tga does not re-order the color bytes from the file body. tga files are econded in bgr byte-order, and so loading code using cl-opengl should specify the :bgr or :bgra data format in order to not have wonky looking textures, eg.:

(gl:tex-image-2d :texture-2d 0 :rgba
		 (tga:image-width image) (tga:image-height image)
		 0
		 (ecase (tga:image-channels image)
		   (3 :bgr)
	  	   (4 :bgra))
		 :unsigned-byte (tga:image-data image))

Dictionary

read-tga filespec => tga

Takes a filespec and returns a cl-tga::tga instance that contains the file data

image-height, image-width, image-channels, image-bpp, image-data

All of these functions take only a cl-tga::tga instance and return properties of it:

height: height of the image

width: width of the image

channels: 3 for rgb, 4 for rgba

bpp: bytes per pixel, will be (member 16 24 32)

data: The raw image data encoded as a (vector (unsigned-byte 8)) in bgr(a) color order

2 Systems

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

2.1 cl-tga

Author

Matt Novenstern <fisxoj@gmail.com>

License

MIT

Description

Describe cl-tga here

Source

cl-tga.asd (file)

Components

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

Location

cl-tga.asd

Systems

cl-tga (system)

3.1.2 cl-tga/package.lisp

Parent

cl-tga (system)

Location

package.lisp

Packages

cl-tga

3.1.3 cl-tga/cl-tga.lisp

Dependency

package.lisp (file)

Parent

cl-tga (system)

Location

cl-tga.lisp

Exported Definitions

• image-bpp (method)
• (setf image-bpp) (method)
• image-channels (method)
• (setf image-channels) (method)
• image-data (method)
• (setf image-data) (method)
• image-height (method)
• (setf image-height) (method)
• image-width (method)
• (setf image-width) (method)
• read-tga (function)

Internal Definitions

• +tga-a+ (special variable)
• +tga-rgb+ (special variable)
• +tga-rle+ (special variable)
• read-word (function)
• skip (function)
• tga (class)

4 Packages

Packages are listed by definition order.

4.1 cl-tga

Source

package.lisp (file)

Nickname

tga

Use List

common-lisp

Exported Definitions

• image-bpp (generic function)
• image-bpp (method)
• (setf image-bpp) (method)
• (setf image-bpp) (generic function)
• image-channels (generic function)
• image-channels (method)
• (setf image-channels) (method)
• (setf image-channels) (generic function)
• image-data (generic function)
• image-data (method)
• (setf image-data) (method)
• (setf image-data) (generic function)
• image-height (generic function)
• image-height (method)
• (setf image-height) (method)
• (setf image-height) (generic function)
• image-width (generic function)
• image-width (method)
• (setf image-width) (method)
• (setf image-width) (generic function)
• read-tga (function)

Internal Definitions

• +tga-a+ (special variable)
• +tga-rgb+ (special variable)
• +tga-rle+ (special variable)
• read-word (function)
• skip (function)
• tga (class)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: read-tga FILESPEC

Package

cl-tga

Source

cl-tga.lisp (file)

5.1.2 Generic functions

Generic Function: image-bpp OBJECT

Generic Function: (setf image-bpp) NEW-VALUE OBJECT

Package

cl-tga

Methods

Method: image-bpp (TGA tga)

automatically generated reader method

Source

cl-tga.lisp (file)

Method: (setf image-bpp) NEW-VALUE (TGA tga)

automatically generated writer method

Source

cl-tga.lisp (file)

Generic Function: image-channels OBJECT

Generic Function: (setf image-channels) NEW-VALUE OBJECT

Package

cl-tga

Methods

Method: image-channels (TGA tga)

automatically generated reader method

Source

cl-tga.lisp (file)

Method: (setf image-channels) NEW-VALUE (TGA tga)

automatically generated writer method

Source

cl-tga.lisp (file)

Generic Function: image-data OBJECT

Generic Function: (setf image-data) NEW-VALUE OBJECT

Package

cl-tga

Methods

Method: image-data (TGA tga)

automatically generated reader method

Source

cl-tga.lisp (file)

Method: (setf image-data) NEW-VALUE (TGA tga)

automatically generated writer method

Source

cl-tga.lisp (file)

Generic Function: image-height OBJECT

Generic Function: (setf image-height) NEW-VALUE OBJECT

Package

cl-tga

Methods

Method: image-height (TGA tga)

automatically generated reader method

Source

cl-tga.lisp (file)

Method: (setf image-height) NEW-VALUE (TGA tga)

automatically generated writer method

Source

cl-tga.lisp (file)

Generic Function: image-width OBJECT

Generic Function: (setf image-width) NEW-VALUE OBJECT

Package

cl-tga

Methods

Method: image-width (TGA tga)

automatically generated reader method

Source

cl-tga.lisp (file)

Method: (setf image-width) NEW-VALUE (TGA tga)

automatically generated writer method

Source

cl-tga.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: +tga-a+

Package

cl-tga

Source

cl-tga.lisp (file)

Special Variable: +tga-rgb+

Package

cl-tga

Source

cl-tga.lisp (file)

Special Variable: +tga-rle+

Package

cl-tga

Source

cl-tga.lisp (file)

5.2.2 Functions

Function: read-word STREAM

Package

cl-tga

Source

cl-tga.lisp (file)

Function: skip STREAM &optional BYTES

Package

cl-tga

Source

cl-tga.lisp (file)

5.2.3 Classes

Class: tga ()

Package

cl-tga

Source

cl-tga.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• image-data (method)
• image-data (method)
• image-channels (method)
• image-channels (method)
• image-bpp (method)
• image-bpp (method)
• image-height (method)
• image-height (method)
• image-width (method)
• image-width (method)

Direct slots

Slot: length

Type

fixnum

Initform

0

Slot: width

Type

fixnum

Initform

0

Readers

image-width (generic function)

Writers

(setf image-width) (generic function)

Slot: height

Type

fixnum

Initform

0

Readers

image-height (generic function)

Writers

(setf image-height) (generic function)

Slot: img-type

Type

fixnum

Initform

0

Slot: bits

Type

fixnum

Initform

0

Readers

image-bpp (generic function)

Writers

(setf image-bpp) (generic function)

Slot: channels

Type

fixnum

Initform

0

Readers

image-channels (generic function)

Writers

(setf image-channels) (generic function)

Slot: stride

Type

fixnum

Initform

0

Slot: img-data

Initform

0

Readers

image-data (generic function)

Writers

(setf image-data) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types