Documentation
¶
Overview ¶
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.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsCameraAttributes() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AutoExposureEnabled() bool
- func (self Instance) AutoExposureScale() Float.X
- func (self Instance) AutoExposureSpeed() Float.X
- func (self Instance) ExposureMultiplier() Float.X
- func (self Instance) ExposureSensitivity() Float.X
- func (self Instance) ID() ID
- func (self Instance) SetAutoExposureEnabled(value bool)
- func (self Instance) SetAutoExposureScale(value Float.X)
- func (self Instance) SetAutoExposureSpeed(value Float.X)
- func (self Instance) SetExposureMultiplier(value Float.X)
- func (self Instance) SetExposureSensitivity(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsCameraAttributes ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.CameraAttributes
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsCameraAttributes ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AutoExposureEnabled ¶
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.
func (Instance) AutoExposureScale ¶
The scale of the auto exposure effect. Affects the intensity of auto exposure.
func (Instance) AutoExposureSpeed ¶
The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
func (Instance) ExposureMultiplier ¶
Multiplier for the exposure amount. A higher value results in a brighter image.
func (Instance) ExposureSensitivity ¶
Sensitivity of camera sensors, measured in ISO. A higher sensitivity results in a brighter image.
If AutoExposureEnabled is true, this can be used as a method of exposure compensation, doubling the value will increase the exposure value (measured in EV100) by 1 stop.
Note: Only available when ProjectSettings "rendering/lights_and_shadows/use_physical_light_units" is enabled.
func (Instance) SetAutoExposureEnabled ¶
SetAutoExposureEnabled sets the property returned by [IsAutoExposureEnabled].
func (Instance) SetAutoExposureScale ¶
SetAutoExposureScale sets the property returned by [GetAutoExposureScale].
func (Instance) SetAutoExposureSpeed ¶
SetAutoExposureSpeed sets the property returned by [GetAutoExposureSpeed].
func (Instance) SetExposureMultiplier ¶
SetExposureMultiplier sets the property returned by [GetExposureMultiplier].
func (Instance) SetExposureSensitivity ¶
SetExposureSensitivity sets the property returned by [GetExposureSensitivity].
Source Files