RFR: 8314147: Updated the PhongMaterial documentation [v7]
Kevin Rushforth
kcr at openjdk.org
Wed Feb 28 14:24:57 UTC 2024
On Wed, 28 Feb 2024 13:50:38 GMT, Nir Lisker <nlisker at openjdk.org> wrote:
>> Overhaul to the `PhongMaterial` documentation (and a bit to its superclass `Material`). Except for the introduction, I divided the documentation into 3 sections: qualitative explanation, mathematical model (I wouldn't think it necessary, but the current doc explains it), and examples.
>>
>> The reason for the verbosity of the doc is that I envisioned 2 target audiences for this class. One is a Java developer who wants to understand the terminology and workings of computer graphics or of the artists who are already familiar with this domain. (How many Java developers know what diffuse, specular and normal maps are?) The other is an artist who is already familiar with the domain, but wants to see how this class compares with other renderers. For this reason, I looked at the terminology used by engines like Blender, Maya, UE4 and Unity and tried to mention the comparisons (like bump vs. height vs. normal maps, or specular vs. roughness/smoothness).
>>
>> The examples I chose and some of the schematics are not the best, looking at it retroactively, but I want to give enough time for reviewers and get this into 22.
>
> Nir Lisker has updated the pull request incrementally with one additional commit since the last revision:
>
> Update images
Thank you for generating new images.
Some of the new files are quite large, and the total added storage is 35 Mbytes, which is a lot for binary image files stored in the repo. I haven't generated the docs and looked at them yet (doing that now), but it might be better to use lower resolution images.
One other thing I noticed is that the file names have spaces in them, which is not a best practice and causes problems for scripts. Can you change all spaces to `_` in the names of the newly-added files?
-------------
PR Comment: https://git.openjdk.org/jfx/pull/1378#issuecomment-1969088841
More information about the openjfx-dev
mailing list