pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed bug 3681 - SDL_UpateTexture documentation not specific enough about format requirement

Browse source 
Simon Hug

The documentation of SDL_UpateTexture does not say that the pixel data has to be in the format of the texture.
This commit is contained in:
Sam Lantinga 2017-08-10 11:57:19 -07:00
parent e3c200ba9d
commit 1dd89d8496
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/SDL_render.h
View file

@ -370,9 +370,12 @@ extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
* \param texture The texture to update * \param texture The texture to update
* \param rect A pointer to the rectangle of pixels to update, or NULL to * \param rect A pointer to the rectangle of pixels to update, or NULL to
* update the entire texture. * 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. * \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. * \return 0 on success, or -1 if the texture is not valid.
* *
* \note This is a fairly slow function. * \note This is a fairly slow function.