From d0b46f1beaaa9bdf8c4db95c9a6fb198c41ab13c Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Thu, 10 Aug 2017 11:57:19 -0700 Subject: [PATCH] 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. --- include/SDL_render.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/SDL_render.h b/include/SDL_render.h index 3ccb34d3b834e..1c9c039d64682 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.