Enumerationmigueldeicaza.swiftgodot 0.45.0SwiftGodot
SkyMode
DirectionalLight3D.swift:32enum SkyModeCases
case lightAndSkyMakes the light visible in both scene lighting and sky rendering.
case lightOnlyMakes the light visible in scene lighting only (including direct lighting and global illumination). When using this mode, the light will not be visible from sky shaders.
case skyOnlyMakes the light visible to sky shaders only. When using this mode the light will not cast light into the scene (either through direct lighting or through global illumination), but can be accessed through sky shaders. This can be useful, for example, when you want to control sky effects without illuminating the scene (during a night cycle, for example).
Other members in extension
View members
Hide members
This section is hidden by default because it contains too many (11) members.
Types
Type members
Instance members
var directionalShadowBlendSplits: BoolIf
true, shadow detail is sacrificed in exchange for smoother transitions between splits. Enabling shadow blend splitting also has a moderate performance cost. This is ignored whendirectionalShadowModeis .shadowOrthogonal.var directionalShadowFadeStart: DoubleProportion of
directionalShadowMaxDistanceat which point the shadow starts to fade. AtdirectionalShadowMaxDistance, the shadow will disappear. The default value is a balance between smooth fading and distant shadow visibility. If the camera moves fast and thedirectionalShadowMaxDistanceis low, consider loweringdirectionalShadowFadeStartbelow0.8to make shadow transitions less noticeable. On the other hand, if you tuneddirectionalShadowMaxDistanceto cover the entire scene, you can setdirectionalShadowFadeStartto1.0to prevent the shadow from fading in the distance (it will suddenly cut off instead).var directionalShadowMaxDistance: DoubleThe maximum distance for shadow splits. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (since more objects need to be included in the directional shadow rendering).
var directionalShadowMode: DirectionalLight3D.ShadowModeThe light’s shadow rendering algorithm. See
ShadowMode.var directionalShadowPancakeSize: DoubleSets the size of the directional shadow pancake. The pancake offsets the start of the shadow’s camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to
0turns off the pancaking effect.var directionalShadowSplit1: DoubleThe distance from camera to shadow split 1. Relative to
directionalShadowMaxDistance. Only used whendirectionalShadowModeis .shadowParallel2Splits or .shadowParallel4Splits.var directionalShadowSplit2: DoubleThe distance from shadow split 1 to split 2. Relative to
directionalShadowMaxDistance. Only used whendirectionalShadowModeis .shadowParallel4Splits.var directionalShadowSplit3: DoubleThe distance from shadow split 2 to split 3. Relative to
directionalShadowMaxDistance. Only used whendirectionalShadowModeis .shadowParallel4Splits.var skyMode: DirectionalLight3D.SkyModeSet whether this
DirectionalLight3Dis visible in the sky, in the scene, or both in the sky and in the scene. SeeSkyModefor options.
Citizens in SwiftGodot
Conformances
protocol CaseIterableA type that provides a collection of all of its values.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol RawRepresentable<RawValue>A type that can be converted to and from an associated raw value.
Type members
Instance members
var debugDescription: StringA textual representation of this instance, suitable for debugging
Type features
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.