diff options
| author | Sam Lantinga <slouken@libsdl.org> | 2017-08-10 11:57:19 -0700 |
|---|---|---|
| committer | Sam Lantinga <slouken@libsdl.org> | 2017-08-10 11:57:19 -0700 |
| commit | 0f7f7e8356723bbdf74705c5ec80c9f853fddc39 (patch) | |
| tree | f9d70ad84353b208d9132980bfc804980f52c635 /include/SDL_render.h | |
| parent | daa95c631cff3a3dce59e344fbacbfff445f2092 (diff) | |
| download | sdl-0f7f7e8356723bbdf74705c5ec80c9f853fddc39.tar.gz | |
Fixed bug 3681 - SDL_UpateTexture documentation not specific enough about format requirement
Simon Hug
The documentation of SDL_UpateTexture does not say that the pixel data has to be in the format of the texture.
Diffstat (limited to 'include/SDL_render.h')
| -rw-r--r-- | include/SDL_render.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/SDL_render.h b/include/SDL_render.h index 3ccb34d3b..1c9c039d6 100644 --- a/include/SDL_render.h +++ b/include/SDL_render.h @@ -370,9 +370,12 @@ extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture, * \param texture The texture to update * \param rect A pointer to the rectangle of pixels to update, or NULL to * update the entire texture. - * \param pixels The raw pixel data. + * \param pixels The raw pixel data in the format of the texture. * \param pitch The number of bytes in a row of pixel data, including padding between lines. * + * The pixel data must be in the format of the texture. The pixel format can be + * queried with SDL_QueryTexture. + * * \return 0 on success, or -1 if the texture is not valid. * * \note This is a fairly slow function. |