Class ImageRecorderSettings
A class that represents the settings of an Image Recorder.
Inherited Members
Namespace: UnityEditor.Recorder
Assembly: Unity.Recorder.Editor.dll
Syntax
[RecorderSettings(typeof(ImageRecorder), "Image Sequence", "imagesequence_16")]
public class ImageRecorderSettings : RecorderSettings, ISerializationCallbackReceiver, IAccumulationConstructors
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 |
|---|---|
| bool |
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 |
|---|---|
| bool |
EXRCompression
Stores the data compression method to use to encode image files in the EXR format.
Declaration
public ImageRecorderSettings.EXRCompressionType EXRCompression { get; set; }Property Value
| Type | Description |
|---|---|
| ImageRecorderSettings.EXRCompressionType |
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
JpegQuality
The JPEG encoding quality level. Range is 1 to 100. Default value is 75.
Declaration
public int JpegQuality { get; set; }Property Value
| Type | Description |
|---|---|
| int |
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 |
imageInputSettings
The settings of the input image.
Declaration
public ImageInputSettings imageInputSettings { get; set; }Property Value
| Type | Description |
|---|---|
| ImageInputSettings |
Methods
GetAccumulationSettings()
Use this method to get all the AccumulationSettings properties.
Declaration
public AccumulationSettings GetAccumulationSettings()Returns
| Type | Description |
|---|---|
| AccumulationSettings | AccumulationSettings |
GetErrors(List<string>)
Tests if the Recorder has any errors.
Declaration
protected override void GetErrors(List<string> errors)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | errors | List of errors encountered. |
Overrides
GetWarnings(List<string>)
Tests if the Recorder has any warnings.
Declaration
protected override void GetWarnings(List<string> warnings)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | warnings | List of warnings encountered. |
Overrides
HasErrors()
Declaration
protected override bool HasErrors()Returns
| Type | Description |
|---|---|
| bool |
Overrides
IsAccumulationSupported()
Indicates whether the current Recorder supports Accumulation recording or not.
Declaration
public override bool IsAccumulationSupported()Returns
| Type | Description |
|---|---|
| bool | True if the current Recorder supports Accumulation recording, False otherwise. |