[RFC] citro3d documentation by oreo639 · Pull Request #54 · devkitPro/citro3d

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 · 2021-04-07T00:26:34Z

This is a work in progress pr to finish the documentation for citro3d.
You can check out the pr's docs here:
https://oreo639.github.io/citro3d/index.html

Warning:
This may contain mistakes or poor wording choices.
Comments are welcome.

Note: The PR should be mostly complete, however the last commit will need to be changed when merged.

fincs

1/N review done, definitely will be more

thejsa

Proofreading for spelling and grammar; s/ctrulib/libctru; and a handful of suggestions to help things read more naturally.

oreo639 · 2021-04-08T00:51:25Z

Thank you for the review. Sorry about the typos.

Just copying these down so they don't get buried.
What still needs to be looked into:

ian-h-chamberlain · 2022-07-23T18:46:45Z

This PR looks great! It may have gotten a little stale but would still be valuable to have. Any chance of it being revived and/or accepted + published? I have been using https://oreo639.github.io/citro3d/index.html as my go-to for citro3d docs and would love to see this upstreamed and officially published.

If it would be helpful, I can try to review or help any other way, but I am of the opinion that any amount of docs is better than none! Let me know if there's any way to help see this PR through across the finish line.

oreo639 · 2022-07-24T01:00:55Z

Thanks for the comments.

Here is a brief overview of what needs to be finished:

shadows and lighting
proctex
fog

These are things I would preferably experiment with and write applications using them and I just haven't gotten around to that yet.

Here is a list of other remaining tasks in order from most to least important:

Proofreading (grammar mistakes are certainly an issue, but I am primarily concerned about misleading/incorrect descriptions and missing notes/pitfalls that may not be obvious to new users of the library, one that I have since been informed of but need to commit is C3D_SetScissor(), as an example, which requires you to take into account the rotation of the screen)
Better descriptions (There is no point in having doFoo() -> Does foo. type descriptions)
Grouping everything. (similar to citro2d)
Possibly provide a basic description on how to use the library (similar to libtheora's documentation)

I'm sorry about the delay, my attention has primarily been focused on other projects, but I'll try to look into this more in two weeks give or take.
Any comments or feedback would be greatly appreciated.

ian-h-chamberlain

@oreo639 thanks for updating! I have not been using the library for long so I'm not sure how much review help I could provide, but I left some comments/questions for things I saw in the PR.

Depending how the maintainers feel, I think it could be valuable to merge the PR even as-is and allow for future documentation improvements to come in separately, but maybe they'd rather have everything all at once?

ian-h-chamberlain · 2022-08-07T00:35:31Z

+ * @param[in] color Specifies the RGBA blend color. The initial value is 0.
+ */
 void C3D_BlendingColor(u32 color);
+


missing doc for C3D_EarlyDepthTest ?

ian-h-chamberlain · 2022-08-07T00:36:22Z

 void C3D_ColorLogicOp(GPU_LOGICOP op);
+
 void C3D_FragOpMode(GPU_FRAGOPMODE mode);
+


couple of other missing docs here as well, it looks like, but these functions also seem to be pretty self-explanatory so it may not be worth adding.

ian-h-chamberlain

I'm not really enough of a domain expert to review all the descriptions, but I'd love to see this accepted in some form! Thanks for your efforts @oreo639 — this looks like a huge undertaking and having citro3d documentation like this would be super valuable!

Golem642 · 2024-06-27T21:28:37Z

Does anyone know anything about fog/gas rendering? The wiki's empty of description with just the source code shown

fincs · 2024-06-27T21:32:51Z

There is already a fog example. As for gas support, the current code in citro3d is unfinished. I intend to revisit this soon.

Fragment lighting equations based on https://mathb.in/26766 from Halcy.

oreo639 force-pushed the c3d-docs branch from 01c7238 to c39302bCompare April 7, 2021 19:35

fincs reviewed Apr 7, 2021
View reviewed changes

thejsa suggested changes Apr 7, 2021
View reviewed changes

oreo639 force-pushed the c3d-docs branch from c39302b to 54eb661Compare April 8, 2021 00:50

oreo639 force-pushed the c3d-docs branch 8 times, most recently from b50ed0e to 8c291c5Compare April 11, 2021 07:28

oreo639 force-pushed the c3d-docs branch from 8c291c5 to dc3c1bfCompare April 27, 2021 05:36

oreo639 force-pushed the c3d-docs branch 5 times, most recently from c208264 to 1bf702cCompare January 25, 2022 09:59

oreo639 force-pushed the c3d-docs branch 3 times, most recently from 90ad127 to 49de608Compare August 6, 2022 18:36

ian-h-chamberlain reviewed Aug 7, 2022
View reviewed changes

oreo639 force-pushed the c3d-docs branch 5 times, most recently from 03719df to e017b56Compare August 7, 2022 04:33

fincs mentioned this pull request Oct 5, 2022
Created Doxygen documentation #61
Closed

oreo639 force-pushed the c3d-docs branch 2 times, most recently from 4531901 to ba70b26Compare July 29, 2023 10:43

ian-h-chamberlain approved these changes Aug 4, 2023
View reviewed changes

oreo639 force-pushed the c3d-docs branch from ba70b26 to bf7d2fdCompare December 15, 2024 02:39

docs: update doxyfile
33e7995

oreo639 force-pushed the c3d-docs branch 2 times, most recently from 8d363fe to 071946fCompare December 15, 2024 03:39

oreo639 added 12 commits December 14, 2024 19:58

docs: inital base documentation
d0c51f6

docs: add documentation for citro3d centeral header
64eaddb

docs: inital attribs documentation
9760c32

docs: inital buffers documentation
f99602f

docs: add doc header to maths
cfe9bd4

docs: updates types documentation
4ed5105

docs: inital framebuffer documentation
6e1ea6c

docs: inital renderqueue documentation
ce94033

docs: inital uniforms documentation
5a9f95d

docs: inital texture documentation
55ece4d

docs: inital texenv documentation
6917401

docs: inital effect documentation
f479c82

oreo639 force-pushed the c3d-docs branch 2 times, most recently from fde4c32 to bc3d68eCompare December 15, 2024 04:04

oreo639 marked this pull request as ready for review October 24, 2025 18:14

oreo639 marked this pull request as draft October 24, 2025 18:14

oreo639 added 3 commits November 24, 2025 13:49

docs: initial light documentation
d7079dd
Fragment lighting equations based on https://mathb.in/26766 from Halcy.

docs: initial lightlut documentation
f24c24a

docs: use github actions for generating documentation
7ceed00

oreo639 force-pushed the c3d-docs branch from bc3d68e to 7ceed00Compare November 24, 2025 21:49