Page 1 of 1

Missing Hlms docs

Posted: Tue Jul 23, 2024 11:47 pm
by jwwalker

In the online API docs under https://ogrecave.github.io/ogre-next/api/latest/ , I am not seeing docs for classes such as HlmsPbs and HlmsUnlitDatablock. Now, I have minimal understanding of Cmake, but I am suspicious of the line in Docs/CMakeLists.txt where it says:

Code: Select all

file(GLOB COMPONENTS ${OGRE_SOURCE_DIR}/Components/*/include)

I think that's going to find paths like Components/PlanarReflections/include, but not paths like Components/Hlms/Pbs/include.


Re: Missing Hlms docs

Posted: Wed Jul 24, 2024 4:23 pm
by dark_sylinc

Thanks for troubleshooting it!

Fixed.


Re: Missing Hlms docs

Posted: Thu Jul 25, 2024 8:06 am
by Crystal Hammer

On the topic of docs I found:
enable_forwardplus in code
mIds["enable_forwardplus"] = ID_ENABLE_FORWARDPLUS;
but wrong in doc Docs/src/manual/compositor.md:

Code: Select all

-   enable\_plus \[yes|no\]

When yes, this pass will use Forward3D/ForwardClustered (must be enabled first
by the developer via C++, see Forward3D sample). When No, Forward3D will not be
used for this pass, which can improve performance both CPU and GPU side
(but many lights are likely not going to be drawn or used). Default:
Yes.

In 3-0 branch, seems ok in main.