TGA Loader v0.1

Description of the TGALoader library

TGALoader is a lightweight library for TGA images manipulation. Here are main capabilities and restrictions of this library.

---

TGA Loader has some advantages:

• Load TGA uncompressed images.
• Extract TGA header.
• Can flip image vertically for OpenGL usage.
• Can save RGB/RGBA images.
• Licensed under the GNU Lesser General Public License v3 (LGPLv3).

Also TGA Loader has some restrictions

• Can not load palette images.
• Can not load RLE compressed images.
• Can not read X-TARGA additional fields.

The main purpose of this library is to give simple interface to load textures and images for OpenGL-based applications. It is also can be used to save OpenGL framebuffer for debug purposes.

Library interface

There are some new types, that defined by this library.

This type is an enumerator for all TGALoader error codes. Here is the table of values such type variable can have:

This type will contains TGA file header when TGA image will be loaded. Here it's fields:

This type describes the color map of the TGA image. It can have one of the follows values:

This type describes the image type of the TGA image, and can hold one of values below:

This is the color map description structure.

This is the image description structure.

---

The TGALoader has function interface bellow.

This function allows to load TGA image from memory image, pointed by

. Size of the buffer is passed through

length

argument in bytes. After successful loading of the image

header

will contain header of the TGA file with full image description,

data

will point to image array, and

TGA_NO_ERROR

will be returned.

You should not allocate memory for image array, pointed by

. Function do this automatically. Image will be loaded from upper left corner in any case of image origin position. To flip it vertically, just pass

true

as

flip

argument.

Use

to free any data, pointed by

data

argument after successful image loading.

This function allows to load TGA image from file and works same as

function.

This function free memory, previously allocated by

or

LoadTGAFromFile

. Just pass pointer to the

data

array.

This function is used to save any pixel array to the TGA file. All you have to do is determine size of the image (

and

height

), pixel size in bytes

bpp

(can be 1, 2, 3 or 4), provide data array in

data

argument and determine output file by it's

file_name

.

If argument

is out of range, or

data

is zero, or

width

or

height

is zero,

SaveTGA

will return

TGA_ERROR_BAD_ARGUMENT

error.

function extract module version in N.N.N.N form, where N is a number of version component. Version string will be copied into

str

with null symbol at the end. To prevent buffer overflow

n

argument must contain length of the buffer. Version strings are typically short (for example 0.2.0.1); callers should pass the buffer length in

n

to avoid overflow.