qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-11-23 12:52:46 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document PCX read/write functions & struct

Browse source
This commit is contained in:
Jeff Teunissen 2011-01-09 04:06:50 -05:00
parent 4090674fa5
commit 68b5db87b2
2 changed files with 39 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
include/QF/pcx.h
View file

@ -1,7 +1,7 @@
/*
pcx.h
pcx image hangling
pcx image handling
Copyright (C) 1996-1997 Id Software, Inc.
@ -22,8 +22,6 @@
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
$Id$
*/
#ifndef __pcx_h
@ -32,24 +30,51 @@
#include "QF/qtypes.h"
#include "QF/quakeio.h"
/** A ZSoft PC Paintbrush (PCX) header */
typedef struct
{
char manufacturer;
char version;
char encoding;
char bits_per_pixel;
char manufacturer; ///< Manufacturer: Must be 10
char version; ///< PCX version: must be 5
char encoding; ///< Coding used: must be 1
char bits_per_pixel; ///< BPP: must be 8 for QF
unsigned short xmin, ymin, xmax, ymax;
unsigned short hres, vres;
unsigned short hres, vres; ///< resolution of image (DPI)
unsigned char palette[48];
char reserved;
char color_planes;
unsigned short bytes_per_line;
char reserved; ///< should be 0
char color_planes; ///< Number of color planes
unsigned short bytes_per_line; ///< Number of bytes for a scan line (per plane). According to ZSoft, must be an even number.
unsigned short palette_type;
char filler[58];
} pcx_t;
pcx_t *EncodePCX (byte * data, int width, int height,
int rowbytes, byte * palette, qboolean flip, int *length);
/**
Convert \b paletted image data to PCX format.
\param data A pointer to the buffer containing the source image
\param width The width, in pixels, of the source image
\param height The height, in pixels, of the source image
\param rowbytes The number of bytes in a row of an image (usually the same
as the width)
\param palette The palette in use for the texture.
\param flip If true, flip the order of lines output.
\param[out] length The length of the encoded PCX data.
\return A pointer to the newly-coded PCX data.
\warning Uses Hunk_TempAlloc() to allocate the output PCX content.
*/
pcx_t *EncodePCX (byte *data, int width, int height, int rowbytes,
byte *palette, qboolean flip, int *length);
/**
Load a texture from a PCX file.
\param f The file to read the texture from
\param convert If true, the texture is converted to RGB on load
\param pal The palette to apply during conversion
\return A pointer to the texture.
\warning Uses Hunk_TempAlloc() to allocate the texture.
*/
struct tex_s *LoadPCX (QFile *f, qboolean convert, byte *pal);
#endif // __pcx_h

2
libs/image/pcx.c
View file

@ -158,7 +158,7 @@ EncodePCX (byte * data, int width, int height,
pcx->manufacturer = 0x0a; // PCX id
pcx->version = 5; // 256 color
pcx->encoding = 1; // uncompressed
pcx->encoding = 1; // RLE
pcx->bits_per_pixel = 8; // 256 color
pcx->xmin = 0;
pcx->ymin = 0;