https://github.com/katsumasa/UnityOverDrawKun

overdraw check tool.
https://github.com/katsumasa/UnityOverDrawKun

camera graphics overdraw profiling shader unity

Last synced: about 1 year ago
JSON representation

overdraw check tool.

• Host: GitHub
• URL: https://github.com/katsumasa/UnityOverDrawKun
• Owner: katsumasa
• License: mit
• Created: 2019-12-20T08:38:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-20T08:21:12.000Z (over 3 years ago)
• Last Synced: 2024-08-03T05:14:48.463Z (almost 2 years ago)
• Topics: camera, graphics, overdraw, profiling, shader, unity
• Language: C#
• Homepage:
• Size: 8.18 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# UnityOverDrawKun

![GitHub package.json version](https://img.shields.io/github/package-json/v/katsumasa/UnityOverDrawKun?style=plastic)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/katsumasa/UnityOverDrawKun?style=plastic)

overdraw check tool.

[English version README](Documentation~/UnityOverDrawKun.md)

## 概要

描画時のオーバードロー（重ね塗り）を計測するツールです。

***マルチディスプレイに対応しているプラットフォームでのみ計測可能です。***

![641b60a898bf20e97083f5adb1294113](https://user-images.githubusercontent.com/29646672/137099718-fa1850a7-1fe7-40b9-a1df-1a6d29cd1b4b.gif)

## インストール

`UnityOverDrawKun` 以下を計測する対象プロジェクトのAssetフォルダー以下へ配置して下さい。

![image](https://user-images.githubusercontent.com/29646672/137099528-e92781a8-657c-4c91-b527-7924f24f08e2.png)

## セッティング

- 上記フォルダに含まれる`OverdrawCamera`を計測するSceneへ配置して下さい。

![d5cf54a0dd8ba2f731fd92e732c46dc6](https://user-images.githubusercontent.com/29646672/137100995-bcd30b40-8cb9-43eb-811d-fc4b212273bc.png)

- `OverdrawCamera.MasterCamera`に計測するCameraを指定して下さい。

　![fac434078910df9e378ae8cf2de692f2](https://user-images.githubusercontent.com/29646672/137101051-5e1cc1f1-0076-4200-9adc-8388b672e335.png)

- `OverdrawCamera`にアタッチされたいるCameraコンポーネントのTarget Display プロパティの値に`Display 2`を設定して下さい。

  

![0241bb02078058a3a206b29ba29f6cb4](https://user-images.githubusercontent.com/29646672/137101158-a6191d63-2590-4005-8046-c75f25ed2776.png)

### MEMO

```:txt

 現在選択しているプラットフォームでマルチディスプレイが対応していない場合、Target Displayの項目は選択されません。プラットフォームをPC,Mac&Linux Standaloneなどへ変更して下さい。

```

- ２個目のGameViewを表示して下さい。GameViewはView上の三からAdd Tabを選択しGameを選択することで増やすことが出来ます。

 





- 上記で開いたGameViewの片方のDisplayを`Display 2`へ変更します。



## 計測方法

- Playボタンを押すことでOverdrawCamera.Camera.Target Displayへ指定したGameViewに計測結果が表示されます。

- 計測結果が明るい部分程、オーバードローが発生していることになります。

- インスペクターからOverdrawCameraにアタッチされているOverDrawKun.Recordボタンを押すことで計測結果を保存することが出来ます。

  

![edf74eecdcc6a588c9f515bb4e3b968d](https://user-images.githubusercontent.com/29646672/137101207-f921811a-732c-4f49-8a5b-8a1cd58f1564.png)

 

 計測結果はプロジェクトフォルダ以下にYYTTMMDDHHMMのフォルダを作成し出力されます。

![4b6bdd8b65e4b1ed0b71d05a4f9e9511](https://user-images.githubusercontent.com/29646672/137101240-0ad277ff-00c6-4900-b04f-bd9d56873d0b.png)

## 計測結果の解析

UnityOverdrawKunWindowで計測結果を解析することが可能です。

![0e28ce0ecf377d4d977aab0c4dbe3e05](https://user-images.githubusercontent.com/29646672/137102502-f118399b-fc8e-46f4-bccb-cccd89860ab3.gif)

### Windowの起動方法

Window->UnityOverdrawKunでWindowが開きます。

### 計測結果の取り込み方法

Window左上のOpenFolderアイコンから計測結果の保存先のディレクトリを開きます。

### 計測結果の確認方法

画面下部のスライドバーをスライドさせることで、各フレームで発生しているオーバードローの度合を確認する事が可能です。

*Note*  

オーバードローの度合とは[OverdrawKun.shader](https://github.com/katsumasa/UnityOverDrawKun/blob/master/Runtime/Shaders/OverdrawKun.shader)でレンダリングされたTextureの各ピクセルのR成分の平均値を指しています。

### CSV形式での保存方法

画面上部のSave As CSVボタンから解析結果をCSV形式で保存する事が出来ます。

## その他

フィードバックをお待ちしております。

以上！