소스 검색

[DOCS] CubeMap

Nathan Warden 8 년 전
부모
커밋
e0b2a74a14
1개의 변경된 파일8개의 추가작업 그리고 0개의 파일을 삭제
  1. 8 0
      doc/classes/CubeMap.xml

+ 8 - 0
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>