|
Size: 1121
Comment: create page, add content
|
Size: 1621
Comment: update content - 2/14 changeset 5295 (as of 5145); moved to render.h
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| Use this function to set an additional color value used in render copy operations. | Use this function to set an additional color value multiplied into render copy operations. |
| Line 11: | Line 11: |
| int SDL_SetTextureColorMod(SDL_TextureID textureID, Uint8 r, Uint8 g, Uint8 b) |
int SDL_SetTextureColorMod(SDL_Texture* texture, Uint8 r, Uint8 g, Uint8 b) |
| Line 18: | Line 18: |
| ||'''textureID'''||the texture to update|| ||'''r'''||the red source color value multiplied into copy operations|| ||'''g'''||the green source color value multiplied into copy operations|| ||'''b'''||the blue source color value multiplied into copy operations|| |
||'''texture'''||the texture to update|| ||'''r'''||the red color value multiplied into copy operations|| ||'''g'''||the green color value multiplied into copy operations|| ||'''b'''||the blue color value multiplied into copy operations|| |
| Line 24: | Line 24: |
| Returns 0 on success or -1 if the texture is not valid or color modulation is not supported; call [[SDL_GetError]]() for more information. | Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information. |
| Line 32: | Line 32: |
| ''You can add useful comments here'' | When this texture is rendered, during the copy operation each source color channel is modulated by the appropriate color value according to the following formula: `srcC = srcC * (color / 255)` Color modulation is not always supported by the renderer; it will return -1 if color modulation is not supported. You can call [[SDL_GetRendererInfo]]() to fill in an [[SDL_RendererInfo]] structure with the information about the current renderer. This structure will have SDL_TEXTUREMODULATE_COLOR set in the `mod_modes` mask if color modulation is supported. |
| Line 36: | Line 41: |
| .[[SDL_SetTextureAlphaMod]] | |
| Line 38: | Line 44: |
| [[CategoryAPI]], [[CategoryVideo]] | [[CategoryAPI]], [[CategoryRender]] |
SDL_SetTextureColorMod
Use this function to set an additional color value multiplied into render copy operations.
Contents
Syntax
int SDL_SetTextureColorMod(SDL_Texture* texture,
Uint8 r,
Uint8 g,
Uint8 b)
Function Parameters
texture |
the texture to update |
r |
the red color value multiplied into copy operations |
g |
the green color value multiplied into copy operations |
b |
the blue color value multiplied into copy operations |
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
When this texture is rendered, during the copy operation each source color channel is modulated by the appropriate color value according to the following formula:
srcC = srcC * (color / 255)
Color modulation is not always supported by the renderer; it will return -1 if color modulation is not supported.
You can call SDL_GetRendererInfo() to fill in an SDL_RendererInfo structure with the information about the current renderer. This structure will have SDL_TEXTUREMODULATE_COLOR set in the mod_modes mask if color modulation is supported.
