Version: 2023.2
LanguageEnglish
  • C#

ResourcesAPI

class in UnityEngine

/

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

Derive from this base class to provide alternative implementations to the C# behavior of specific Resources methods.

The example provided logs the time taken to handle slower Resources APIs to the player or editor log.

using System;
using System.Diagnostics;
using UnityEngine;
using Object = UnityEngine.Object;
using Debug = UnityEngine.Debug;

public class ResourcesPerformanceLogger : ResourcesAPI { [RuntimeInitializeOnLoadMethod] static void OnRuntimeMethodLoad() { ResourcesAPI.overrideAPI = new ResourcesPerformanceLogger(); }

protected override Object[] FindObjectsOfTypeAll(Type systemTypeInstance) { Stopwatch timer = new Stopwatch(); timer.Start(); Object[] results = base.FindObjectsOfTypeAll(systemTypeInstance); timer.Stop(); Debug.Log($"FindObjectsOfTypeAll({systemTypeInstance}) Time: {timer.Elapsed}"); return results; }

protected override Shader FindShaderByName(string name) { Stopwatch timer = new Stopwatch(); timer.Start(); Shader result = base.FindShaderByName(name); timer.Stop(); Debug.Log($"FindShaderByName({name}) Time: {timer.Elapsed}"); return result; }

protected override Object[] LoadAll(string path, Type systemTypeInstance) { Stopwatch timer = new Stopwatch(); timer.Start(); Object[] results = base.LoadAll(path, systemTypeInstance); timer.Stop(); Debug.Log($"LoadAll({path}, {systemTypeInstance}) Time: {timer.Elapsed}"); return results; } }

Static Properties

overrideAPIThe specific ResourcesAPI instance to use to handle overridden Resources methods.

Protected Methods

FindObjectsOfTypeAllOverride for customizing the behavior of the Resources.FindObjectsOfTypeAll function.
FindShaderByNameOverride for customizing the behavior of the Shader.Find function.
LoadOverride for customizing the behavior of the Resources.Load function.
LoadAllOverride for customizing the behavior of the Resources.LoadAll function.
LoadAsyncOverride for customizing the behavior of the Resources.LoadAsync function.
UnloadAssetOverride for customizing the behavior of the Resources.Unload function.