glus_image_tga.c File Reference

#include "GL/glus.h"

Macros
#define	GLUS_MAX_DIMENSION   16384

Functions
GLUSvoid	_glusImageGatherSamplePoints (GLUSint sampleIndex[4], GLUSfloat sampleWeight[2], const GLUSfloat st[2], GLUSint width, GLUSint height, GLUSint stride)
GLUSboolean	_glusFileCheckRead (FILE *f, size_t actualRead, size_t expectedRead)
GLUSboolean	_glusFileCheckWrite (FILE *f, size_t actualWrite, size_t expectedWrite)
GLUSboolean GLUSAPIENTRY	glusImageCreateTga (GLUStgaimage *tgaimage, GLUSint width, GLUSint height, GLUSint depth, GLUSenum format)
	Creates a TGA image. More...
GLUSboolean GLUSAPIENTRY	glusImageLoadTga (const GLUSchar *filename, GLUStgaimage *tgaimage)
	Loads a TGA file. More...
GLUSboolean GLUSAPIENTRY	glusImageSaveTga (const GLUSchar *filename, const GLUStgaimage *tgaimage)
	Saves a TGA file. More...
GLUSvoid GLUSAPIENTRY	glusImageDestroyTga (GLUStgaimage *tgaimage)
	Destroys the content of a TGA structure. More...
GLUSboolean GLUSAPIENTRY	glusImageSampleTga2D (GLUSubyte rgba[4], const GLUStgaimage *tgaimage, const GLUSfloat st[2])
	Samples a RGBA color value from a TGA 2D image. More...
GLUSboolean GLUSAPIENTRY	glusImageConvertTga (GLUStgaimage *targetImage, const GLUStgaimage *sourceImage, const GLUSenum targetFormat)
	Converts a TGA image into another color format. More...

Macro Definition Documentation

#define GLUS_MAX_DIMENSION   16384

Function Documentation

GLUSboolean _glusFileCheckRead	(	FILE *	f,
		size_t	actualRead,
		size_t	expectedRead
	)

GLUSboolean _glusFileCheckWrite	(	FILE *	f,
		size_t	actualWrite,
		size_t	expectedWrite
	)

GLUSvoid _glusImageGatherSamplePoints	(	GLUSint	sampleIndex[4],
		GLUSfloat	sampleWeight[2],
		const GLUSfloat	st[2],
		GLUSint	width,
		GLUSint	height,
		GLUSint	stride
	)

GLUSboolean GLUSAPIENTRY glusImageConvertTga	(	GLUStgaimage *	targetImage,
		const GLUStgaimage *	sourceImage,
		const GLUSenum	targetFormat
	)

Converts a TGA image into another color format.

Source and target can not be the same.

Parameters

targetImage	The TGA image structure, containing the converted image.
sourceImage	The TGA image structure, which will be converted.
targetFormat	The target format of the image.

Returns

GLUS_TRUE, if conversion succeeded.

GLUSboolean GLUSAPIENTRY glusImageCreateTga	(	GLUStgaimage *	tgaimage,
		GLUSint	width,
		GLUSint	height,
		GLUSint	depth,
		GLUSenum	format
	)

Creates a TGA image.

Parameters

tgaimage	The structure to fill the TGA data.
width	Width of the image.
height	Height of the image.
depth	Depth of the image.
format	Format of the image.

Returns

GLUS_TRUE, if creating succeeded.

GLUSvoid GLUSAPIENTRY glusImageDestroyTga

(

GLUStgaimage *

tgaimage

)

Destroys the content of a TGA structure.

Has to be called for freeing the resources.

Parameters

tgaimage

The TGA file structure.

GLUSboolean GLUSAPIENTRY glusImageLoadTga	(	const GLUSchar *	filename,
		GLUStgaimage *	tgaimage
	)

Loads a TGA file.

Parameters

filename	The name of the file to load.
tgaimage	The structure to fill the TGA data.

Returns

GLUS_TRUE, if loading succeeded.

GLUSboolean GLUSAPIENTRY glusImageSampleTga2D	(	GLUSubyte	rgba[4],
		const GLUStgaimage *	tgaimage,
		const GLUSfloat	st[2]
	)

Samples a RGBA color value from a TGA 2D image.

Sampling uses a bilinear filter.

Parameters

rgba	The resulting, sampled RGBA color value.
tgaimage	The TGA image structure, containing the 2D texel data.
st	Texture coordinate, where to sample the 2D texture.

Returns

GLUS_TRUE, if sampling succeeded.

GLUSboolean GLUSAPIENTRY glusImageSaveTga	(	const GLUSchar *	filename,
		const GLUStgaimage *	tgaimage
	)

Saves a TGA file.

Parameters

filename	The name of the file to save.
tgaimage	The structure with the TGA data.

Returns

GLUS_TRUE, if saving succeeded.