Class AOVRecorderSettings

A class that represents the settings of an AOV Sequence Recorder.

Inheritance
object
Object
ScriptableObject
RecorderSettings
AOVRecorderSettings
Implements
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.GetHashCode()
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEditor.Recorder
Assembly: Unity.Recorder.Editor.dll
Syntax
[RecorderSettings(typeof(AOVRecorder), "AOV Image Sequence", "aovimagesequence_16")]
public class AOVRecorderSettings : RecorderSettings, ISerializationCallbackReceiver

Constructors

AOVRecorderSettings()

Default constructor.

Declaration
public AOVRecorderSettings()

Properties

AOVSelection

Indicates the selected AOV to render.

Declaration
[Obsolete("Use Get/SetAOVSelection to choose the AOVs")]
public AOVType AOVSelection { get; set; }
Property Value
Type Description
AOVType

CaptureHDR

Use this property to capture the frames in HDR (if the setup supports it).

Declaration
public bool CaptureHDR { get; }
Property Value
Type Description
bool

EXRCompression

Stores the data compression method to use to encode image files in the EXR format.

Declaration
public CompressionUtility.EXRCompressionType EXRCompression { get; set; }
Property Value
Type Description
CompressionUtility.EXRCompressionType

EXRCompressionLevel

Stores the data compression level for compression methods that support it to encode image files in the EXR format.

Declaration
public int EXRCompressionLevel { get; set; }
Property Value
Type Description
int

Extension

Stores the file extension used by this Recorder (without the dot).

Declaration
protected override string Extension { get; }
Property Value
Type Description
string
Overrides

InputsSettings

The list of settings of the Recorder Inputs.

Declaration
public override IEnumerable<RecorderInputSettings> InputsSettings { get; }
Property Value
Type Description
IEnumerable<RecorderInputSettings>
Overrides

IsMultiPartEXR

Determines how a recorded frame is exported in EXR. If true, the recorder will write all exported AOVs to a single multi-part file. If false, the recorder will write each AOV to its own EXR file.

Declaration
public bool IsMultiPartEXR { get; set; }
Property Value
Type Description
bool

LatestVersion

Indicates the latest version of the recorder. This is used during the asset upgrade process to determine if the asset needs to be upgraded. Derived classes should override this property to provide their own latest version.

Declaration
protected override int LatestVersion { get; }
Property Value
Type Description
int
Overrides

OutputColorSpace

Stores the color space to use to encode the output image files.

Declaration
public ImageRecorderSettings.ColorSpaceType OutputColorSpace { get; set; }
Property Value
Type Description
ImageRecorderSettings.ColorSpaceType

OutputFormat

Stores the output image format currently used for this Recorder.

Declaration
public ImageRecorderSettings.ImageRecorderOutputFormat OutputFormat { get; set; }
Property Value
Type Description
ImageRecorderSettings.ImageRecorderOutputFormat

Version

Indicates the current version of this recorder. This is used during the asset upgrade process to determine if the asset needs to be upgraded. Derived classes should override this property to provide their own version.

Declaration
protected override int Version { get; set; }
Property Value
Type Description
int
Overrides

imageInputSettings

The settings of the input image.

Declaration
public ImageInputSettings imageInputSettings { get; set; }
Property Value
Type Description
ImageInputSettings

Methods

GetAOVSelection()

Indicates the selected AOVs to render.

Declaration
public AOVType[] GetAOVSelection()
Returns
Type Description
AOVType[]

The array of selected AOVTypes.

GetErrors(List<string>)

Add AOV related error description strings to the errors list.

Declaration
protected override void GetErrors(List<string> errors)
Parameters
Type Name Description
List<string> errors

A list of error message strings.
Overrides

OnUpgradeFromVersion()

Defines how to handle the upgrade of Recorder Settings created in a previous version according to their type. Unity automatically calls this method when loading a Recorder Setting (after deserialization) if its version is older than the current project version.

Declaration
protected override void OnUpgradeFromVersion()
Overrides

SetAOVSelection(params AOVType[])

Indicates the selected AOVs to render.

Declaration
public void SetAOVSelection(params AOVType[] value)
Parameters
Type Name Description
AOVType[] value

The array of AOVTypes to select.

Implements