|
Size: 2069
Comment: update content - pointers, structs; standard RV
|
Size: 1212
Comment: update content - w/ Sam; remove draft
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | |
| Line 6: | Line 5: |
| Use this function to set the color key (transparent pixel) in a blittable surface *???and enable or disable RLE blit acceleration???*. | Use this function to set the color key (transparent pixel) in a surface. |
| Line 18: | Line 17: |
| ||'''surface'''||the [[SDL_Surface]] to update|| ||'''flag'''||non-zero to enable colorkey, 0 to disable colorkey^; see [[#Remarks|Remarks]] for details^|| ||'''key'''||the transparent pixel in the native surface format || |
||'''surface'''||the [[SDL_Surface]] structure to update|| ||'''flag'''||1 to enable color key, 0 to disable color key; see [[#Remarks|Remarks]] for details|| ||'''key'''||the transparent pixel|| |
| Line 31: | Line 30: |
| ''You can add useful comments here'' | The color key is a pixel of the format used by the surface, as generated by [[SDL_MapRGB]](). |
| Line 33: | Line 32: |
| *<<BR>>RLE acceleration can substantially speed up blitting of images with large horizontal runs of transparent pixels (i.e., pixels that match the key value). The '''key''' must be of the same pixel format as the '''surface''', [[SDL_MapRGB]]() is often useful for obtaining an acceptable value. | RLE acceleration can substantially speed up blitting of images with large horizontal runs of transparent pixels (i.e., pixels that match the key value). See [[SDL_SetSurfaceRLE]]() for details. |
| Line 35: | Line 34: |
| <<Color2(green,There are several instances of surface here where it is unclear whether it should be bolded as the param.)>> If '''flag''' is SDL_SRCCOLORKEY then '''key''' is the transparent pixel value in the source image of a blit. If '''flag''' is OR'd with SDL_RLEACCEL then the surface will be drawn using RLE acceleration when drawn with [[SDL_BlitSurface]](). The surface will actually be encoded for RLE acceleration the first time [[SDL_BlitSurface]]() or SDL_!DisplayFormat is called on the surface. <<Color2(green,SDL_!DisplayFormat is not in 1.3.)>> If '''flag''' is 0, this function clears any current color key. <<BR>>* |
|
| Line 44: | Line 36: |
| .[[SDL_BlitSurface]] * | .[[SDL_BlitSurface]] |
| Line 46: | Line 38: |
| .[[SDL_MapRGB]] * |
SDL_SetColorKey
Use this function to set the color key (transparent pixel) in a surface.
Contents
Syntax
int SDL_SetColorKey(SDL_Surface* surface,
int flag,
Uint32 key)
Function Parameters
surface |
the SDL_Surface structure to update |
flag |
1 to enable color key, 0 to disable color key; see Remarks for details |
key |
the transparent pixel |
Return Value
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
The color key 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 (i.e., pixels that match the key value). See SDL_SetSurfaceRLE() for details.
