CameraAttributesPractical — C# API

class CameraAttributesPracticalReckfellSharpInherits CameraAttributes

Camera settings in an easy to use format.

Controls camera-specific attributes such as auto-exposure, 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. Note: Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. Note: Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

CameraAttributesPracticalConstructor

# CameraAttributesPractical

C#
public CameraAttributesPractical();

Properties9

AutoExposureMaxSensitivityProperty

# AutoExposureMaxSensitivity

C#
public float AutoExposureMaxSensitivity { get; set; }

The maximum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing below a certain brightness, resulting in a cut off point where the scene will remain bright.

AutoExposureMinSensitivityProperty

# AutoExposureMinSensitivity

C#
public float AutoExposureMinSensitivity { get; set; }

The minimum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark.

DofBlurAmountProperty

# DofBlurAmount

C#
public float DofBlurAmount { get; set; }

Sets the maximum amount of blur. When using physically-based blur amounts, will instead act as a multiplier. High values lead to an increased amount of blurriness, but can be much more expensive to calculate. It is best to keep this as low as possible for a given art style.

DofBlurFarDistanceProperty

# DofBlurFarDistance

C#
public float DofBlurFarDistance { get; set; }

Objects further from the Camera3D by this amount will be blurred by the depth of field effect. Measured in meters.

DofBlurFarEnabledProperty

# DofBlurFarEnabled

C#
public bool DofBlurFarEnabled { get; set; }

Enables depth of field blur for objects further than CameraAttributesPractical.DofBlurFarDistance. Strength of blur is controlled by CameraAttributesPractical.DofBlurAmount and modulated by CameraAttributesPractical.DofBlurFarTransition. Note: Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. Note: Depth of field blur is not supported on viewports that have a transparent background (where Viewport.TransparentBg is true).

DofBlurFarTransitionProperty

# DofBlurFarTransition

C#
public float DofBlurFarTransition { get; set; }

When positive, distance over which (starting from CameraAttributesPractical.DofBlurFarDistance) blur effect will scale from 0 to CameraAttributesPractical.DofBlurAmount. When negative, uses physically-based scaling so depth of field effect will scale from 0 at CameraAttributesPractical.DofBlurFarDistance and will increase in a physically accurate way as objects get further from the Camera3D.

DofBlurNearDistanceProperty

# DofBlurNearDistance

C#
public float DofBlurNearDistance { get; set; }

Objects closer from the Camera3D by this amount will be blurred by the depth of field effect. Measured in meters.

DofBlurNearEnabledProperty

# DofBlurNearEnabled

C#
public bool DofBlurNearEnabled { get; set; }

Enables depth of field blur for objects closer than CameraAttributesPractical.DofBlurNearDistance. Strength of blur is controlled by CameraAttributesPractical.DofBlurAmount and modulated by CameraAttributesPractical.DofBlurNearTransition. Note: Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. Note: Depth of field blur is not supported on viewports that have a transparent background (where Viewport.TransparentBg is true).

DofBlurNearTransitionProperty

# DofBlurNearTransition

C#
public float DofBlurNearTransition { get; set; }

When positive, distance over which blur effect will scale from 0 to CameraAttributesPractical.DofBlurAmount, ending at CameraAttributesPractical.DofBlurNearDistance. When negative, uses physically-based scaling so depth of field effect will scale from 0 at CameraAttributesPractical.DofBlurNearDistance and will increase in a physically accurate way as objects get closer to the Camera3D.

Methods18

GetAutoExposureMaxSensitivityfloat

# GetAutoExposureMaxSensitivity

C#
public float GetAutoExposureMaxSensitivity();

Returns float

GetAutoExposureMinSensitivityfloat

# GetAutoExposureMinSensitivity

C#
public float GetAutoExposureMinSensitivity();

Returns float

GetDofBlurAmountfloat

# GetDofBlurAmount

C#
public float GetDofBlurAmount();

Returns float

GetDofBlurFarDistancefloat

# GetDofBlurFarDistance

C#
public float GetDofBlurFarDistance();

Returns float

GetDofBlurFarTransitionfloat

# GetDofBlurFarTransition

C#
public float GetDofBlurFarTransition();

Returns float

GetDofBlurNearDistancefloat

# GetDofBlurNearDistance

C#
public float GetDofBlurNearDistance();

Returns float

GetDofBlurNearTransitionfloat

# GetDofBlurNearTransition

C#
public float GetDofBlurNearTransition();

Returns float

IsDofBlurFarEnabledbool

# IsDofBlurFarEnabled

C#
public bool IsDofBlurFarEnabled();

Returns bool

IsDofBlurNearEnabledbool

# IsDofBlurNearEnabled

C#
public bool IsDofBlurNearEnabled();

Returns bool

SetAutoExposureMaxSensitivityvoid

# SetAutoExposureMaxSensitivity

C#
public void SetAutoExposureMaxSensitivity(float maxSensitivity);

Parameters
Name	Type	Default
`maxSensitivity`	`float`	—

SetAutoExposureMinSensitivityvoid

# SetAutoExposureMinSensitivity

C#
public void SetAutoExposureMinSensitivity(float minSensitivity);

Parameters
Name	Type	Default
`minSensitivity`	`float`	—

SetDofBlurAmountvoid

# SetDofBlurAmount

C#
public void SetDofBlurAmount(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetDofBlurFarDistancevoid

# SetDofBlurFarDistance

C#
public void SetDofBlurFarDistance(float distance);

Parameters
Name	Type	Default
`distance`	`float`	—

SetDofBlurFarEnabledvoid

# SetDofBlurFarEnabled

C#
public void SetDofBlurFarEnabled(bool enabled);

Parameters
Name	Type	Default
`enabled`	`bool`	—

SetDofBlurFarTransitionvoid

# SetDofBlurFarTransition

C#
public void SetDofBlurFarTransition(float distance);

Parameters
Name	Type	Default
`distance`	`float`	—

SetDofBlurNearDistancevoid

# SetDofBlurNearDistance

C#
public void SetDofBlurNearDistance(float distance);

Parameters
Name	Type	Default
`distance`	`float`	—

SetDofBlurNearEnabledvoid

# SetDofBlurNearEnabled

C#
public void SetDofBlurNearEnabled(bool enabled);

Parameters
Name	Type	Default
`enabled`	`bool`	—

SetDofBlurNearTransitionvoid

# SetDofBlurNearTransition

C#
public void SetDofBlurNearTransition(float distance);

Parameters
Name	Type	Default
`distance`	`float`	—