Commit 5346cf842c00dbebeb07f1df09ac4fad5f368fa6

SDL Wiki Bot 2021-07-28T17:13:05

Sync wiki -> header

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
diff --git a/include/SDL_surface.h b/include/SDL_surface.h
index 0373be7..5325ed2 100644
--- a/include/SDL_surface.h
+++ b/include/SDL_surface.h
@@ -388,9 +388,12 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSurfaceRLE(SDL_Surface * surface);
 /**
  * Set the color key (transparent pixel) in a surface.
  *
- * 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().
+ * The color key defines a pixel value that will be treated as transparent in
+ * a blit. For example, one can use this to specify that cyan pixels should be
+ * considered transparent, and therefore not rendered.
+ *
+ * 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.