docs: record that text and 9-slice parts are not drawn - #243
Merged
Merged
Conversation
ss_internal_player.cpp has said so in a comment since the batch dispatch was written — "DrawBatchKind_Text / Nines / Mask: not yet implemented" — but the limitations page never did, so an author had no way to find out short of trying it. 9-slice is the surprising half: the runtime builds the whole grid into dedicated Nines SoA buffers rather than into local_vertices, so a player that does not read those buffers draws nothing at all, not a stretched cell. Both part types keep their place in the draw order, so an animation using them plays with those parts missing rather than failing.
This file contains hidden or 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
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.
Why
ss_internal_player.cpphas said this in a comment since the batch dispatch was written:// DrawBatchKind_Text / Nines / Mask: not yet implemented.…but
docs/{en,ja}/limitations.mdnever did, so an author had no way to find out short of trying it and seeing nothing appear. (Maskin that list is fine — pure masks feed the coverage bitmap and are drawn elsewhere.TextandNinesare genuinely unimplemented.)This came out of an ecosystem-wide audit: all five official players are in the same position, and none but Ren'Py documented it.
What changed
A Not Yet Implemented section, placed first — matching where Ren'Py puts its equivalent.
9-slice is the surprising half. The runtime builds the entire grid — margins, fill mode, repeats — into dedicated
NinesSoA buffers (ss_runtime_get_nines_verticesand friends), andlocal_verticescarries only the part's plain bounding quad. So a player that does not read those buffers draws nothing at all, not a stretched cell. "The runtime builds it, so it just works" is not true here.Both part types keep their place in the draw order, so an animation that uses them plays with those parts missing rather than failing — worth saying, because it means the symptom is a silent gap rather than a crash.
Scope
Documentation only, both locales. No behaviour change.
.venv/bin/mkdocs build --strictpasses.