Browse Source

Merge pull request #63858 from Calinou/doc-camera3d-frustum-offset-projection-3.x

Document Camera's frustum offset property requiring Frustum projection (3.x)
Rémi Verschelde 3 years ago
parent
commit
a1c0be731d
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/classes/Camera.xml

+ 2 - 1
doc/classes/Camera.xml

@@ -100,7 +100,7 @@
 			<argument index="2" name="z_near" type="float" />
 			<argument index="2" name="z_near" type="float" />
 			<argument index="3" name="z_far" type="float" />
 			<argument index="3" name="z_far" type="float" />
 			<description>
 			<description>
-				Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units.
+				Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. See also [member frustum_offset].
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="set_orthogonal">
 		<method name="set_orthogonal">
@@ -164,6 +164,7 @@
 		</member>
 		</member>
 		<member name="frustum_offset" type="Vector2" setter="set_frustum_offset" getter="get_frustum_offset" default="Vector2( 0, 0 )">
 		<member name="frustum_offset" type="Vector2" setter="set_frustum_offset" getter="get_frustum_offset" default="Vector2( 0, 0 )">
 			The camera's frustum offset. This can be changed from the default to create "tilted frustum" effects such as [url=https://zdoom.org/wiki/Y-shearing]Y-shearing[/url].
 			The camera's frustum offset. This can be changed from the default to create "tilted frustum" effects such as [url=https://zdoom.org/wiki/Y-shearing]Y-shearing[/url].
+			[b]Note:[/b] Only effective if [member projection] is [constant PROJECTION_FRUSTUM].
 		</member>
 		</member>
 		<member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset" default="0.0">
 		<member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset" default="0.0">
 			The horizontal (X) offset of the camera viewport.
 			The horizontal (X) offset of the camera viewport.