Class MapRenderer<TMapProperties>

Namespace

Gamelogic.Fx.BuiltIn.Mapping

Assembly

Gamelogic.Fx.BuiltIn.dll

Renders maps using a command buffer and a dedicated camera.

[ExecuteInEditMode]
public class MapRenderer<TMapProperties> : MapRenderer where TMapProperties : MapProperties, new()

Type Parameters

TMapProperties

The type of map properties used to configure the map rendering.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

GLMonoBehaviour

MapRenderer

MapRenderer<TMapProperties>

Derived

DepthMapRenderer

IDMapRenderer

NormalMapRenderer

UVMapRenderer

Inherited Members

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

GLMonoBehaviour.Instantiate<T>(T, GameObject)

GLMonoBehaviour.Instantiate<T>(T, GameObject, Vector3, Quaternion)

GLMonoBehaviour.Instantiate(GameObject)

GLMonoBehaviour.Instantiate(GameObject, Vector3, Quaternion)

GLMonoBehaviour.Instantiate(GameObject, GameObject)

GLMonoBehaviour.Instantiate(GameObject, GameObject, Vector3, Quaternion)

GLMonoBehaviour.FindObjectsOfInterface<TInterface>()

GLMonoBehaviour.FindRequiredObjectOfType<T>()

GLMonoBehaviour.Invoke(Action, float)

GLMonoBehaviour.InvokeRepeating(Action, float, float)

GLMonoBehaviour.InvokeRepeating(Action, IGenerator<float>)

GLMonoBehaviour.Tween<T>(T, T, float, Func<T, T, float, T>, Action<T>, Func<float>)

GLMonoBehaviour.Tween<T>(T, T, float, Func<T, T, float, T>, Action<T>)

GLMonoBehaviour.GetRequiredComponent<T>()

GLMonoBehaviour.GetRequiredComponentInChildren<T>()

GLMonoBehaviour.DestroyUniversal(Object)

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

Remarks

A map encodes scene information in a texture that can be used by post effects.

To use a map renderer (a concrete subclass of this generic class):

1. Add the component to a GameObject in your scene.
2. Configure the properties.

To render your own type of map:

1. Create a shader that can render the information you need.
2. (Optional) Create a background shader to render the background of the map.
3. Create a new class inheriting from MapProperties, that sets up the material properties for your shader (and background shader if needed).
4. Create extend from MapRenderer<TMapProperties> class using your new MapProperties type as the generic parameter. Generally the class can be empty (a concrete type is needed to show up in the inspector).

If your camera properties change (through animation or scripting) you need to set Gamelogic.Fx.BuiltIn.Mapping.MapRenderer<TMapProperties>.updateCameraEachFrame to true. You may need to set the execution order to make sure this script executes after the code that updates the camera.

If your source camera itself changes, you set SourceCamera.

Properties

LayerMask

Gets and sets the layer mask used to select which objects are rendered into the map.

public LayerMask LayerMask { get; set; }

Property Value

LayerMask

MapProperties

Gets the map properties for this map renderer.

public TMapProperties MapProperties { get; }

Property Value

TMapProperties

SourceCamera

Gets and sets the source camera used to render the map.

public Camera SourceCamera { get; set; }

Property Value

Camera

UpdateCameraEachFrame

Gets and sets whether to update the camera properties each frame.

public bool UpdateCameraEachFrame { get; set; }

Property Value

bool

UpdateRenderListEachFrame

Gets and sets whether to update the list of renderers each frame in playmode.

public bool UpdateRenderListEachFrame { get; set; }

Property Value

bool

UpdateRenderListEachFrameInEditor

Gets and sets whether to update the list of renderers each frame in edit mode. This only has an effect when not playing.

public bool UpdateRenderListEachFrameInEditor { get; set; }

Property Value

bool

Methods

RefreshRendererList()

Updates the list of renderers to be drawn.

public void RefreshRendererList()

Remarks

This can potentially be slow, so be careful calling it each frame.