-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Explain TOGGLE_PAUSED_RENDERPHASES #912
Conversation
Also rename variable
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.
Is the change from toggle
to rendering
really needed?
In my opinion, toggle
does sound better.
Other than that, the descriptions looked fairly good to me.
the param description could probably be a bit better/easier to understand though, such as: Whether to free the camera or not
I think the original parameter name is fine, not sure why it would need a name change. |
I renamed it from 'toggle' to rendering because the native name together with the argument name doesn't make it clear which status it toggles to, which is the primary function of an argument name. Does it toggle rendering on? Does it toggle paused rendering on, meaning it doesn't render? |
The variable/param name "toggle" sounds much better though, and is uniform with the rest of the documentation. |
GRAPHICS/TogglePausedRenderphases.md
Outdated
``` | ||
|
||
Freezes the screen in its current state. |
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.
Better description would be Switches the rendering display to exclude everything except PostFX, resulting in a frozen screen before the UI pass.
GRAPHICS/TogglePausedRenderphases.md
Outdated
|
||
## Parameters | ||
* **toggle**: | ||
|
||
* **rendering**: Whether to actively render the camera |
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.
This should be toggle
since it's a "toggle" native.
Change back to `toggle`, also clarify what the parameter does. Thanks to @PsychoShock for the suggested description.
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.
LGTM, merging, thank you! 😊
Also rename variable