CameraAttributesPhysical

package
v0.0.0-...-0d6c339 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 24 Imported by: 0

Documentation

Overview

graphics.gd/classdb/CameraAttributesPhysical is used to set rendering settings based on a physically-based camera's settings. It is responsible for exposure, auto-exposure, and depth of field.

When used in a graphics.gd/classdb/WorldEnvironment it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own graphics.gd/classdb/CameraAttributes, including the editor camera. When used in a graphics.gd/classdb/Camera3D it will override any graphics.gd/classdb/CameraAttributes set in the graphics.gd/classdb/WorldEnvironment and will override the [graphics.gd/classdb/Camera3D]s graphics.gd/classdb/Camera3D.Instance.Far, graphics.gd/classdb/Camera3D.Instance.Near, graphics.gd/classdb/Camera3D.Instance.Fov, and graphics.gd/classdb/Camera3D.Instance.KeepAspect properties. When used in graphics.gd/classdb/VoxelGI or graphics.gd/classdb/LightmapGI, only the exposure settings will be used.

The default settings are intended for use in an outdoor environment, tips for settings for use in an indoor environment can be found in each setting's documentation.

Note: Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility.

Index

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 Any

type Any interface {
	gd.IsClass
	AsCameraAttributesPhysical() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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 (self *Extension[T]) AsCameraAttributes() CameraAttributes.Instance

func (*Extension[T]) AsCameraAttributesPhysical

func (self *Extension[T]) AsCameraAttributesPhysical() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

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 New

func New() Instance

func (Instance) AsCameraAttributes

func (self Instance) AsCameraAttributes() CameraAttributes.Instance

func (Instance) AsCameraAttributesPhysical

func (self Instance) AsCameraAttributesPhysical() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AutoExposureMaxExposureValue

func (self Instance) AutoExposureMaxExposureValue() Float.X

func (Instance) AutoExposureMinExposureValue

func (self Instance) AutoExposureMinExposureValue() Float.X

func (Instance) ExposureAperture

func (self Instance) ExposureAperture() Float.X

func (Instance) ExposureShutterSpeed

func (self Instance) ExposureShutterSpeed() Float.X

func (Instance) FrustumFar

func (self Instance) FrustumFar() Float.X

func (Instance) FrustumFocalLength

func (self Instance) FrustumFocalLength() Float.X

func (Instance) FrustumFocusDistance

func (self Instance) FrustumFocusDistance() Float.X

func (Instance) FrustumNear

func (self Instance) FrustumNear() Float.X

func (Instance) GetFov

func (self Instance) GetFov() Float.X

Returns the vertical field of view that corresponds to the Instance.FrustumFocalLength. This value is calculated internally whenever Instance.FrustumFocalLength is changed.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) SetAutoExposureMaxExposureValue

func (self Instance) SetAutoExposureMaxExposureValue(value Float.X)

func (Instance) SetAutoExposureMinExposureValue

func (self Instance) SetAutoExposureMinExposureValue(value Float.X)

func (Instance) SetExposureAperture

func (self Instance) SetExposureAperture(value Float.X)

func (Instance) SetExposureShutterSpeed

func (self Instance) SetExposureShutterSpeed(value Float.X)

func (Instance) SetFrustumFar

func (self Instance) SetFrustumFar(value Float.X)

func (Instance) SetFrustumFocalLength

func (self Instance) SetFrustumFocalLength(value Float.X)

func (Instance) SetFrustumFocusDistance

func (self Instance) SetFrustumFocusDistance(value Float.X)

func (Instance) SetFrustumNear

func (self Instance) SetFrustumNear(value Float.X)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL