virtualx-engine/doc/classes/Sky.xml
Rémi Verschelde 2d20fc39aa doc: Drop unused 'category' property from header
We already removed it from the online docs with .

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00

46 lines
1.9 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Sky" inherits="Resource" version="3.2">
<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] 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>
<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.
</constant>
<constant name="RADIANCE_SIZE_2048" value="6" enum="RadianceSize">
Radiance texture size is 2048×2048 pixels.
</constant>
<constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize">
Represents the size of the [enum RadianceSize] enum.
</constant>
</constants>
</class>