Class BaseTextureRecorder<T>

Abstract base class for all Recorders that output images.

Inheritance

object

Object

ScriptableObject

Recorder

GenericRecorder<T>

BaseTextureRecorder<T>

Inherited Members

GenericRecorder<T>.Settings

Recorder.RecordedFramesCount

Recorder.m_Inputs

Recorder.Reset()

Recorder.ConsoleLogMessage(string, LogType)

Recorder.SessionCreated(RecordingSession)

Recorder.SkipFrame(RecordingSession)

Recorder.SkipSubFrame(RecordingSession)

Recorder.Recording

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsOfType<T>(bool)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindObjectOfType(Type, bool)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.Recorder

Assembly: Unity.Recorder.Editor.dll

Syntax

public abstract class BaseTextureRecorder<T> : GenericRecorder<T> where T : RecorderSettings

Type Parameters

Name	Description
T	The class implementing the Recorder Settings.

Fields

UseAsyncGPUReadback

Whether or not to use asynchronous GPU commands in order to get the texture for the recorder.

Declaration

protected bool UseAsyncGPUReadback

Field Value

Type	Description
bool

Properties

ReadbackTextureFormat

Stores the format of the texture used for the readback.

Declaration

protected abstract TextureFormat ReadbackTextureFormat { get; }

Property Value

Type	Description
TextureFormat

Methods

BeginRecording(RecordingSession)

Starts a new recording session. Callback is invoked once when the recording session starts.

Declaration

protected override bool BeginRecording(RecordingSession session)

Parameters

Type	Name	Description
RecordingSession	session	The newly created recording session.

Returns

Type	Description
bool	True if recording can start, False otherwise.

Overrides

Recorder.BeginRecording(RecordingSession)

Exceptions

Type	Condition
Exception	Throws if there is already a recording session running.

DisposeEncoder()

Releases the encoder resources.

Declaration

protected virtual void DisposeEncoder()

EndRecording(RecordingSession)

Ends the current recording session. Callback is invoked when the recording session ends.

Declaration

protected override void EndRecording(RecordingSession session)

Parameters

Type	Name	Description
RecordingSession	session	The current recording session.

Overrides

Recorder.EndRecording(RecordingSession)

PrepareNewFrame(RecordingSession)

Prepares a frame before recording it. Callback is invoked for every frame during the recording session, before RecordFrame.

Declaration

protected override void PrepareNewFrame(RecordingSession ctx)

Parameters

Type	Name	Description
RecordingSession	ctx	The current recording session.

Overrides

Recorder.PrepareNewFrame(RecordingSession)

RecordFrame(RecordingSession)

Records a single frame. Callback is invoked for every frame during the recording session.

Declaration

protected override void RecordFrame(RecordingSession session)

Parameters

Type	Name	Description
RecordingSession	session

Overrides

Recorder.RecordFrame(RecordingSession)

WriteFrame(AsyncGPUReadbackRequest)

Writes the frame from an asynchronous GPU read request.

Declaration

protected virtual void WriteFrame(AsyncGPUReadbackRequest r)

Parameters

Type	Name	Description
AsyncGPUReadbackRequest	r	The asynchronous readback target.

WriteFrame(Texture2D)

Writes the frame from a Texture2D.

Declaration

protected virtual void WriteFrame(Texture2D t)

Parameters

Type	Name	Description
Texture2D	t	The readback target.