[rl_gputex] fix: decouple logging and memory allocation from Raylib #5045
Conversation
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
- make sure that src/external/rl_gputex.h uses it's own macros
for printing warnings and allocating memory
- add few additional macros in order to decouple rl_gputex from headers
that are being included by Raylib (e.g. *_MEMSET, *_NULL and so on)
- make sure that rl_gputex uses RL_*ALLOC, TRACELOG and RLAPI macros
when (and only when) being included by src/rtextures.c
- replace LOG() and RL_GPUTEX_SHOW_LOG_INFO macros with: RL_GPUTEX_WARN
and RL_GPUTEX_SHOW_WARN_INFO (this is a breaking change, but it was
broken and unusable anyway, see:
raysan5#5039 (comment) )
- fixes issue all issues mentioned in:
raysan5#5039 (comment)
- remove logging upon successfully saving a file; Raylib does this
anyway and we want rl_gputex to only print WARNings upon failures;
see: https://discord.com/channels/426912293134270465/541710686468702250/1394406734306480352
- add additional condition when saving a file; now checks for both
fwrite() and fclose() failures; before it would warn about both,
but only return result based on fclose()
- add some notes about the current state of compiling rl_gputex
without depending on Raylib (spoiler: it's still broken...)
- bump rl_gputex version to 1.1 since this is a potential breaking
change (only for people attempting to use it without Raylib)
Fixes: raysan5#5039
Reference: https://discord.com/channels/426912293134270465/541710686468702250/1394403611852931255
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| #define RL_GPUTEX_WARN(...) TRACELOG(LOG_WARNING, "IMAGE: " __VA_ARGS__) | ||
| #define RL_GPUTEX_SHOW_WARN_INFO | ||
|
|
||
| // FIXME: probably, we should NOT export public functions from rl_gputex |
Check notice
Code scanning / CodeQL
FIXME comment Note
There was a problem hiding this comment.
It auto detected // FIXME: just by searching the text, right? I intentionally added this note here. I can remove the note or whole #define RLGPUTEXAPI RLAPI. I've kept it for (potential) backwards compatibility.
|
@sleeptightAnsiC thanks for the review, definitely there is more than I expected... I need to review it carefully |
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 is quite big, so maybe lets treat it more like a DRAFT than PR. I can either split it to smaller PR's or change few things. However, have in mind it may take some time. The
rl_gputex.his pretty hard to change. Currently, almost everything in it depends on headers that come from Raylib (rtextures.c and raylib.h). This PR tries to fix and document most of those problems, but it's not everything by any means. This should at least fix all the problems mentioned in #5039 Every little change should be documented in the commit message.commit message with full change list
Fixes: #5039
Reference: https://discord.com/channels/426912293134270465/541710686468702250/1394403611852931255