Skip to content
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

Manual Content: Several shader functions should be documented because they are not able to be shown in autocomplete inside the IDE #8597

Closed
gm-bug-reporter bot opened this issue Dec 2, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation are required by this issue ide-bug Bugs with the GameMaker IDE
Milestone

Comments

@gm-bug-reporter
Copy link

Description

While the functions "float CalcFogFactor(vec4 pos)", "vec4 DoDirLight(vec3 ws_normal, vec4 dir, vec4 diffusecol)", "vec4 DoPointLight(vec3 ws_pos, vec3 ws_normal, vec4 posrange, vec4 diffusecol)" and "vec4 DoLighting(vec4 vertexcolour, vec4 objectspacepos, vec3 objectspacenormal)" are defined and accessible in vertex shaders, this is not documented or supported by the IDE (not syntax highlighted). This should at least be documented as writing a function with one of these names and parameters would lead to an unexplained compilation error. The same goes for the functions "void DoAlphaTest(vec4 SrcColour)" and "void DoFog(inout vec4 SrcColour, float fogval)" in fragment shaders.

Which version of GameMaker are you reporting this issue for?

IDE v2024.8.1.171 Runtime v2024.8.1.218

Which operating system(s) are you seeing the problem on?

Windows 10.0.22631.0

ced5063a-affc-4b07-8b8d-93f5fdf81ad2

@gm-bug-reporter gm-bug-reporter bot added the ide-bug Bugs with the GameMaker IDE label Dec 2, 2024
@YYDan YYDan changed the title gm shader functions are not defined in the documentation Code Editor: Several shader functions are not defined in autocomplete (or the manual) Dec 3, 2024
@YYDan YYDan added the documentation Improvements or additions to documentation are required by this issue label Dec 3, 2024
@stuckie stuckie moved this from Triage to Backlog in Team Workload Dec 3, 2024
@stuckie
Copy link

stuckie commented Dec 3, 2024

We cannot currently do the autocomplete in the editor, but we can add them to the manual.

@YYBartT YYBartT moved this from Backlog to In Progress in Team Workload Dec 12, 2024
@YYBartT YYBartT added this to the 2024.13 milestone Dec 16, 2024
YYBartT added a commit to YoYoGames/GameMaker-Manual that referenced this issue Dec 16, 2024
…te (or the manual)

YoYoGames/GameMaker-Bugs#8597

* Listed the functions on the Shaders page
* Added a bit of structure to the Shaders page, adding headers and moving paragraphs under those
@YYBartT YYBartT closed this as completed Dec 16, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Team Workload Dec 16, 2024
@YYDan YYDan changed the title Code Editor: Several shader functions are not defined in autocomplete (or the manual) Manual Content: Several shader functions should be documented because they are not able to be shown in autocomplete inside the IDE Dec 16, 2024
@YYBartT
Copy link

YYBartT commented Dec 17, 2024

Listed the functions on the Shaders page. Also added a bit of structure to the page, dividing the text in sections.

@mgeddesGM
Copy link

verified

@mgeddesGM mgeddesGM moved this from Ready for QA to Verified in Team Workload Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation are required by this issue ide-bug Bugs with the GameMaker IDE
Projects
Status: Verified
Development

No branches or pull requests

5 participants