Version: 2021.3
LanguageEnglish
  • C#

GenericPool<T0>

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

Provides a static implementation of ObjectPool<T0>.

The GenericPool has collection checks enabled that ensure that when an instance is released it is not already in the pool. Note this is not thread-safe. Additional resources: UnsafeGenericPool<T0>.

using UnityEngine.Pool;

public class GenericPoolExample { class MyClass { public int someValue; public string someString; }

void GetPooled() { // Get an instance var instance = GenericPool<MyClass>.Get();

// Return the instance GenericPool<MyClass>.Release(instance); } }

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.