Class ImageRecorderSettings | Unity Recorder | 2.1.0-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class ImageRecorderSettings

    Inheritance
    Object
    RecorderSettings
    ImageRecorderSettings
    Inherited Members
    RecorderSettings.OutputFile
    RecorderSettings.Enabled
    RecorderSettings.Take
    RecorderSettings.FileNameGenerator
    RecorderSettings.RecordMode
    RecorderSettings.FrameRatePlayback
    RecorderSettings.FrameRate
    RecorderSettings.StartFrame
    RecorderSettings.EndFrame
    RecorderSettings.StartTime
    RecorderSettings.EndTime
    RecorderSettings.CapFrameRate
    RecorderSettings.IsPlatformSupported
    RecorderSettings.OnAfterDuplicate()
    RecorderSettings.HasErrors()
    Namespace: UnityEditor.Recorder
    Syntax
    [RecorderSettings(typeof(ImageRecorder), "Image Sequence", "imagesequence_16")]
    public class ImageRecorderSettings : RecorderSettings

    Constructors

    ImageRecorderSettings()

    Default constructor.

    Declaration
    public ImageRecorderSettings()

    Properties

    CaptureAlpha

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

    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; set; }
    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
    RecorderSettings.Extension

    imageInputSettings

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

    InputsSettings

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

    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

    ValidityCheck(List<String>)

    Declaration
    protected override bool ValidityCheck(List<string> errors)
    Parameters
    Type Name Description
    List<String> errors
    Returns
    Type Description
    Boolean
    Overrides
    RecorderSettings.ValidityCheck(List<String>)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023