Class BaseRenderCapturer

An abstract MonoBehaviour class for capturing the render result of another component and writing it to disk as a texture

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

BaseRenderCapturer

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

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.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.StreamingImageSequence

Assembly: Unity.StreamingImageSequence.dll

Syntax

public abstract class BaseRenderCapturer : MonoBehaviour

Fields

m_rt

The internal RenderTexture which is used as a target in the capturing process.

Declaration

protected RenderTexture m_rt

Field Value

Type	Description
RenderTexture

Methods

BeginCaptureV()

Prepare the component for capturing. May require several frames

Declaration

public abstract IEnumerator BeginCaptureV()

Returns

Type	Description
IEnumerator	The current position of the begin process

CanCaptureV()

Can the capturer perform the capturing process

Declaration

public abstract bool CanCaptureV()

Returns

Type	Description
bool	True if capturing can be executed, false otherwise

CaptureToFile(string, RenderCacheOutputFormat)

Capture the contents of RenderTexture to file

Declaration

[Obsolete("Replaced by TryCaptureToFile()")]
public void CaptureToFile(string outputFilePath, RenderCacheOutputFormat outputFormat = RenderCacheOutputFormat.PNG)

Parameters

Type	Name	Description
string	outputFilePath	The path of the file
RenderCacheOutputFormat	outputFormat	The output file format

EndCaptureV()

Clean up the component after capturing

Declaration

public abstract void EndCaptureV()

GetInternalTexture()

Gets the internal texture used for the capturing process

Declaration

public Texture GetInternalTexture()

Returns

Type	Description
Texture	The internal texture

GetLastErrorMessage()

Get the last error message.

Declaration

public string GetLastErrorMessage()

Returns

Type	Description
string	The last error message

GetOrCreateBlitToScreenEditorMaterialV()

Get or create the material for blitting camera's target texture to the screen in the editor Default is null: will blit as is.

Declaration

public virtual Material GetOrCreateBlitToScreenEditorMaterialV()

Returns

Type	Description
Material

ReleaseRenderTexture()

Release Render Texture

Declaration

protected void ReleaseRenderTexture()

SetErrorMessage(string)

Set error message, which will be displayed if there is any error detected during the capturing process.

Declaration

protected void SetErrorMessage(string err)

Parameters

Type	Name	Description
string	err	The error message

TryCaptureToFile(string, RenderCacheOutputFormat)

Capture the contents of RenderTexture to file

Declaration

public bool TryCaptureToFile(string outputFilePath, RenderCacheOutputFormat outputFormat = RenderCacheOutputFormat.PNG)

Parameters

Type	Name	Description
string	outputFilePath	The path of the file
RenderCacheOutputFormat	outputFormat	The output file format

Returns

Type	Description
bool	True if successful, false otherwise

UpdateRenderTextureV()

Updates the render texture used for the capturing process

Declaration

[CanBeNull]
protected abstract RenderTexture UpdateRenderTextureV()

Returns

Type	Description
RenderTexture	The updated render texture if successful, null otherwise