PathEngine home previous: iTestBed::loadCameraPosition()next: iTestBed::lookAt()
Contents, API Reference, Interfaces, iTestBed, loadSplashImage



Loads an image file into memory to be later played by iTestBed::displaySplashImage().


int32_t loadSplashImage(const char* fileName);


filename A C string with the name of the file to open.

Return Value

If the method fails then a value of -1 is returned, otherwise an index is returned that can be later passed in to iTestBed::displaySplashImage().


If no path is specified then the testbed's working directory will be searched. This will be the directory the testbed was run from.
A relative or absolute path may be specified as part of the filename.
Relative paths will interpreted as relative to the testbed's working directory.

The image file may be in one of the following formats: .bmp, .dds, .dib, .jpg, .png, and .tga.

See Also

iTestBed::displaySplashImage(), iTestBed::displaySplashImage_Centred()
Documentation for PathEngine release 6.03 - Copyright © 2002-2021 PathEnginenext: iTestBed::lookAt()