diff options
Diffstat (limited to 'doc/classes/Texture.xml')
| -rw-r--r-- | doc/classes/Texture.xml | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index a856eb64ad..bf27bc4768 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Texture" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Texture" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Texture for 2D and 3D. </brief_description> @@ -116,25 +116,29 @@ </method> </methods> <constants> - <constant name="FLAG_MIPMAPS" value="1"> - Generate mipmaps, to enable smooth zooming out of the texture. + <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> + Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> - <constant name="FLAG_REPEAT" value="2"> - Repeat (instead of clamp to edge). + <constant name="FLAG_REPEAT" value="2" enum="Flags"> + Repeats texture (instead of clamp to edge). </constant> - <constant name="FLAG_FILTER" value="4"> - Turn on magnifying filter, to enable smooth zooming in of the texture. + <constant name="FLAG_FILTER" value="4" enum="Flags"> + Magnifying filter, to enable smooth zooming in of the texture. </constant> - <constant name="FLAGS_DEFAULT" value="7"> + <constant name="FLAGS_DEFAULT" value="7" enum="Flags"> Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> - <constant name="FLAG_ANISOTROPIC_FILTER" value="8"> + <constant name="FLAG_ANISOTROPIC_FILTER" value="8" enum="Flags"> + Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. + More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. </constant> - <constant name="FLAG_CONVERT_TO_LINEAR" value="16"> + <constant name="FLAG_CONVERT_TO_LINEAR" value="16" enum="Flags"> + Converts texture to SRGB color space. </constant> - <constant name="FLAG_MIRRORED_REPEAT" value="32"> + <constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags"> + Repeats texture with alternate sections mirrored. </constant> - <constant name="FLAG_VIDEO_SURFACE" value="4096"> + <constant name="FLAG_VIDEO_SURFACE" value="4096" enum="Flags"> Texture is a video surface. </constant> </constants> |