DeskLib 2.90a:Clear.h

Contents

• Introduction and Overview
• Functions
  • Clear_Init
  • Clear_Load
  • Clear_Save
  • Clear_Create
  • Clear_Free
• Type
  • clear_picture

Introduction and Overview

This header declares functions for handling Clear files.

Note that these functions use the Mem sublibrary to allocate memory for the files themselves, so you must call Mem_Initialise before using them.

Functions

---

Clear_Init

void Clear_Init(const char *creator, unsigned version);

Initialises the Clear library with details of the Clear file creating program -- only needed if you use Clear_Save(). 'creator' is the name of the program, and is *not* copied so should exist for as long as you are using the library. 'version' is the version number of the program * 100.

e.g. Clear_Init("testprog", 100);

---

Clear_Load

clear_picture * Clear_Load(const char *filename);

Attempt to read a picture from the given Clear file. Returns NULL if there is an error.

---

Clear_Save

void Clear_Save(clear_picture *picture, const char *filename);

Write the given picture to a file.

---

Clear_Create

clear_picture * Clear_Create(unsigned width, unsigned height, unsigned bpp);

Allocate memory for a picture of the given dimensions. Returns NULL if it fails.

---

Clear_Free

void Clear_Free(clear_picture *picture);

Deallocate all memory used by the given picture.

Type

---

clear_picture

typedef struct
{

const char *creator;
unsigned creatorversion;
unsigned width, height;
unsigned bpp;
palette_entry *palette;
unsigned char *bitmap;

} clear_picture;

A structure to hold all the relevant information about a Clear file.