121 lines
3.3 KiB
Markdown
121 lines
3.3 KiB
Markdown
---
|
|
name: profiler-get-rendering-stats
|
|
description: Return current frame timing, FPS, vsync, target frame rate, threading mode, and graphics device type from Unity Time / QualitySettings / SystemInfo.
|
|
---
|
|
|
|
# Profiler / Get Rendering Stats
|
|
|
|
Snapshots rendering-related fields from `UnityEngine.Time`, `UnityEngine.QualitySettings`, `UnityEngine.Application` and `UnityEngine.SystemInfo`. All values are read from built-in Unity APIs so no external Unity package is required.
|
|
|
|
## Fields
|
|
|
|
- `FrameTimeMs` — `Time.deltaTime * 1000f`.
|
|
- `Fps` — `1 / Time.deltaTime` (0 when delta is zero).
|
|
- `VSyncCount` — `QualitySettings.vSyncCount`.
|
|
- `TargetFrameRate` — `Application.targetFrameRate`.
|
|
- `RenderingThreadingMode` — `SystemInfo.renderingThreadingMode.ToString()`.
|
|
- `GraphicsDeviceType` — `SystemInfo.graphicsDeviceType.ToString()`.
|
|
|
|
## How to Call
|
|
|
|
```bash
|
|
unity-mcp-cli run-tool profiler-get-rendering-stats --input '{
|
|
"nothing": "string_value"
|
|
}'
|
|
```
|
|
|
|
> For complex input (multi-line strings, code), save the JSON to a file and use:
|
|
> ```bash
|
|
> unity-mcp-cli run-tool profiler-get-rendering-stats --input-file args.json
|
|
> ```
|
|
>
|
|
> Or pipe via stdin (recommended):
|
|
> ```bash
|
|
> unity-mcp-cli run-tool profiler-get-rendering-stats --input-file - <<'EOF'
|
|
> {"param": "value"}
|
|
> EOF
|
|
> ```
|
|
|
|
|
|
### Troubleshooting
|
|
|
|
If `unity-mcp-cli` is not found, either install it globally (`npm install -g unity-mcp-cli`) or use `npx unity-mcp-cli` instead.
|
|
Read the /unity-initial-setup skill for detailed installation instructions.
|
|
|
|
## Input
|
|
|
|
| Name | Type | Required | Description |
|
|
|------|------|----------|-------------|
|
|
| `nothing` | `string` | No | |
|
|
|
|
### Input JSON Schema
|
|
|
|
```json
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"nothing": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Output
|
|
|
|
### Output JSON Schema
|
|
|
|
```json
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"result": {
|
|
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Editor.API.Tool_Profiler-RenderingStatsData",
|
|
"description": "Rendering statistics from Unity's Time / QualitySettings / SystemInfo. No external package required."
|
|
}
|
|
},
|
|
"$defs": {
|
|
"com.IvanMurzak.Unity.MCP.Editor.API.Tool_Profiler-RenderingStatsData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"FrameTimeMs": {
|
|
"type": "number",
|
|
"description": "Last reported frame time (Time.deltaTime * 1000) in milliseconds."
|
|
},
|
|
"Fps": {
|
|
"type": "number",
|
|
"description": "Frames per second derived from Time.deltaTime."
|
|
},
|
|
"VSyncCount": {
|
|
"type": "integer",
|
|
"description": "QualitySettings.vSyncCount."
|
|
},
|
|
"TargetFrameRate": {
|
|
"type": "integer",
|
|
"description": "Application.targetFrameRate."
|
|
},
|
|
"RenderingThreadingMode": {
|
|
"type": "string",
|
|
"description": "SystemInfo.renderingThreadingMode."
|
|
},
|
|
"GraphicsDeviceType": {
|
|
"type": "string",
|
|
"description": "SystemInfo.graphicsDeviceType."
|
|
}
|
|
},
|
|
"required": [
|
|
"FrameTimeMs",
|
|
"Fps",
|
|
"VSyncCount",
|
|
"TargetFrameRate"
|
|
],
|
|
"description": "Rendering statistics from Unity's Time / QualitySettings / SystemInfo. No external package required."
|
|
}
|
|
},
|
|
"required": [
|
|
"result"
|
|
]
|
|
}
|
|
```
|
|
|