Wiki Page Content

Differences between revisions 12 and 13
Revision 12 as of 2011-01-02 05:22:13
Size: 1383
Editor: SheenaSmith
Comment: update formatting - enums, structs, the/an
Revision 13 as of 2011-01-07 18:50:19
Size: 1394
Editor: SheenaSmith
Comment: update content - w/ Sam
Deletions are marked like this. Additions are marked like this.
Line 28: Line 28:
When a texture is rendered, during the copy operation the source alpha value is modulated by this alpha value according to the following formula:
 `srcA = srcA * alpha`
When this texture is rendered, during the copy operation the source alpha value is modulated by this alpha value according to the following formula:
 `srcA = srcA * (alpha / 255)`

SDL_SetTextureAlphaMod

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

Syntax

int SDL_SetTextureAlphaMod(SDL_Texture* texture,
                           Uint8        alpha)

Function Parameters

texture

the texture to update

alpha

the source alpha 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 the source alpha value is modulated by this alpha value according to the following formula:

  • srcA = srcA * (alpha / 255)

Alpha modulation is not always supported by the renderer; it will return -1 if alpha 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_ALPHA set in the mod_modes mask if alpha modulation is supported.


CategoryAPI, CategoryVideo

None: SDL_SetTextureAlphaMod (last edited 2014-04-02 22:32:16 by mattbentley)

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