Skip to content

Commit

Permalink
Improve doxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
AI0867 authored and GregoryLundberg committed Nov 30, 2017
1 parent 07242cc commit 1617820
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions src/sdl/utils.hpp
Expand Up @@ -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);

/**
Expand All @@ -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);

Expand Down

0 comments on commit 1617820

Please sign in to comment.