mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-01-03 01:59:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation to ParallelPeer

Browse Source
This commit is contained in:
Alexander Bock
2022-04-27 09:38:15 +02:00
parent 8cd65d9c96
commit 932aee7d93
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/network/parallelpeer.cpp
View File

@@ -83,19 +83,26 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo BufferTimeInfo = {
"BufferTime",
"Buffer Time",
"" // @TODO Missing documentation
"This is the number of seconds that received keyframes are buffered before they "
"get applied to the rendering. A higher value leads to smoother rendering, "
"particularly when the internet connection is unstable, but also leads to higher "
"delay."
};
constexpr openspace::properties::Property::PropertyInfo TimeKeyFrameInfo = {
"TimeKeyframeInterval",
"Time keyframe interval",
"" // @TODO Missing documentation
"Determines how often the information about the simulation time is sent (in "
"seconds). Lower values mean more accurate representation of the time, but also "
"require higher internet bandwidth."
};
constexpr openspace::properties::Property::PropertyInfo CameraKeyFrameInfo = {
"CameraKeyframeInterval",
"Camera Keyframe interval",
"" // @TODO Missing documentation
"Determines how often the information about the camera position and orientation "
"is sent (in seconds). Lower values mean more accurate representation of the "
"time, but also more internet traffic"
};
} // namespace