asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/Projection.xml

274 lines
8.7 KiB
XML
Raw Normal View History

Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-20 01:11:13 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Projection" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<constructors>
<constructor name="Projection">
<return type="Projection" />
<description>
</description>
</constructor>
<constructor name="Projection">
<return type="Projection" />
<argument index="0" name="from" type="Projection" />
<description>
</description>
</constructor>
<constructor name="Projection">
<return type="Projection" />
<argument index="0" name="from" type="Transform3D" />
<description>
</description>
</constructor>
</constructors>
<methods>
<method name="create_depth_correction" qualifiers="static">
<return type="Projection" />
<argument index="0" name="flip_y" type="bool" />
<description>
</description>
</method>
<method name="create_fit_aabb" qualifiers="static">
<return type="Projection" />
<argument index="0" name="aabb" type="AABB" />
<description>
</description>
</method>
<method name="create_for_hmd" qualifiers="static">
<return type="Projection" />
<argument index="0" name="eye" type="int" />
<argument index="1" name="aspect" type="float" />
<argument index="2" name="intraocular_dist" type="float" />
<argument index="3" name="display_width" type="float" />
<argument index="4" name="display_to_lens" type="float" />
<argument index="5" name="oversample" type="float" />
<argument index="6" name="z_near" type="float" />
<argument index="7" name="z_far" type="float" />
<description>
</description>
</method>
<method name="create_frustum" qualifiers="static">
<return type="Projection" />
<argument index="0" name="left" type="float" />
<argument index="1" name="right" type="float" />
<argument index="2" name="bottom" type="float" />
<argument index="3" name="top" type="float" />
<argument index="4" name="z_near" type="float" />
<argument index="5" name="z_far" type="float" />
<description>
</description>
</method>
<method name="create_frustum_aspect" qualifiers="static">
<return type="Projection" />
<argument index="0" name="size" type="float" />
<argument index="1" name="aspect" type="float" />
<argument index="2" name="offset" type="Vector2" />
<argument index="3" name="z_near" type="float" />
<argument index="4" name="z_far" type="float" />
<argument index="5" name="flip_fov" type="bool" default="false" />
<description>
</description>
</method>
<method name="create_light_atlas_rect" qualifiers="static">
<return type="Projection" />
<argument index="0" name="rect" type="Rect2" />
<description>
</description>
</method>
<method name="create_orthogonal" qualifiers="static">
<return type="Projection" />
<argument index="0" name="left" type="float" />
<argument index="1" name="right" type="float" />
<argument index="2" name="bottom" type="float" />
<argument index="3" name="top" type="float" />
<argument index="4" name="z_near" type="float" />
<argument index="5" name="z_far" type="float" />
<description>
</description>
</method>
<method name="create_orthogonal_aspect" qualifiers="static">
<return type="Projection" />
<argument index="0" name="size" type="float" />
<argument index="1" name="aspect" type="float" />
<argument index="2" name="z_near" type="float" />
<argument index="3" name="z_far" type="float" />
<argument index="4" name="flip_fov" type="bool" default="false" />
<description>
</description>
</method>
<method name="create_perspective" qualifiers="static">
<return type="Projection" />
<argument index="0" name="fovy" type="float" />
<argument index="1" name="aspect" type="float" />
<argument index="2" name="z_near" type="float" />
<argument index="3" name="z_far" type="float" />
<argument index="4" name="flip_fov" type="bool" default="false" />
<description>
</description>
</method>
<method name="create_perspective_hmd" qualifiers="static">
<return type="Projection" />
<argument index="0" name="fovy" type="float" />
<argument index="1" name="aspect" type="float" />
<argument index="2" name="z_near" type="float" />
<argument index="3" name="z_far" type="float" />
<argument index="4" name="flip_fov" type="bool" />
<argument index="5" name="eye" type="int" />
<argument index="6" name="intraocular_dist" type="float" />
<argument index="7" name=" convergence_dist" type="float" />
<description>
</description>
</method>
<method name="determinant" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="flipped_y" qualifiers="const">
<return type="Projection" />
<description>
</description>
</method>
<method name="get_aspect" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="get_far_plane_half_extents" qualifiers="const">
<return type="Vector2" />
<description>
</description>
</method>
<method name="get_fov" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="get_fovy" qualifiers="static">
<return type="float" />
<argument index="0" name="fovx" type="float" />
<argument index="1" name="aspect" type="float" />
<description>
</description>
</method>
<method name="get_lod_multiplier" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="get_pixels_per_meter" qualifiers="const">
<return type="int" />
<argument index="0" name="for_pixel_width" type="int" />
<description>
</description>
</method>
<method name="get_projection_plane" qualifiers="const">
<return type="Plane" />
<argument index="0" name="plane" type="int" />
<description>
</description>
</method>
<method name="get_viewport_half_extents" qualifiers="const">
<return type="Vector2" />
<description>
</description>
</method>
<method name="get_z_far" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="get_z_near" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="inverse" qualifiers="const">
<return type="Projection" />
<description>
</description>
</method>
<method name="is_orthogonal" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
<method name="jitter_offseted" qualifiers="const">
<return type="Projection" />
<argument index="0" name="offset" type="Vector2" />
<description>
</description>
</method>
<method name="perspective_znear_adjusted" qualifiers="const">
<return type="Projection" />
<argument index="0" name="new_znear" type="float" />
<description>
</description>
</method>
</methods>
<members>
<member name="w" type="Vector4" setter="" getter="" default="Vector4(0, 0, 0)">
</member>
<member name="x" type="Vector4" setter="" getter="" default="Vector4(1, 0, 0)">
</member>
<member name="y" type="Vector4" setter="" getter="" default="Vector4(0, 1, 0)">
</member>
<member name="z" type="Vector4" setter="" getter="" default="Vector4(0, 0, 1)">
</member>
</members>
<constants>
<constant name="PLANE_NEAR" value="0">
</constant>
<constant name="PLANE_FAR" value="1">
</constant>
<constant name="PLANE_LEFT" value="2">
</constant>
<constant name="PLANE_TOP" value="3">
</constant>
<constant name="PLANE_RIGHT" value="4">
</constant>
<constant name="PLANE_BOTTOM" value="5">
</constant>
<constant name="IDENTITY" value="Projection(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1)">
</constant>
<constant name="ZERO" value="Projection(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)">
</constant>
</constants>
<operators>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="Projection" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Projection" />
<argument index="0" name="right" type="Projection" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector4" />
<argument index="0" name="right" type="Vector4" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Projection" />
<description>
</description>
</operator>
<operator name="operator []">
<return type="Vector4" />
<argument index="0" name="index" type="int" />
<description>
</description>
</operator>
</operators>
</class>
Reference in a new issue Copy permalink