b087538119
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
49 lines
2.4 KiB
XML
49 lines
2.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
||
<class name="Sky" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||
<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.
|
||
[b]Note:[/b] You will only benefit from high radiance sizes if you have perfectly sharp reflective surfaces in your project and are not using [ReflectionProbe]s or [GIProbe]s. For most projects, keeping [member radiance_size] to the default value is the best compromise between visuals and performance. Be careful when using high radiance size values as these can cause crashes on low-end GPUs.
|
||
</member>
|
||
</members>
|
||
<constants>
|
||
<constant name="RADIANCE_SIZE_32" value="0" enum="RadianceSize">
|
||
Radiance texture size is 32×32 pixels.
|
||
</constant>
|
||
<constant name="RADIANCE_SIZE_64" value="1" enum="RadianceSize">
|
||
Radiance texture size is 64×64 pixels.
|
||
</constant>
|
||
<constant name="RADIANCE_SIZE_128" value="2" enum="RadianceSize">
|
||
Radiance texture size is 128×128 pixels.
|
||
</constant>
|
||
<constant name="RADIANCE_SIZE_256" value="3" enum="RadianceSize">
|
||
Radiance texture size is 256×256 pixels.
|
||
</constant>
|
||
<constant name="RADIANCE_SIZE_512" value="4" enum="RadianceSize">
|
||
Radiance texture size is 512×512 pixels.
|
||
</constant>
|
||
<constant name="RADIANCE_SIZE_1024" value="5" enum="RadianceSize">
|
||
Radiance texture size is 1024×1024 pixels.
|
||
[b]Note:[/b] [constant RADIANCE_SIZE_1024] is not exposed in the inspector as it is known to cause GPU hangs on certain systems.
|
||
</constant>
|
||
<constant name="RADIANCE_SIZE_2048" value="6" enum="RadianceSize">
|
||
Radiance texture size is 2048×2048 pixels.
|
||
[b]Note:[/b] [constant RADIANCE_SIZE_2048] is not exposed in the inspector as it is known to cause GPU hangs on certain systems.
|
||
</constant>
|
||
<constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize">
|
||
Represents the size of the [enum RadianceSize] enum.
|
||
</constant>
|
||
</constants>
|
||
</class>
|