[DOC] Fill in various missing method/member descriptions.
This commit is contained in:
parent
8c9358b5d0
commit
72b43d5ed6
|
@ -51,6 +51,7 @@
|
|||
<argument index="0" name="margin" type="int" enum="Margin">
|
||||
</argument>
|
||||
<description>
|
||||
Returns the specified margin. See also [member drag_margin_bottom], [member drag_margin_top], [member drag_margin_left], and [member drag_margin_right].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_limit" qualifiers="const">
|
||||
|
@ -59,6 +60,7 @@
|
|||
<argument index="0" name="margin" type="int" enum="Margin">
|
||||
</argument>
|
||||
<description>
|
||||
Returns the specified camera limit. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right].
|
||||
</description>
|
||||
</method>
|
||||
<method name="make_current">
|
||||
|
@ -84,6 +86,7 @@
|
|||
<argument index="1" name="drag_margin" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the specified margin. See also [member drag_margin_bottom], [member drag_margin_top], [member drag_margin_left], and [member drag_margin_right].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_limit">
|
||||
|
@ -94,6 +97,7 @@
|
|||
<argument index="1" name="limit" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the specified camera limit. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
@ -161,6 +165,7 @@
|
|||
[b]Note:[/b] Used the same as [member offset_h].
|
||||
</member>
|
||||
<member name="process_mode" type="int" setter="set_process_mode" getter="get_process_mode" enum="Camera2D.Camera2DProcessMode" default="1">
|
||||
The camera's process callback. See [enum Camera2DProcessMode].
|
||||
</member>
|
||||
<member name="rotating" type="bool" setter="set_rotating" getter="is_rotating" default="false">
|
||||
If [code]true[/code], the camera rotates with the target.
|
||||
|
@ -183,8 +188,10 @@
|
|||
The camera's position takes into account vertical/horizontal offsets and the screen size.
|
||||
</constant>
|
||||
<constant name="CAMERA2D_PROCESS_PHYSICS" value="0" enum="Camera2DProcessMode">
|
||||
The camera updates with the [code]_physics_process[/code] callback.
|
||||
</constant>
|
||||
<constant name="CAMERA2D_PROCESS_IDLE" value="1" enum="Camera2DProcessMode">
|
||||
The camera updates with the [code]_process[/code] callback.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
|
@ -14,28 +14,30 @@
|
|||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Gets the unique ID for this feed.
|
||||
Returns the unique ID for this feed.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_name" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<description>
|
||||
Gets the camera's name.
|
||||
Returns the camera's name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_position" qualifiers="const">
|
||||
<return type="int" enum="CameraFeed.FeedPosition">
|
||||
</return>
|
||||
<description>
|
||||
Position of camera on the device.
|
||||
Returns the position of camera on the device.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="feed_is_active" type="bool" setter="set_active" getter="is_active" default="false">
|
||||
If [code]true[/code], the feed is active.
|
||||
</member>
|
||||
<member name="feed_transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D( 1, 0, 0, -1, 0, 1 )">
|
||||
The transform applied to the camera's image.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
@ -51,8 +51,10 @@
|
|||
[b]Note:[/b] Cannot be enabled if raw mode is on.
|
||||
</member>
|
||||
<member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled" default="true">
|
||||
If [code]true[/code], the "add preset" button is enabled.
|
||||
</member>
|
||||
<member name="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible" default="true">
|
||||
If [code]true[/code], saved color presets are visible.
|
||||
</member>
|
||||
<member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode" default="false">
|
||||
If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
|
||||
|
|
|
@ -71,6 +71,7 @@
|
|||
<return type="int" enum="Input.CursorShape">
|
||||
</return>
|
||||
<description>
|
||||
Returns the currently assigned cursor shape (see [enum CursorShape]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_gravity" qualifiers="const">
|
||||
|
|
|
@ -65,6 +65,7 @@
|
|||
If [code]true[/code], the video is paused.
|
||||
</member>
|
||||
<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
|
||||
The assigned video stream. See description for supported formats.
|
||||
</member>
|
||||
<member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position">
|
||||
The current position of the stream, in seconds.
|
||||
|
|
Loading…
Reference in New Issue