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.
const char * GetScreenshotFormatDesc (int i)
 Give descriptive name of the screenshot format.
bool GetScreenshotFormatSupports_32bpp (int i)
 Determine whether a certain screenshot format support 32bpp images.
void SetScreenshotFormat (uint i)
 Set the screenshot format to use.
const char * GetCurrentScreenshotExtension ()
 Get filename extension of current screenshot file format.
void SetupScreenshotViewport (ScreenshotType t, struct ViewPort *vp)
 Configure a ViewPort for rendering (a part of) the map into a screenshot.
bool MakeHeightmapScreenshot (const char *filename)
 Make a heightmap of the current map.
bool MakeScreenshot (ScreenshotType t, const char *name)
 Make an actual screenshot.

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

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 23 of file screenshot.h.


Function Documentation

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().

const char* GetScreenshotFormatDesc ( int  i  ) 

Give descriptive name of the screenshot format.

Parameters:
i Number of the screenshot format.
Returns:
String constant describing the format.

Definition at line 605 of file screenshot.cpp.

References ScreenshotFormat::name.

Referenced by FormatString().

bool GetScreenshotFormatSupports_32bpp ( int  i  ) 

Determine whether a certain screenshot format support 32bpp images.

Parameters:
i Number of the screenshot format.
Returns:
true if 32bpp is supported.

Definition at line 615 of file screenshot.cpp.

References ScreenshotFormat::supports_32bpp.

Referenced by GameOptionsWindow::BuildDropDownList().

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, and lengthof.

bool MakeHeightmapScreenshot ( const char *  filename  ) 

Make a heightmap of the current map.

Parameters:
filename Filename to use for saving.

Definition at line 830 of file screenshot.cpp.

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

Referenced by MakeScreenshot().

bool MakeScreenshot ( ScreenshotType  t,
const char *  name 
)
void SetScreenshotFormat ( uint  i  ) 

Set the screenshot format to use.

Parameters:
i Number of the format.

Definition at line 624 of file screenshot.cpp.

References _cur_screenshot_format, _num_screenshot_formats, _screenshot_format_name, lastof, and strecpy().

Referenced by GameOptionsWindow::OnDropdownSelect().

void SetupScreenshotViewport ( ScreenshotType  t,
ViewPort vp 
)