Class BaseRenderCapturer

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

Inheritance

BaseRenderCapturer

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

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, Component)

Component.TryGetComponent<T>(T)

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

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

Component.GetComponentsInChildren<T>()

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

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, 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.rigidbody2D

Component.camera

Component.light

Component.animation

Component.constantForce

Component.renderer

Component.audio

Component.networkView

Component.collider

Component.collider2D

Component.hingeJoint

Component.particleSystem

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, Boolean)

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, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Unity.StreamingImageSequence

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

BeginCapture()

Prepare the component for capturing. May require several frames

Declaration

public abstract IEnumerator BeginCapture()

Returns

Type	Description
IEnumerator	The current position of the begin process

CanCapture()

Can the capturer perform the capturing process

Declaration

public abstract bool CanCapture()

Returns

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

CaptureToFile(String)

Capture the contents of RenderTexture into file

Declaration

public void CaptureToFile(string outputFilePath)

Parameters

Type	Name	Description
String	outputFilePath	The path of the file

EndCapture()

Clean up the component after capturing

Declaration

public abstract void EndCapture()

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

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

UpdateRenderTexture()

Updates the render texture used for the capturing process

Declaration

protected abstract RenderTexture UpdateRenderTexture()

Returns

Type	Description
RenderTexture	The updated render texture