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

    Class BaseRenderTextureInput

    Base class for all Recorder inputs that capture images.

    Inheritance
    Object
    RecorderInput
    BaseRenderTextureInput
    CameraInput
    Inherited Members
    RecorderInput.settings
    RecorderInput.Dispose()
    RecorderInput.SessionCreated(RecordingSession)
    RecorderInput.BeginRecording(RecordingSession)
    RecorderInput.NewFrameStarting(RecordingSession)
    RecorderInput.NewFrameReady(RecordingSession)
    RecorderInput.FrameDone(RecordingSession)
    RecorderInput.EndRecording(RecordingSession)
    Namespace: UnityEditor.Recorder
    Syntax
    public abstract class BaseRenderTextureInput : RecorderInput, IDisposable

    Properties

    OutputHeight

    Stores the output image height.

    Declaration
    protected int OutputHeight { get; set; }
    Property Value
    Type Description
    Int32

    OutputRenderTexture

    Enables asynchronous readback of GPU resources if the platform supports it. Set this property to a valid instance and ensure that ReadbackTexture is not set.

    Declaration
    protected RenderTexture OutputRenderTexture { get; set; }
    Property Value
    Type Description
    RenderTexture

    OutputWidth

    Stores the output image width.

    Declaration
    protected int OutputWidth { get; set; }
    Property Value
    Type Description
    Int32

    ReadbackTexture

    Indicates the synchronous GPU readback destination.

    Declaration
    protected Texture2D ReadbackTexture { get; set; }
    Property Value
    Type Description
    Texture2D

    Methods

    Dispose(Boolean)

    Releases all resources allocated by this instance.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    Boolean disposing

    If true, releases buffers allocated by this class as well.

    Overrides
    RecorderInput.Dispose(Boolean)

    ReleaseBuffer()

    Releases all resources allocated by this class instance.

    Declaration
    protected void ReleaseBuffer()
    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