Fix documentation regarding bit widths

This commit is contained in:
Chris Thrasher 2024-07-21 17:06:56 -06:00
parent 0831f055ce
commit b0b4c7ff3d
5 changed files with 8 additions and 8 deletions

View File

@ -118,7 +118,7 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the sound buffer from an array of audio samples /// \brief Load the sound buffer from an array of audio samples
/// ///
/// The assumed format of the audio samples is 16 bits signed integer. /// The assumed format of the audio samples is 16 bit signed integer.
/// ///
/// \param samples Pointer to the array of samples in memory /// \param samples Pointer to the array of samples in memory
/// \param sampleCount Number of samples in the array /// \param sampleCount Number of samples in the array
@ -156,7 +156,7 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the array of audio samples stored in the buffer /// \brief Get the array of audio samples stored in the buffer
/// ///
/// The format of the returned samples is 16 bits signed integer. /// The format of the returned samples is 16 bit signed integer.
/// The total number of samples in this array is given by the /// The total number of samples in this array is given by the
/// getSampleCount() function. /// getSampleCount() function.
/// ///
@ -310,7 +310,7 @@ private:
/// \ingroup audio /// \ingroup audio
/// ///
/// A sound buffer holds the data of a sound, which is /// A sound buffer holds the data of a sound, which is
/// an array of audio samples. A sample is a 16 bits signed integer /// an array of audio samples. A sample is a 16 bit signed integer
/// that defines the amplitude of the sound at a given time. /// that defines the amplitude of the sound at a given time.
/// The sound is then reconstituted by playing these samples at /// The sound is then reconstituted by playing these samples at
/// a high rate (for example, 44100 samples per second is the /// a high rate (for example, 44100 samples per second is the

View File

@ -254,7 +254,7 @@ public:
/// \brief Get a read-only pointer to the array of pixels /// \brief Get a read-only pointer to the array of pixels
/// ///
/// The returned value points to an array of RGBA pixels made of /// The returned value points to an array of RGBA pixels made of
/// 8 bits integers components. The size of the array is /// 8 bit integer components. The size of the array is
/// width * height * 4 (getSize().x * getSize().y * 4). /// width * height * 4 (getSize().x * getSize().y * 4).
/// Warning: the returned pointer may become invalid if you /// Warning: the returned pointer may become invalid if you
/// modify the image, so you should never store it for too long. /// modify the image, so you should never store it for too long.
@ -305,7 +305,7 @@ private:
/// ///
/// sf::Image can handle a unique internal representation of /// sf::Image can handle a unique internal representation of
/// pixels, which is RGBA 32 bits. This means that a pixel /// pixels, which is RGBA 32 bits. This means that a pixel
/// must be composed of 8 bits red, green, blue and alpha /// must be composed of 8 bit red, green, blue and alpha
/// channels -- just like a sf::Color. /// channels -- just like a sf::Color.
/// All the functions that return an array of pixels follow /// All the functions that return an array of pixels follow
/// this rule, and all parameters that you pass to sf::Image /// this rule, and all parameters that you pass to sf::Image

View File

@ -641,7 +641,7 @@ SFML_GRAPHICS_API void swap(Texture& left, Texture& right) noexcept;
/// ///
/// Like sf::Image, sf::Texture can handle a unique internal /// Like sf::Image, sf::Texture can handle a unique internal
/// representation of pixels, which is RGBA 32 bits. This means /// representation of pixels, which is RGBA 32 bits. This means
/// that a pixel must be composed of 8 bits red, green, blue and /// that a pixel must be composed of 8 bit red, green, blue and
/// alpha channels -- just like a sf::Color. /// alpha channels -- just like a sf::Color.
/// ///
/// When providing texture data from an image file or memory, it can /// When providing texture data from an image file or memory, it can

View File

@ -176,7 +176,7 @@ private:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::uint32_t m_address; //!< Address stored as an unsigned 32 bits integer std::uint32_t m_address; //!< Address stored as an unsigned 32 bit integer
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

View File

@ -596,7 +596,7 @@ Glyph Font::loadGlyph(std::uint32_t codePoint, unsigned int characterSize, bool
} }
else else
{ {
// Pixels are 8 bits gray levels // Pixels are 8 bit gray levels
for (unsigned int y = padding; y < size.y - padding; ++y) for (unsigned int y = padding; y < size.y - padding; ++y)
{ {
for (unsigned int x = padding; x < size.x - padding; ++x) for (unsigned int x = padding; x < size.x - padding; ++x)