Make user aware that findCharactarPos returns top of the line position #2999
+3
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Linking #2988 to this |
eXpl0it3r
reviewed
May 13, 2024
include/SFML/Graphics/Text.hpp
Outdated
| /// origin are applied). | ||
| /// the global coordinates (translation, rotation, scale and | ||
| /// origin are applied) at the top of the character's text | ||
| /// line. |
There was a problem hiding this comment.
I'd swap it around:
...position is at the top of the character's line in global coordinates...
There was a problem hiding this comment.
Is "character's text line" descriptive enough? If you hadn't had these discussions over the past few days, would you understand what it means?
There was a problem hiding this comment.
I'm thinking about adding some information to the SFML-Website repo with like an image that we can use to define:
"top of the line"
"bottom of the line"
"line height"
"glyph bounds"
There was a problem hiding this comment.
ascender height is very clear and googlable way of documenting what it's doing. I'm happy with this imho
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This doesn't need any testing, just documentation changes. I really do think a lot of this confusion may be avoided if we atleast mention this "top of the line" stuff