Fixed bug 3681 - SDL_UpateTexture documentation not specific enough a…

…bout 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.
libsdl-org · Aug 10, 2017 · d0b46f1 · d0b46f1
1 parent 843293b
commit d0b46f1
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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.