CameraAttributes

    Parent class for camera settings.

    CameraAttributes.swift:24
    class CameraAttributes

    Controls camera-specific attributes such as depth of field and exposure override.

    When used in a WorldEnvironment it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own CameraAttributes, including the editor camera. When used in a Camera3D it will override any CameraAttributes set in the WorldEnvironment. When used in VoxelGI or LightmapGI, only the exposure settings will be used.

    See also Environment for general 3D environment settings.

    This is a pure virtual class that is inherited by CameraAttributesPhysical and CameraAttributesPractical.

    Superclasses

    Citizens in SwiftGodot

    Conformances

    • protocol CustomStringConvertible

      A type with a customized textual representation.

    • protocol Equatable

      A type that can be compared for value equality.

    • protocol Hashable

      A type that can be hashed into a Hasher to produce an integer hash value.

    • protocol Identifiable<ID>

      A class of types whose instances hold the value of an entity with stable identity.

    • protocol VariantRepresentable

      Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

    • protocol VariantStorable

      Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

    Type members

    Instance members

    • var autoExposureEnabled: Bool

      If true, enables the tonemapping auto exposure mode of the scene renderer. If true, the renderer will automatically determine the exposure setting to adapt to the scene’s illumination and the observed light.

    • var autoExposureScale: Double

      The scale of the auto exposure effect. Affects the intensity of auto exposure.

    • var autoExposureSpeed: Double

      The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.

    • var exposureMultiplier: Double

      Multiplier for the exposure amount. A higher value results in a brighter image.

    • var exposureSensitivity: Double

      Sensitivity of camera sensors, measured in ISO. A higher sensitivity results in a brighter image. Only available when ProjectSettings/rendering/lightsAndShadows/usePhysicalLightUnits is enabled. When autoExposureEnabled this can be used as a method of exposure compensation, doubling the value will increase the exposure value (measured in EV100) by 1 stop.

    Subclasses