Version: 2023.1
LanguageEnglish
  • C#

CollectionPool<T0,T1>

class in UnityEngine.Pool

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A Collection such as List, HashSet, Dictionary etc can be pooled and reused by using a CollectionPool.

Note the CollectionPool is not thread-safe. See Also: DictionaryPool<T0,T1>, HashSetPool<T0>, ListPool<T0>.

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; } }

Static Methods

GetGet an instance from the pool. If the pool is empty then a new instance will be created.
ReleaseReturns the instance back to the pool.