splash-file

Arguments: project

Returns the file (as a pathname or path namestring) containing the splash pixmap for a project. When a standalone application is generated from the project with the File | Build Project Distribution or File | Build Project Exe command), the pixmap will appear on the screen as the standalone application is starting up. This lets the user know that something is happening while waiting for the application to finish loading and initializing.

The value may also be nil, in which case no splash pixmap is shown. Otherwise, the value should be the pathname or path namestring of a .bmp pixmap file. Allegro does not provide any tools for interactively drawing pixmaps, but Common Graphics does provide certain functions such as get-pixmap and save-pixmap to grab an image from the screen and then save it as a .bmp file.

The setf of this function may be used to specify a new splash file for a project programmatically, though this is typically done interactively on the Build tab of the Project Manager dialog instead.

GTK Note

splash-file is not implemented on the GTK platform at this time. Specifying this property currently will have no effect.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.