summaryrefslogtreecommitdiff
path: root/doc/classes/RDTextureFormat.xml
blob: 9005610a1cd858f9770e7b1a42cbd6d68c5c6c0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RDTextureFormat" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Texture format (used by [RenderingDevice]).
	</brief_description>
	<description>
		This object is used by [RenderingDevice].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_shareable_format">
			<return type="void" />
			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
			<description>
			</description>
		</method>
		<method name="remove_shareable_format">
			<return type="void" />
			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="array_layers" type="int" setter="set_array_layers" getter="get_array_layers" default="1">
			The number of layers in the texture. Only relevant for 2D texture arrays.
		</member>
		<member name="depth" type="int" setter="set_depth" getter="get_depth" default="1">
			The texture's depth (in pixels). This is always [code]1[/code] for 2D textures.
		</member>
		<member name="format" type="int" setter="set_format" getter="get_format" enum="RenderingDevice.DataFormat" default="8">
			The texture's pixel data format.
		</member>
		<member name="height" type="int" setter="set_height" getter="get_height" default="1">
			The texture's height (in pixels).
		</member>
		<member name="mipmaps" type="int" setter="set_mipmaps" getter="get_mipmaps" default="1">
			The number of mipmaps available in the texture.
		</member>
		<member name="samples" type="int" setter="set_samples" getter="get_samples" enum="RenderingDevice.TextureSamples" default="0">
			The number of samples used when sampling the texture.
		</member>
		<member name="texture_type" type="int" setter="set_texture_type" getter="get_texture_type" enum="RenderingDevice.TextureType" default="1">
			The texture type.
		</member>
		<member name="usage_bits" type="int" setter="set_usage_bits" getter="get_usage_bits" enum="RenderingDevice.TextureUsageBits" default="0">
			The texture's usage bits, which determine what can be done using the texture.
		</member>
		<member name="width" type="int" setter="set_width" getter="get_width" default="1">
			The texture's width (in pixels).
		</member>
	</members>
</class>