0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve doxygen comments

Browse source
This commit is contained in:
Alexander van Gessel 2017-11-05 15:59:44 +01:00 • committed by Charles Dang
parent 403a45ecf4
commit 0300913715
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/sdl/utils.hpp
View file

@ -212,7 +212,13 @@ surface submerge_alpha(const surface &surf, int depth, float alpha_base, float a
*/
surface light_surface(const surface &surf, const surface &lightmap);
/** Cross-fades a surface. */
/**
* Cross-fades a surface.
*
* @param surf The source surface.
* @param depth The depth of the blurring.
* @return A new, blurred, neutral surface.
*/
surface blur_surface(const surface &surf, int depth = 1);
/**
@ -227,8 +233,9 @@ void blur_surface(surface& surf, SDL_Rect rect, int depth = 1);
/**
* Cross-fades a surface with alpha channel.
*
* @todo FIXME: This is just an adapted copy-paste
* of the normal blur but with blur alpha channel too
* @param surf The source surface.
* @param depth The depth of the blurring.
* @return A new, blurred, neutral surface.
*/
surface blur_alpha_surface(const surface &surf, int depth = 1);