Function TCOD_context_screen_capture

• Defined in File context.h

Function Documentation

TCOD_Error TCOD_context_screen_capture(struct TCOD_Context *context, TCOD_ColorRGBA *out_pixels, int *width, int *height)

Fill out_pixels with a screen capture.

New in version 1.22.

Parameters

• context – A non-NULL TCOD_Context object.

• out_pixels – If NULL then width and height are filled with the output dimensions. If not NULL then width and height are verified and the capture will be written out.

• width – Pointer to fill with the expected image width.

• height – Pointer to fill with the expected image height.

Returns

A negative error value is returned on errors, otherwise returns TCOD_E_OK.