Class ImageRecorderSettings

A class that represents the settings of an Image Recorder.

Inheritance
Object
RecorderSettings
ImageRecorderSettings
Inherited Members
Namespace: UnityEditor.Recorder
Syntax
public class ImageRecorderSettings : RecorderSettings, IAccumulation

Constructors

ImageRecorderSettings()

Default constructor.

Declaration
public ImageRecorderSettings()

Properties

AccumulationSettings

Stores the AccumulationSettings properties

Declaration
public AccumulationSettings AccumulationSettings { get; set; }
Property Value
Type Description
AccumulationSettings

CaptureAlpha

Use this property to capture the alpha channel (True) or not (False) in the output.

Declaration
public bool CaptureAlpha { get; set; }
Property Value
Type Description
Boolean
Remarks

Alpha channel is captured only if the output image format supports it.

CaptureHDR

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

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

Extension

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

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

imageInputSettings

The settings of the input image.

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

InputsSettings

The list of settings of the Recorder Inputs.

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

OutputFormat

Stores the output image format currently used for this Recorder.

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

Methods

GetAccumulationSettings()

Use this method to get all the AccumulationSettings properties.

Declaration
public AccumulationSettings GetAccumulationSettings()
Returns
Type Description
AccumulationSettings

AccumulationSettings
Implements

IsAccumulationSupported()

Indicates if the current Recorder supports Accumulation recording (True) or not (False).

Declaration
public override bool IsAccumulationSupported()
Returns
Type Description
Boolean
Overrides

ValidityCheck(List<String>)

Declaration
protected override bool ValidityCheck(List<string> errors)
Parameters
Type Name Description
List<String> errors
Returns
Type Description
Boolean
Overrides