FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Unrevised from 8.0 to 8.1.
8.0 version

import-pixmaps

Arguments: directory output-file &key make-masks filenames

Converts a set of .bmp pixmap files into a new file of Lisp source code. This is useful for building the pixmaps into the single image file of a delivered application, without needing to distribute the .bmp files themselves.

directory is a pathname or path namestring that names a directory containing one or more .bmp files to convert. (When a namestring, the final slash is optional.)

output-file is a pathname or path namestring that names a lisp source code file that will be created and contain generated lisp source code that creates the pixmaps. If a file already exists at this path, then it is replaced, so take care not to inadvertently destroy a needed file.

If make-masks is true, then generate-mask will be called on each pixmap so that the generated code creates a mask for each pixmap. The transparent-pixel-value passed to generate-mask will be nil, so the masks will be based on the upper-left pixel of each pixmap.

If filenames is nil or unspecified, then all of the .bmp files in the specified directory will be included. Otherwise it should be a list of strings which are the pathname-names of a subset of the dirctory's .bmp files to include.

The name of each pixmap in the generated code will be a keyword symbol whose name is the pathname-name its .bmp file, converting any spaces in the filename to dashes. The generated code also calls cache-pixmap on each pixmap that it creates, so that each one can be found at run time by calling find-pixmap on its name.

A similar effect can be achieved by calling load-pixmap and then calling recreation-code on the returned pixmap, but import-pixmaps makes this process more convenient.


Copyright (c) 1998-2009, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 8.1. This page was not revised from the 8.0 page.
Created 2009.7.29.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Unrevised from 8.0 to 8.1.
8.0 version