godot/doc/classes/Sky.xml

47 lines
1.9 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name="Sky" inherits="Resource" version="4.0">
<brief_description>
The base class for [PanoramaSky] and [ProceduralSky].
</brief_description>
<description>
The base class for [PanoramaSky] and [ProceduralSky].
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="radiance_size" type="int" setter="set_radiance_size" getter="get_radiance_size" enum="Sky.RadianceSize" default="2">
The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
See [enum RadianceSize] constants for values.
2020-01-25 19:50:57 +00:00
[b]Note:[/b] Some hardware will have trouble with higher radiance sizes, especially [constant RADIANCE_SIZE_512] and above. Only use such high values on high-end hardware.
</member>
</members>
<constants>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_32" value="0" enum="RadianceSize">
Radiance texture size is 32×32 pixels.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_64" value="1" enum="RadianceSize">
Radiance texture size is 64×64 pixels.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_128" value="2" enum="RadianceSize">
Radiance texture size is 128×128 pixels.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_256" value="3" enum="RadianceSize">
Radiance texture size is 256×256 pixels.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_512" value="4" enum="RadianceSize">
Radiance texture size is 512×512 pixels.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_1024" value="5" enum="RadianceSize">
Radiance texture size is 1024×1024 pixels.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_2048" value="6" enum="RadianceSize">
Radiance texture size is 2048×2048 pixels.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize">
Represents the size of the [enum RadianceSize] enum.
</constant>
</constants>
</class>