Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Performance
繼承: Object
公開與效能相關的資料。
說明
該類提供對許多與效能相關的不同監視器的存取,例如記憶體使用情況、繪製呼叫、和 FPS。這些值與編輯器的除錯器面板中的監視分頁中顯示的值相同。通過使用該類的 get_monitor() 方法,你可以從程式碼中存取該資料。
可以使用 add_custom_monitor() 方法新增自訂監視器。在編輯器的除錯器面板的監視分頁中,自訂監視器可以與內建監視器一起使用。
注意:某些內建監視器僅在除錯模式下可用,並且在以發行模式匯出的專案中使用時,將始終返回 0。
注意:出於效能原因,某些內建監視器不會即時更新,所以在更改之間可能會有長達 1 秒的延遲。
注意:自訂監視器不支援負值。負值被鉗制為 0。
方法
void |
add_custom_monitor(id: StringName, callable: Callable, arguments: Array = [], type: MonitorType = 0) |
get_monitor(monitor: Monitor) const |
|
void |
列舉
enum Monitor: 🔗
Monitor TIME_FPS = 0
上一秒渲染的影格數。該指標每秒僅更新一次,與查詢頻率無關。越高越好。
Monitor TIME_PROCESS = 1
完成一影格所需的時間,單位為秒。越低越好。
Monitor TIME_PHYSICS_PROCESS = 2
完成一個物理影格所需的時間,單位為秒。越低越好。
完成一個導覽步驟的時間,單位為秒。包括導覽地圖的更新以及代理避障的計算。越低越好。
Monitor MEMORY_STATIC = 4
目前使用的靜態記憶體,單位為位元組。在發行版本中不可用。越低越好。
Monitor MEMORY_STATIC_MAX = 5
可用的靜態記憶體。在發行版本中不可用。越低越好。
Monitor MEMORY_MESSAGE_BUFFER_MAX = 6
訊息佇列緩衝區已使用的最大記憶體量,單位為位元組。訊息佇列用於延遲函式呼叫和通知。越低越好。
Monitor OBJECT_COUNT = 7
目前產生實體的對象數(包括節點)。越低越好。
Monitor OBJECT_RESOURCE_COUNT = 8
目前使用的資源數。越低越好。
Monitor OBJECT_NODE_COUNT = 9
目前在場景樹中產生實體的節點數。也包括根節點。越低越好。
Monitor OBJECT_ORPHAN_NODE_COUNT = 10
孤立節點的數量,即父節點不是場景樹節點的節點。越少越好。
注意:只在除錯模式中可用,以發佈模式匯出的專案中總會回傳 0。
Monitor RENDER_TOTAL_OBJECTS_IN_FRAME = 11
在上一個渲染影格中的物件總數。該指標不包括剔除的對象(通過隱藏節點、視錐剔除、或遮擋剔除)。越低越好。
Monitor RENDER_TOTAL_PRIMITIVES_IN_FRAME = 12
在上一個渲染影格中渲染的頂點或索引的總數。該指標不包括來自被剔除對象的圖元(通過隱藏節點、視錐剔除、或遮擋剔除)。由於預深度階段和陰影階段,圖元的數量總是高於場景中的實際頂點數量(通常是原始頂點數量的兩倍或三倍)。越低越好。
Monitor RENDER_TOTAL_DRAW_CALLS_IN_FRAME = 13
在上一個渲染影格中執行的繪製呼叫的總數。該指標不包括剔除對象(通過隱藏節點、視錐剔除、或遮擋剔除),因為它們不會導致繪製呼叫。越低越好。
Monitor RENDER_VIDEO_MEM_USED = 14
顯存的使用量(紋理和頂點記憶體之和,單位為位元組)。由於該指標還包括其他雜項分配,因此該值始終大於 RENDER_TEXTURE_MEM_USED 和 RENDER_BUFFER_MEM_USED 的總和。越低越好。
Monitor RENDER_TEXTURE_MEM_USED = 15
紋理記憶體的使用量(單位為位元組)。越低越好。
Monitor RENDER_BUFFER_MEM_USED = 16
渲染緩衝區記憶體的使用量(單位為位元組)。越低越好。
Monitor PHYSICS_2D_ACTIVE_OBJECTS = 17
遊戲中活躍的 RigidBody2D 節點數。越低越好。
Monitor PHYSICS_2D_COLLISION_PAIRS = 18
2D 物理引擎中碰撞對的數量。越低越好。
Monitor PHYSICS_2D_ISLAND_COUNT = 19
2D 物理引擎中孤島的數量。越低越好。
Monitor PHYSICS_3D_ACTIVE_OBJECTS = 20
遊戲中活躍的 RigidBody3D 和 VehicleBody3D 節點數。越低越好。
Monitor PHYSICS_3D_COLLISION_PAIRS = 21
3D 物理引擎中碰撞對的數量。越低越好。
Monitor PHYSICS_3D_ISLAND_COUNT = 22
3D 物理引擎中孤島的數量。越低越好。
Monitor AUDIO_OUTPUT_LATENCY = 23
AudioServer的輸出延遲。相當於呼叫AudioServer.get_output_latency(),不建議每影格呼叫方法。
NavigationServer2D 和 NavigationServer3D 中活動導航地圖的數量。這也包括由 World2D 和 World3D 實例建立的預設空導航地圖。
NavigationServer2D 和 NavigationServer3D 中活動導航區塊的數量。
NavigationServer2D 和 NavigationServer3D 中活動的處理避障的導航代理的數量。
NavigationServer2D 和 NavigationServer3D 中活動導航連結的數量。
NavigationServer2D 和 NavigationServer3D 中導覽網格多邊形的數量。
NavigationServer2D 和 NavigationServer3D 中導覽網格多邊形邊緣的數量。
NavigationServer2D 和 NavigationServer3D 中由於邊界重疊而被合併的導覽網格多邊形邊緣的數量。
NavigationServer2D 和 NavigationServer3D 中由於邊緣接近而被認為存在連接的多邊形邊緣的數量。
NavigationServer2D 和 NavigationServer3D 中無法合併的導覽網格多邊形邊緣的數量。這些邊仍然可以通過邊緣接近或使用連結而被連接。
NavigationServer2D 和 NavigationServer3D 中活動導航障礙物的數量。
Monitor PIPELINE_COMPILATIONS_CANVAS = 34
由 2D 畫布渲染器觸發的管線編譯次數。
Monitor PIPELINE_COMPILATIONS_MESH = 35
因載入網格而觸發的管線編譯次數。使用者首次執行遊戲且需要該管線時,這些編譯會導致載入時間變長。
Monitor PIPELINE_COMPILATIONS_SURFACE = 36
因渲染場景前建置表面快取而觸發的管線編譯次數。使用者首次執行遊戲且需要該管線時,這些編譯會導致載入場景時的卡頓。
Monitor PIPELINE_COMPILATIONS_DRAW = 37
因繪製場景而觸發的管線編譯次數。使用者首次執行遊戲且需要該管線時,這些編譯會導致遊戲過程中的卡頓。
Monitor PIPELINE_COMPILATIONS_SPECIALIZATION = 38
因最佳化目前場景而觸發的管線編譯次數。這些編譯是在後台進行的,不會導致任何卡頓。
NavigationServer2D 中活動導航地圖的數量。這也包括由 World2D 實例建立的預設空導航地圖。
NavigationServer2D 中活動導航區塊的數量。
NavigationServer2D 中活動的處理避障的導航代理的數量。
NavigationServer2D 中活動導航連結的數量。
NavigationServer2D 中導覽網格多邊形的數量。
NavigationServer2D 中導覽網格多邊形邊緣的數量。
NavigationServer2D 中由於邊界重疊而被合併的導覽網格多邊形邊緣的數量。
NavigationServer2D 中由於邊緣接近而被認為存在連接的多邊形邊緣的數量。
NavigationServer3D 中無法合併的導覽網格多邊形邊緣的數量。這些邊仍然可以通過邊緣接近或使用連結而被連接。
NavigationServer2D 中活動導航障礙物的數量。
NavigationServer3D 中活動導航地圖的數量。這也包括由 World3D 實例建立的預設空導航地圖。
NavigationServer3D 中活動導覽地區的數量。
NavigationServer3D 中正在處理避障的活動導覽代理的數量。
NavigationServer3D 中活動導覽連結的數量。
NavigationServer3D 中導覽網格多邊形的數量。
NavigationServer3D 中導覽網格多邊形邊緣的數量。
NavigationServer3D 中由於邊鍵重疊而被合併的導覽網格多邊形的邊的數量。
NavigationServer3D 中由邊緣接近而被認為已連接的多邊形的邊的數量。
NavigationServer3D 中無法合併的導覽網格多邊形的邊的數量。這些邊仍然可以通過邊緣接近或使用連結而被連接。
NavigationServer3D 中活動導航障礙物的數量。
Monitor RENDER_STREAMING_TEXTURE_MEM_USED = 59
The amount of memory used by texture streaming (in bytes). This represents the current VRAM usage of streamed textures at their currently loaded mipmap levels.
Monitor MONITOR_MAX = 60
代表 Monitor 列舉的大小。
enum MonitorType: 🔗
MonitorType MONITOR_TYPE_QUANTITY = 0
顯示器輸出格式化為整數值。
MonitorType MONITOR_TYPE_MEMORY = 1
顯示器輸出格式化為電腦記憶體格式。提交的值應代表位元組數。
MonitorType MONITOR_TYPE_TIME = 2
顯示器輸出格式化為毫秒級時間。提交的值應表示以秒(而不是毫秒)為單位的時間。
MonitorType MONITOR_TYPE_PERCENTAGE = 3
顯示器輸出格式化為百分比。提交的值應表示分數,而不是直接表示百分比,例如 0.5 表示 50.00%。
方法說明
void add_custom_monitor(id: StringName, callable: Callable, arguments: Array = [], type: MonitorType = 0) 🔗
新增一個名為 id 的自訂監視器。可以在 id 中使用斜線分隔符號指定監視器的類別(例如:"Game/NumberOfNPCs")。如果有多個斜線分隔符,則使用預設的類別。預設類別是 "Custom"。如果給定的 id 已經存在,則列印一個錯誤。
func _ready():
var monitor_value = Callable(self, "get_monitor_value")
# 將名稱為“MyName”的監視器新增到類別“MyCategory”。
Performance.add_custom_monitor("MyCategory/MyMonitor", monitor_value)
# 將名稱為“MyName”的監視器新增到類別“Custom”。
# 注意:“MyCategory/MyMonitor”和“MyMonitor”同名但不同 ID,所以程式碼有效。
Performance.add_custom_monitor("MyMonitor", monitor_value)
# 將名稱為“MyName”的監視器新增到類別“Custom”。
# 注意:“MyMonitor”和“Custom/MyMonitor”名稱相同,類別相同,但 ID 不同,所以程式碼有效。
Performance.add_custom_monitor("Custom/MyMonitor", monitor_value)
# 將名稱為“MyCategoryOne/MyCategoryTwo/MyMonitor”的監視器新增到類別“Custom”。
Performance.add_custom_monitor("MyCategoryOne/MyCategoryTwo/MyMonitor", monitor_value)
func get_monitor_value():
return randi() % 25
public override void _Ready()
{
var monitorValue = new Callable(this, MethodName.GetMonitorValue);
// 將名稱為“MyName”的監視器新增到類別“MyCategory”。
Performance.AddCustomMonitor("MyCategory/MyMonitor", monitorValue);
// 將名稱為“MyName”的監視器新增到類別“Custom”。
// 注意:“MyCategory/MyMonitor”和“MyMonitor”同名但不同 ID,所以程式碼有效。
Performance.AddCustomMonitor("MyMonitor", monitorValue);
// 將名稱為“MyName”的監視器新增到類別“Custom”。
// 注意:“MyMonitor”和“Custom/MyMonitor”名稱相同,類別相同,但 ID 不同,所以程式碼有效。
Performance.AddCustomMonitor("Custom/MyMonitor", monitorValue);
// 將名稱為“MyCategoryOne/MyCategoryTwo/MyMonitor”的監視器新增到類別“Custom”。
Performance.AddCustomMonitor("MyCategoryOne/MyCategoryTwo/MyMonitor", monitorValue);
}
public int GetMonitorValue()
{
return GD.Randi() % 25;
}
除錯器呼叫可呼叫物件來取得自訂監視器的值。可呼叫物件必須返回一個零或正整數或浮點數。
使用參數陣列中提供的參數來呼叫可呼叫物件。
Variant get_custom_monitor(id: StringName) 🔗
返回具有給定 id 的自訂監視器的值。呼叫這個可呼叫物件以取得自訂監視器的值。另請參閱 has_custom_monitor()。如果給定的 id 不存在,則列印一個錯誤。
Array[StringName] get_custom_monitor_names() 🔗
以一個 Array,返回活動自訂監視器的名稱。
PackedInt32Array get_custom_monitor_types() 🔗
以一個陣列回傳活動自訂監視器的 MonitorType 值。
float get_monitor(monitor: Monitor) const 🔗
返回任一可用的內建監視器的值。應該提供任一 Monitor 常數作為參數,如下所示:
print(Performance.get_monitor(Performance.TIME_FPS)) # 將 FPS 列印到控制台。
GD.Print(Performance.GetMonitor(Performance.Monitor.TimeFps)); // 將 FPS 列印到控制台。
請參閱 get_custom_monitor(),以查詢自訂效能監視器的值。
int get_monitor_modification_time() 🔗
返回自訂監視器被新增/刪除時的最後一個刻度(自引擎啟動以來的微秒數)。當該監視器更新時,它被設定為 Time.get_ticks_usec()。
bool has_custom_monitor(id: StringName) 🔗
如果存在具有給定 id 的自訂監視器,則返回 true,否則返回 false。
void remove_custom_monitor(id: StringName) 🔗
移除具有給定 id 的自訂監視器。如果給定的 id 已經不存在,則列印一個錯誤。