diff options
| author | Chris Bradfield <cb@scribe.net> | 2017-10-25 08:54:15 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-25 08:54:15 -0700 |
| commit | c9e6168db0959864b279a4641bc51f3fe2d13e12 (patch) | |
| tree | 638bf5f6d1d6f064d28def01ca0ce06ae825058a /doc | |
| parent | 3504bb70a48dd7c1d0d587900c96bbd7af91754b (diff) | |
| parent | e0b2a74a14ab0ecb673d5969b9fd2b9e8269db84 (diff) | |
Merge pull request #12375 from NathanWarden/cubemap_docs
[DOCS] CubeMap
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/CubeMap.xml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index 5626554193..b173bba3c6 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CubeMap" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> <brief_description> + A CubeMap is a 6 sided 3D texture. </brief_description> <description> + A CubeMap is a 6 sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. </description> <tutorials> </tutorials> @@ -19,6 +21,7 @@ <return type="int"> </return> <description> + Returns the CubeMap's height. </description> </method> <method name="get_lossy_storage_quality" qualifiers="const"> @@ -33,6 +36,7 @@ <argument index="0" name="side" type="int" enum="CubeMap.Side"> </argument> <description> + Returns an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> <method name="get_storage" qualifiers="const"> @@ -45,6 +49,7 @@ <return type="int"> </return> <description> + Returns the CubeMap's width. </description> </method> <method name="set_flags"> @@ -71,6 +76,7 @@ <argument index="1" name="image" type="Image"> </argument> <description> + Sets an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> <method name="set_storage"> @@ -84,8 +90,10 @@ </methods> <members> <member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality"> + The lossy storage quality of the CubeMap if the storage mode is set to STORAGE_COMPRESS_LOSSY. </member> <member name="storage_mode" type="int" setter="set_storage" getter="get_storage" enum="CubeMap.Storage"> + The CubeMap's storage mode. See [code]STORAGE_*[/code] constants. </member> </members> <constants> |