NVIDIAGameWorks / FleX

Other
646 stars 99 forks source link

Documentation for SetPhases is out of date. #133

Open ixchow opened 2 years ago

ixchow commented 2 years ago

The documentation for NvFlexSetPhases (and the html generated from it) says:

Particles with a non-zero phase id only interact with particles whose phase differs from theirs. This is useful, for example, to stop particles belonging to a single rigid shape from interacting with each other.

However the current version of FleX has quite a bit more flexibility in what phase means; see (e.g.) the NvFlexPhase enum. I suggest this paragraph be removed or modified to point to that enum.

It also says:

Phase 0 is used to indicate fluid particles when NvFlexParams::mFluid is set.

This references a parameter (mFluid) that does not exist. I suggest this paragraph be removed.