-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document VRAM transfer managers for sprite components #357
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a small handful of nitpicks and names I think we could refine.
} | ||
} | ||
|
||
void *CharTransfer_PopTaskManager(void) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: I'm only familiar with push/pop in the context of stacks - is this another way it's used? Without looking at these functions, I would be inclined to think it's a stack, unless I'm just unfamiliar with this usage of that terminology.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Push/Pop can apply to any collection or concept where an underlying reference changes as a result of the operation. That definitely applies here (the private task manager changes pointer changes).
break; | ||
case GX_VRAM_OBJ_16_F: | ||
case GX_VRAM_OBJ_16_G: | ||
sTaskManager->vramSizeMain = 16 * 1024; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: Is there a descriptive constant we can use for the 1024
s here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's just a kilobyte conversion. I don't think it's super worth a constant; this code is quite low-level, and I don't expect many users to ever look at it. 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
This wound up being a bigger PR than I wanted it to be, but I felt like I should just document all of these related components in one fell swoop rather than leave any of them lingering.