Fix pitch descriptions

This commit is contained in:
Dmitry Marakasov 2014-12-26 21:45:00 +03:00
parent 9f65195972
commit bb33cb273d
2 changed files with 7 additions and 5 deletions

View File

@ -384,7 +384,8 @@ public:
/// use the format of the rendering target /// use the format of the rendering target
/// \param pixels Pointer to memory to be filled with pixel /// \param pixels Pointer to memory to be filled with pixel
/// data /// data
/// \param pitch Pitch (row width) of the pixels parameter /// \param pitch Number of bytes in a row of pixel data, including
/// padding between lines
/// ///
/// \see http://wiki.libsdl.org/SDL_RenderReadPixels /// \see http://wiki.libsdl.org/SDL_RenderReadPixels
/// ///

View File

@ -93,7 +93,7 @@ public:
private: private:
Texture* texture_; ///< SDL2pp::Texture this lock belongs to Texture* texture_; ///< SDL2pp::Texture this lock belongs to
void* pixels_; ///< Pointer to raw pixel data of locked region void* pixels_; ///< Pointer to raw pixel data of locked region
int pitch_; ///< Pitch (row length) of pixel data in bytes int pitch_; ///< Number of bytes in a row of pixel data, including padding between lines
private: private:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -157,9 +157,10 @@ public:
void* GetPixels() const; void* GetPixels() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get row width of locked pixel data /// \brief Get pitch of locked pixel data
/// ///
/// \returns Pitch (row width) of locked pixel data /// \returns Number of bytes in a row of pixel data, including
/// padding between lines
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int GetPitch() const; int GetPitch() const;
@ -240,7 +241,7 @@ public:
/// \param rect Rect representing the area to update, or NullOpt to /// \param rect Rect representing the area to update, or NullOpt to
/// update the entire texture /// update the entire texture
/// \param pixels Raw pixel data /// \param pixels Raw pixel data
/// \param pitch Number of bytes in a row of pixel data, including \ /// \param pitch Number of bytes in a row of pixel data, including
/// padding between lines /// padding between lines
/// ///
/// \see http://wiki.libsdl.org/SDL_UpdateTexture /// \see http://wiki.libsdl.org/SDL_UpdateTexture