Get
Get an instance from the pool. If the pool is empty then a new instance will be created.
Read time 1 minuteLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Pool
- Assembly: UnityEngine.CoreModule
Get()
Get an instance from the pool. If the pool is empty then a new instance will be created.
public static TCollection Get()
Returns
Type | Description |
|---|---|
| T | A pooled object or a new instance if the pool is empty. |
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; }}
Get(T)
Returns a PooledObject that will automatically return the instance to the pool when it is disposed.
public static PooledObject<TCollection> Get(out TCollection value)
Parameters
Returns
Type | Description |
|---|---|
| PooledObject<T> | A PooledObject that will return the instance back to the pool when its Dispose method is called. |