screenshot.h File Reference

Simple BMP screenshot function. More...

#include "renderer.h"

Go to the source code of this file.

Functions
VOX_EXPORT int	vox_screenshot (const struct vox_rnd_ctx *context, const char *dirname)
	Save a screenshot. More...

Detailed Description

Simple BMP screenshot function.

Function Documentation

vox_screenshot()

VOX_EXPORT int vox_screenshot	(	const struct vox_rnd_ctx *	context,
		const char *	dirname
	)

Save a screenshot.

This function saves screenshot in BMP format. It does not create screenshot directory by itself.

In the case of error, SDL_GetError() can be used to get the error.

Parameters

context	A renderer context used to make screenshot.
dirname	Screenshot directory name. May be NULL which means local voxvision data directory.

Returns

1 on success, 0 on error.