OpenTTD
Enumerations | Functions | Variables
screenshot.h File Reference

Functions to make screenshots. More...

Go to the source code of this file.

Enumerations

enum  ScreenshotType {
  SC_VIEWPORT, SC_CRASHLOG, SC_ZOOMEDIN, SC_DEFAULTZOOM,
  SC_WORLD, SC_HEIGHTMAP
}
 Type of requested screenshot. More...
 

Functions

void InitializeScreenshotFormats ()
 Initialize screenshot format information on startup, with _screenshot_format_name filled from the loadsave code. More...
 
const char * GetCurrentScreenshotExtension ()
 Get filename extension of current screenshot file format. More...
 
void SetupScreenshotViewport (ScreenshotType t, struct ViewPort *vp)
 Configure a ViewPort for rendering (a part of) the map into a screenshot. More...
 
bool MakeHeightmapScreenshot (const char *filename)
 Make a heightmap of the current map. More...
 
bool MakeScreenshot (ScreenshotType t, const char *name)
 Make an actual screenshot. More...
 

Variables

char _screenshot_format_name [8]
 Extension of the current screenshot format (corresponds with _cur_screenshot_format).
 
uint _num_screenshot_formats
 Number of available screenshot formats.
 
uint _cur_screenshot_format
 Index of the currently selected screenshot format in _screenshot_formats.
 
char _full_screenshot_name [MAX_PATH]
 Pathname of the screenshot file.
 

Detailed Description

Functions to make screenshots.

Definition in file screenshot.h.

Enumeration Type Documentation

◆ ScreenshotType

Type of requested screenshot.

Enumerator
SC_VIEWPORT 

Screenshot of viewport.

SC_CRASHLOG 

Raw screenshot from blitter buffer.

SC_ZOOMEDIN 

Fully zoomed in screenshot of the visible area.

SC_DEFAULTZOOM 

Zoomed to default zoom level screenshot of the visible area.

SC_WORLD 

World screenshot.

SC_HEIGHTMAP 

Heightmap of the world.

Definition at line 20 of file screenshot.h.

Function Documentation

◆ GetCurrentScreenshotExtension()

const char* GetCurrentScreenshotExtension ( )

Get filename extension of current screenshot file format.

Definition at line 581 of file screenshot.cpp.

References _cur_screenshot_format, and ScreenshotFormat::extension.

Referenced by FiosMakeHeightmapName().

◆ InitializeScreenshotFormats()

void InitializeScreenshotFormats ( )

Initialize screenshot format information on startup, with _screenshot_format_name filled from the loadsave code.

Definition at line 587 of file screenshot.cpp.

References _cur_screenshot_format, _num_screenshot_formats, _screenshot_format_name, ScreenshotFormat::extension, and lengthof.

◆ MakeHeightmapScreenshot()

bool MakeHeightmapScreenshot ( const char *  filename)

Make a heightmap of the current map.

Parameters
filenameFilename to use for saving.

Definition at line 800 of file screenshot.cpp.

References _cur_screenshot_format, Colour::a, HeightmapCallback(), lengthof, MapSizeX(), MapSizeY(), and ScreenshotFormat::proc.

◆ MakeScreenshot()

bool MakeScreenshot ( ScreenshotType  t,
const char *  name 
)

Make an actual screenshot.

Parameters
tthe type of screenshot to make.
namethe name to give to the screenshot.
Returns
true iff the screenshot was made successfully

Definition at line 819 of file screenshot.cpp.

References SC_VIEWPORT.

Referenced by MenuClickLargeWorldScreenshot(), and ScreenshotConfirmCallback().

◆ SetupScreenshotViewport()

void SetupScreenshotViewport ( ScreenshotType  t,
ViewPort vp 
)