CollectionPool<TCollection, TItem>
A Collection such as List, HashSet, Dictionary etc can be pooled and reused by using a CollectionPool.
Read time 1 minuteLast updated 5 days ago
Definition
- Type: Class
- Namespace: UnityEngine.Pool
- Assembly: UnityEngine.CoreModule
public class CollectionPool<TCollection, TItem> where TCollection : class, ICollection<TItem>, new()
Remarks
Note the CollectionPool is not thread-safe. Additional Resources: DictionaryPool<TKey, TValue>, HashSetPool<T>, ListPool<T>.
Examples
using System.Collections.Generic;using UnityEngine;using UnityEngine.Pool;// This example shows how both version of Get could be used to simplify a line of points.public class Simplify2DLine{ public List<Vector2> SimplifyLine(Vector2[] points) { // This version will only be returned to the pool if we call Release on it. var simplifiedPoints = CollectionPool<List<Vector2>, Vector2>.Get(); // Copy the points into a temp list so we can pass them into the Simplify method // When the pooled object leaves the scope it will be Disposed and returned to the pool automatically. // This version is ideal for working with temporary lists. using (CollectionPool<List<Vector2>, Vector2>.Get(out List<Vector2> tempList)) { for (int i = 0; i < points.Length; ++i) { tempList.Add(points[i]); } LineUtility.Simplify(tempList, 1.5f, simplifiedPoints); } return simplifiedPoints; }}