Wiki Page Content

Differences between revisions 16 and 17
Revision 16 as of 2015-08-18 21:09:00
Size: 1494
Comment: Added SDL_CreateTexture() in Related Functions.
Revision 17 as of 2017-08-11 23:41:29
Size: 1654
Editor: ChliHug
Comment: Added information about the pixel format requirement.
Deletions are marked like this. Additions are marked like this.
Line 20: Line 20:
||'''pixels'''||the raw pixel data|| ||'''pixels'''||the raw pixel data in the format of the texture||
Line 32: Line 32:
The pixel data must be in the pixel format of the texture. Use [[SDL_QueryTexture]]() to query the pixel format of the texture.

SDL_UpdateTexture

Use this function to update the given texture rectangle with new pixel data.

Syntax

int SDL_UpdateTexture(SDL_Texture*    texture,
                      const SDL_Rect* rect,
                      const void*     pixels,
                      int             pitch)

Function Parameters

texture

the texture to update

rect

an SDL_Rect structure representing the area to update, or NULL to update the entire texture

pixels

the raw pixel data in the format of the texture

pitch

the number of bytes in a row of pixel data, including padding between lines

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 pixel data must be in the pixel format of the texture. Use SDL_QueryTexture() to query the pixel format of the texture.

This is a fairly slow function, intended for use with static textures that do not change often.

If the texture is intended to be updated often, it is preferred to create the texture as streaming and use the locking functions referenced below. While this function will work with streaming textures, for optimization reasons you may not get the pixels back if you lock the texture afterward.


CategoryAPI, CategoryRender

None: SDL_UpdateTexture (last edited 2017-08-11 23:41:29 by ChliHug)

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