docs.unity3d.com
    Show / Hide Table of Contents

    Class RenderTextureToFile

    The role of this class is to take an incoming render texture and save it into an image file.

    Inheritance
    Object
    NodeRuntime
    RenderTextureToFile
    RenderTextureToFileNode
    Inherited Members
    NodeRuntime._parent
    NodeRuntime._portList
    NodeRuntime._queryPath
    NodeRuntime._tickCPUTimeNs
    NodeRuntime.Initialize(SystemGraphComponent)
    NodeRuntime.InternalInitialize()
    NodeRuntime.Start()
    NodeRuntime.OnTick(Double, Double, Scheduler.ClockState, Scheduler.Signal)
    NodeRuntime.Update()
    NodeRuntime.FixedUpdate()
    NodeRuntime.OnPortAdded(String, Type, String, PortDirection, FieldExtra, IPortType)
    NodeRuntime.OnPortRemoved(String)
    NodeRuntime.InitializeDynamicPorts(SystemGraphComponent)
    NodeRuntime.QueryPath
    NodeRuntime.TickCPUTimeNs
    NodeRuntime.PortDataList
    Namespace: Mechatronics.SensorSDK
    Syntax
    public class RenderTextureToFile : NodeRuntime

    Fields

    destination

    Declaration
    [Tooltip("Output file destination relative to the application root folder. Somewhere in the Users/Username/AppData/LocalLow/CompanyName/ProjectName/")]
    [Field("Destination", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<string> destination
    Field Value
    Type Description
    PortType<String>

    filename

    Declaration
    [Tooltip("Output file name.")]
    [Field("Filename", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<string> filename
    Field Value
    Type Description
    PortType<String>

    format

    Declaration
    [Tooltip("Output file format.")]
    [Field("Format", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    public PortTypeEnum format
    Field Value
    Type Description
    PortTypeEnum

    isSingleFile

    Declaration
    [Tooltip("Tell if we want to override the file with the most recent change or create multiple file with date timestamp.")]
    [Field("IsSingleFile", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<bool> isSingleFile
    Field Value
    Type Description
    PortType<Boolean>

    renderTexture

    Declaration
    [Tooltip("RenderTexture to readback.")]
    [Field("RenderTexture", PortDirection.Left, FieldExtra.Read | FieldExtra.ChangeEvent)]
    [SerializeField]
    protected PortType<RenderTexture> renderTexture
    Field Value
    Type Description
    PortType<RenderTexture>

    Methods

    Disable()

    Disable change event on render texture port.

    Declaration
    public override void Disable()
    Overrides
    NodeRuntime.Disable()

    Enable(Scheduler.ClockState)

    Enable change event on render texture port.

    Declaration
    public override void Enable(Scheduler.ClockState clockState)
    Parameters
    Type Name Description
    Scheduler.ClockState clockState

    The parameters of the waveform associated to this node

    Overrides
    NodeRuntime.Enable(Scheduler.ClockState)
    Back to top
    Terms of use
    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