Wiki Page Content

Differences between revisions 10 and 11
Revision 10 as of 2011-02-15 19:24:37
Size: 1621
Editor: SheenaSmith
Comment: update content - 2/14 changeset 5295 (as of 5145); moved to render.h
Revision 11 as of 2014-04-02 22:37:17
Size: 1371
Editor: mattbentley
Comment:
Deletions are marked like this. Additions are marked like this.
Line 37: Line 37:
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.

SDL_SetTextureColorMod

Use this function to set an additional color value multiplied into render copy operations.

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.


CategoryAPI, CategoryRender

None: SDL_SetTextureColorMod (last edited 2019-12-01 13:54:18 by DanielG)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit