docs: clarify pointer lifetimes for ktxTexture_SetImageFromMemory #917
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
|
|
MarkCallow
reviewed
Jun 17, 2024
|
Sorry for my delay reviewing this. Work was hampered for more than a week by an error in the GitHub Actions Windows runner image. |
ktxTexture1_SetImageFromMemory and ktxTexture2_SetImageFromMemory accept a pointer to image memory but do not clearly document if ownership of those pointers is transferred or copied. This commit adds a doxygen warning informing users that the underlying image data is copied and therefore they are responsible for their copy of the image memory. Closes #914
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.
Problem
ktxTexture1_SetImageFromMemoryandktxTexture2_SetImageFromMemoryaccept a pointer to image memory but do not clearly document if ownership of those pointers is transferred or copied.Solution
This commit adds a Doxygen note informing users that the underlying image data is copied and that they are responsible for freeing the original copy of image memory.
Testing
Documentation updates were manually verified by building the project using the
KTX_FEATURE_DOC=ONCMake option and viewing the generated Doxygen output using a local server.Closes #914