Missing Hlms docs Topic is solved

Discussion area about developing with Ogre-Next (2.1, 2.2 and beyond)


jwwalker
Goblin
Posts: 247
Joined: Thu Aug 12, 2021 10:06 pm
Location: San Diego, CA, USA
x 18

Missing Hlms docs

Post 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.

User avatar
dark_sylinc
OGRE Team Member
OGRE Team Member
Posts: 5433
Joined: Sat Jul 21, 2007 4:55 pm
Location: Buenos Aires, Argentina
x 1341

Re: Missing Hlms docs

Post by dark_sylinc »

Thanks for troubleshooting it!

Fixed.

User avatar
Crystal Hammer
Gnome
Posts: 388
Joined: Sat Jun 23, 2007 5:16 pm
x 99

Re: Missing Hlms docs

Post 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.