summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2022-08-03 02:44:13 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2022-08-03 02:46:12 +0200
commitc3720e2381c16fd8bc34dea5bc748d203079bf5f (patch)
tree5412e9b322255a9fdced58170656520889dd4edb
parent3b39f00761145a44a6c6d45320d6e26b944814a3 (diff)
Document Camera3D's frustum offset property requiring Frustum projection
-rw-r--r--doc/classes/Camera3D.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml
index 3aedbbd1e6..5595abc02a 100644
--- a/doc/classes/Camera3D.xml
+++ b/doc/classes/Camera3D.xml
@@ -113,7 +113,7 @@
<argument index="2" name="z_near" type="float" />
<argument index="3" name="z_far" type="float" />
<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>
</method>
<method name="set_orthogonal">
@@ -179,6 +179,7 @@
</member>
<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].
+ [b]Note:[/b] Only effective if [member projection] is [constant PROJECTION_FRUSTUM].
</member>
<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.