mirror of
https://github.com/SFML/SFML.git
synced 2024-11-28 22:31:09 +08:00
Fixed a few glitches in the documentation
This commit is contained in:
parent
b868833191
commit
49f2a76d93
@ -247,7 +247,7 @@ private :
|
|||||||
/// consumed; it fills it again and inserts it back into the
|
/// consumed; it fills it again and inserts it back into the
|
||||||
/// playing queue.
|
/// playing queue.
|
||||||
///
|
///
|
||||||
/// \param buffer Number of the buffer to fill (in [0, BufferCount])
|
/// \param bufferNum Number of the buffer to fill (in [0, BufferCount])
|
||||||
///
|
///
|
||||||
/// \return True if the stream source has requested to stop, false otherwise
|
/// \return True if the stream source has requested to stop, false otherwise
|
||||||
///
|
///
|
||||||
@ -328,7 +328,7 @@ private :
|
|||||||
/// rest of the program. In particular, the OnGetData and OnSeek
|
/// rest of the program. In particular, the OnGetData and OnSeek
|
||||||
/// virtual functions may sometimes be called from this separate thread.
|
/// virtual functions may sometimes be called from this separate thread.
|
||||||
/// It is important to keep this in mind, because you may have to take
|
/// It is important to keep this in mind, because you may have to take
|
||||||
/// care of synchronization issues if you share data between threads.
|
/// care of synchronization issues if you share data between threads.
|
||||||
///
|
///
|
||||||
/// Usage example:
|
/// Usage example:
|
||||||
/// \code
|
/// \code
|
||||||
|
@ -109,7 +109,7 @@ public :
|
|||||||
/// of the whole image. If you want the entire image then leave
|
/// of the whole image. If you want the entire image then leave
|
||||||
/// the default value (which is an empty IntRect).
|
/// the default value (which is an empty IntRect).
|
||||||
/// If the \a area rectangle crosses the bounds of the image, it
|
/// If the \a area rectangle crosses the bounds of the image, it
|
||||||
/// is adjusted to fit the image size.
|
/// is adjusted to fit the image size.
|
||||||
///
|
///
|
||||||
/// The maximum size for a texture depends on the graphics
|
/// The maximum size for a texture depends on the graphics
|
||||||
/// driver and can be retrieved with the getMaximumSize function.
|
/// driver and can be retrieved with the getMaximumSize function.
|
||||||
@ -140,7 +140,7 @@ public :
|
|||||||
/// of the whole image. If you want the entire image then leave
|
/// of the whole image. If you want the entire image then leave
|
||||||
/// the default value (which is an empty IntRect).
|
/// the default value (which is an empty IntRect).
|
||||||
/// If the \a area rectangle crosses the bounds of the image, it
|
/// If the \a area rectangle crosses the bounds of the image, it
|
||||||
/// is adjusted to fit the image size.
|
/// is adjusted to fit the image size.
|
||||||
///
|
///
|
||||||
/// The maximum size for a texture depends on the graphics
|
/// The maximum size for a texture depends on the graphics
|
||||||
/// driver and can be retrieved with the getMaximumSize function.
|
/// driver and can be retrieved with the getMaximumSize function.
|
||||||
@ -172,7 +172,7 @@ public :
|
|||||||
/// of the whole image. If you want the entire image then leave
|
/// of the whole image. If you want the entire image then leave
|
||||||
/// the default value (which is an empty IntRect).
|
/// the default value (which is an empty IntRect).
|
||||||
/// If the \a area rectangle crosses the bounds of the image, it
|
/// If the \a area rectangle crosses the bounds of the image, it
|
||||||
/// is adjusted to fit the image size.
|
/// is adjusted to fit the image size.
|
||||||
///
|
///
|
||||||
/// The maximum size for a texture depends on the graphics
|
/// The maximum size for a texture depends on the graphics
|
||||||
/// driver and can be retrieved with the getMaximumSize function.
|
/// driver and can be retrieved with the getMaximumSize function.
|
||||||
@ -196,7 +196,7 @@ public :
|
|||||||
/// of the whole image. If you want the entire image then leave
|
/// of the whole image. If you want the entire image then leave
|
||||||
/// the default value (which is an empty IntRect).
|
/// the default value (which is an empty IntRect).
|
||||||
/// If the \a area rectangle crosses the bounds of the image, it
|
/// If the \a area rectangle crosses the bounds of the image, it
|
||||||
/// is adjusted to fit the image size.
|
/// is adjusted to fit the image size.
|
||||||
///
|
///
|
||||||
/// The maximum size for a texture depends on the graphics
|
/// The maximum size for a texture depends on the graphics
|
||||||
/// driver and can be retrieved with the getMaximumSize function.
|
/// driver and can be retrieved with the getMaximumSize function.
|
||||||
@ -478,7 +478,7 @@ private :
|
|||||||
/// accordingly.
|
/// accordingly.
|
||||||
/// The returned size is greater than or equal to the original size.
|
/// The returned size is greater than or equal to the original size.
|
||||||
///
|
///
|
||||||
/// \param Size size to convert
|
/// \param size size to convert
|
||||||
///
|
///
|
||||||
/// \return Valid nearest size (greater than or equal to specified size)
|
/// \return Valid nearest size (greater than or equal to specified size)
|
||||||
///
|
///
|
||||||
@ -529,7 +529,7 @@ private :
|
|||||||
/// before creating the final texture, you can load your file to a
|
/// before creating the final texture, you can load your file to a
|
||||||
/// sf::Image, do whatever you need with the pixels, and then call
|
/// sf::Image, do whatever you need with the pixels, and then call
|
||||||
/// Texture::loadFromImage.
|
/// Texture::loadFromImage.
|
||||||
///
|
///
|
||||||
/// Since they live in the graphics card memory, the pixels of a texture
|
/// Since they live in the graphics card memory, the pixels of a texture
|
||||||
/// cannot be accessed without a slow copy first. And they cannot be
|
/// cannot be accessed without a slow copy first. And they cannot be
|
||||||
/// accessed individually. Therefore, if you need to read the texture's
|
/// accessed individually. Therefore, if you need to read the texture's
|
||||||
|
@ -94,7 +94,7 @@ public :
|
|||||||
bool loadImageFromStream(InputStream& stream, std::vector<Uint8>& pixels, Vector2u& size);
|
bool loadImageFromStream(InputStream& stream, std::vector<Uint8>& pixels, Vector2u& size);
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \bref Save an array of pixels as an image file
|
/// \brief Save an array of pixels as an image file
|
||||||
///
|
///
|
||||||
/// \param filename Path of image file to save
|
/// \param filename Path of image file to save
|
||||||
/// \param pixels Array of pixels to save to image
|
/// \param pixels Array of pixels to save to image
|
||||||
|
@ -137,7 +137,7 @@ namespace sf {
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Compute the position of the cursor
|
/// \brief Compute the position of the cursor
|
||||||
///
|
///
|
||||||
/// \param eventOrNil
|
/// \param eventOrNil if nil the cursor position is the current one
|
||||||
///
|
///
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
-(NSPoint)cursorPositionFromEvent:(NSEvent*)eventOrNil;
|
-(NSPoint)cursorPositionFromEvent:(NSEvent*)eventOrNil;
|
||||||
|
Loading…
Reference in New Issue
Block a user