doc: Add default values to all properties

Thanks to @bojidar-bg's impressive work in #29380.
This commit is contained in:
Rémi Verschelde 2019-06-29 12:38:01 +02:00
parent 82604195b4
commit c6cea6e9b3
394 changed files with 2881 additions and 2719 deletions

View file

@ -18,25 +18,25 @@
<methods>
</methods>
<members>
<member name="display_to_lens" type="float" setter="set_display_to_lens" getter="get_display_to_lens">
<member name="display_to_lens" type="float" setter="set_display_to_lens" getter="get_display_to_lens" default="4.0">
The distance between the display and the lenses inside of the device in centimeters.
</member>
<member name="display_width" type="float" setter="set_display_width" getter="get_display_width">
<member name="display_width" type="float" setter="set_display_width" getter="get_display_width" default="14.5">
The width of the display in centimeters.
</member>
<member name="eye_height" type="float" setter="set_eye_height" getter="get_eye_height">
<member name="eye_height" type="float" setter="set_eye_height" getter="get_eye_height" default="1.85">
The height at which the camera is placed in relation to the ground (i.e. [ARVROrigin] node).
</member>
<member name="iod" type="float" setter="set_iod" getter="get_iod">
<member name="iod" type="float" setter="set_iod" getter="get_iod" default="6.0">
The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye.
</member>
<member name="k1" type="float" setter="set_k1" getter="get_k1">
<member name="k1" type="float" setter="set_k1" getter="get_k1" default="0.215">
The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect.
</member>
<member name="k2" type="float" setter="set_k2" getter="get_k2">
<member name="k2" type="float" setter="set_k2" getter="get_k2" default="0.215">
The k2 lens factor, see k1.
</member>
<member name="oversample" type="float" setter="set_oversample" getter="get_oversample">
<member name="oversample" type="float" setter="set_oversample" getter="get_oversample" default="1.5">
The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance.
</member>
</members>