virtualx-engine/doc/classes/CubeMap.xml

<?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>
	<demos>
	</demos>
	<methods>
		<method name="get_flags" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_height" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the CubeMap's height.
			</description>
		</method>
		<method name="get_lossy_storage_quality" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_side" qualifiers="const">
			<return type="Image">
			</return>
			<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">
			<return type="int" enum="CubeMap.Storage">
			</return>
			<description>
			</description>
		</method>
		<method name="get_width" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the CubeMap's width.
			</description>
		</method>
		<method name="set_flags">
			<return type="void">
			</return>
			<argument index="0" name="flags" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_lossy_storage_quality">
			<return type="void">
			</return>
			<argument index="0" name="quality" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_side">
			<return type="void">
			</return>
			<argument index="0" name="side" type="int" enum="CubeMap.Side">
			</argument>
			<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">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="CubeMap.Storage">
			</argument>
			<description>
			</description>
		</method>
	</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>
		<constant name="STORAGE_RAW" value="0">
		</constant>
		<constant name="STORAGE_COMPRESS_LOSSY" value="1">
		</constant>
		<constant name="STORAGE_COMPRESS_LOSSLESS" value="2">
		</constant>
		<constant name="SIDE_LEFT" value="0">
		</constant>
		<constant name="SIDE_RIGHT" value="1">
		</constant>
		<constant name="SIDE_BOTTOM" value="2">
		</constant>
		<constant name="SIDE_TOP" value="3">
		</constant>
		<constant name="SIDE_FRONT" value="4">
		</constant>
		<constant name="SIDE_BACK" value="5">
		</constant>
		<constant name="FLAG_MIPMAPS" value="1">
		</constant>
		<constant name="FLAG_REPEAT" value="2">
		</constant>
		<constant name="FLAG_FILTER" value="4">
		</constant>
		<constant name="FLAGS_DEFAULT" value="7">
		</constant>
	</constants>
</class>