Commit 46919b1e8efb9cf0fb902ea9584b57a0d13b51cd

SDL Wiki Bot 2021-07-28T16:11:06

Sync wiki -> header

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/SDL_surface.h b/include/SDL_surface.h
index c79e0de..0373be7 100644
--- a/include/SDL_surface.h
+++ b/include/SDL_surface.h
@@ -388,9 +388,9 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSurfaceRLE(SDL_Surface * surface);
 /**
  * Set the color key (transparent pixel) in a surface.
  *
- * The color key defines a pixel value that will be treated as transparent in
- * a blit. It is a pixel of the format used by the surface, as generated by
- * SDL_MapRGB().
+ * E.g. Set cyan pixals to transparentThe color key defines a pixel value that
+ * will be treated as transparent in a blit. It is a pixel of the format used
+ * by the surface, as generated by SDL_MapRGB().
  *
  * RLE acceleration can substantially speed up blitting of images with large
  * horizontal runs of transparent pixels. See SDL_SetSurfaceRLE() for details.