https://github.com/mixtuti/screenshot_for_unity
Unityでスクリーンショットを撮影するためのライブラリ
https://github.com/mixtuti/screenshot_for_unity
screenshot unity
Last synced: about 2 months ago
JSON representation
Unityでスクリーンショットを撮影するためのライブラリ
- Host: GitHub
- URL: https://github.com/mixtuti/screenshot_for_unity
- Owner: mixtuti
- License: mit
- Created: 2024-12-26T01:14:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-21T02:19:31.000Z (over 1 year ago)
- Last Synced: 2025-03-06T09:53:39.121Z (over 1 year ago)
- Topics: screenshot, unity
- Language: C#
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Screenshot_for_Unity
 
Unityでスクリーンショットを撮影するためのライブラリです。
指定のレイヤーのみ撮影すること、撮影した画像を画面に表示など最低限のスクリーンショット機能を実装しました。
## システム要件
Unity 2022.3.28 での動作は確認済みです。
UniTask 2.5.10 が必要になります。
https://github.com/Cysharp/UniTask
## 概要
Unityでスクリーンショットを撮影するためのライブラリです。
指定のレイヤーのみ撮影すること、撮影した画像を画面に表示など最低限のスクリーンショット機能を実装しました。
## 依存関係
UniTask 2.5.10
## 導入方法
### 1. プロジェクトへの導入
導入方法は大きく分けて2つあります。お好きな方法で導入してください。
#### 1. Unity Package Managerを使う方法
「Window > Package Manager」を開き、「Add Package from git URL」を選択します。
その後、以下のURLを入力してください。
```
https://github.com/mixtuti/Screenshot_for_Unity.git?path=Screenshot%20for%20Unity
```
#### 2. Import Packageを使う方法
リリースから最新のUnity Packageをダウンロードし、インポートします。
> [!TIP]
> 更新が遅くなることが多いので1の方法を使うことをお勧めします。
### 2. 利用方法
プレハブフォルダに入っているオブジェクトをシーン内に配置します。
その後、適当なゲームオブジェクトにScreenshotCameraExtension.csをアタッチしてください。
必要に応じてPlaySoundOnScreenshot.csやScreenshotDisplayExtension.csをアタッチしてください。
## スクリプトの解説
### 1. ScreenShotCore.cs
スクリーンショットを撮るための機能を提供するスクリプト
撮影するカメラやレイヤー解像度などを設定できます。
### 2. ScreenshotExtensionsManager.cs
スクリーンショットの前後でカスタムの処理をするためのスクリプト
### 3. IScreenshotExtension.cs
スクリーンショットを撮る前後に呼ばれる2つのメソッドを定義するインターフェイス
### 4. ScreenshotSettings.cs
スクリーンショットの設定をまとめたスクリプト
### 5. PlaySoundOnScreenshot.cs
スクリーンショット撮影後に効果音を鳴らすためのスクリプト
### 6. ScreenshotCameraExtension.cs
カメラ撮影に関する拡張機能を提供するスクリプト
任意のカメラで撮影、撮影するレイヤーの指定、解像度指定などをサポート
### 7. ScreenshotDisplayExtension.cs
スクリーンショット撮影後に、画像を画面上に表示するためのスクリプト
表示する位置や時間、サイズなどを指定できる
## 関数
### 1. ScreenShotCore.cs
#### 1. TakeScreenshot()
スクリーンショットを撮影するための関数。
- 引数: なし
- 戻り値: なし
このメソッドはスクリーンショットを撮影するためのメインのメソッドです。ScreenshotExtensionsManager.csが存在すれば、撮影前後に拡張機能の処理を実行します。
その後、ScreenCapture.CaptureScreenshotを使用してスクリーンショットを指定されたファイルパスに保存します。
#### 2. CaptureScreenshot(string filePath, Camera targetCamera = null, Vector2? customResolution = null, List layersToCapture = null)
指定されたファイルパスにスクリーンショットを保存するメソッド。
- 引数:
- filePath (string): 保存するファイルパス。
- targetCamera (Camera, オプション): スクリーンショットを撮影するカメラ。指定しない場合は画面全体をキャプチャ。
- customResolution (Vector2?, オプション): カスタム解像度を指定する場合の解像度。
- layersToCapture (List, オプション): 撮影するレイヤーのリスト。指定しない場合、すべてのレイヤーがキャプチャされます。
- 戻り値: なし
このメソッドは、指定されたファイルパスにスクリーンショットを保存します。
targetCameraが指定されていればそのカメラから、指定されていなければ画面全体をキャプチャします。
また、解像度の設定やレイヤーの制御も行います。
#### 3. InvokeBeforeScreenshot()
スクリーンショット撮影前に拡張機能を実行するメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、スクリーンショットを撮影する前に呼び出されます。
拡張機能があれば、それらの BeforeScreenshotメソッドを実行します。
#### 4. InvokeAfterScreenshot(string filePath)
スクリーンショット撮影後に拡張機能を実行するメソッド。
- 引数:
- filePath (string): 保存されたスクリーンショットのファイルパス。
- 戻り値: なし
このメソッドは、スクリーンショットを撮影した後に呼び出されます。
拡張機能があれば、それらの AfterScreenshot メソッドを実行し、撮影後の処理を行います。
### 2. ScreenshotExtensionsManager.cs
#### 1. InvokeBeforeScreenshot()
スクリーンショット撮影前に拡張機能を実行するメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、スクリーンショットを撮影する前に呼び出されます。
シーン内のすべての拡張機能 (IScreenshotExtension インターフェースを実装したオブジェクト) の BeforeScreenshot メソッドを実行します。
これにより、スクリーンショットが撮影される前に、各拡張機能が任意の処理を行うことができます。
#### 2. InvokeAfterScreenshot(string filePath)
スクリーンショット撮影後に拡張機能を実行するメソッド。
- 引数:
- filePath (string): 保存されたスクリーンショットのファイルパス。
- 戻り値: なし
このメソッドは、スクリーンショットを撮影した後に呼び出されます。
拡張機能があれば、それらの AfterScreenshot メソッドを実行し、撮影後の処理を行います。
filePath には、保存されたスクリーンショットのファイルパスが渡され、拡張機能はそれを利用して後処理を行うことができます。
### 6. ScreenshotCameraExtension
#### 1. BeforeScreenshot()
スクリーンショット撮影前に呼ばれるメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、スクリーンショットが撮影される前に呼び出されます。
現状では特別な処理は行っていませんが、必要に応じて拡張することができます。
#### 2. AfterScreenshot(string filePath)
スクリーンショット撮影後に呼ばれるメソッド。
- 引数:
- filePath (string): 保存されたスクリーンショットのファイルパス。
- 戻り値: なし
このメソッドは、スクリーンショットが撮影された後に呼び出されます。
現状では特別な処理は行っていませんが、拡張機能を実行するなど、撮影後の処理を追加できます。
#### 3. CaptureMultipleResolutions()
複数解像度でのスクリーンショットを撮影するメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、指定された解像度で複数のスクリーンショットを撮影します。
解像度は、1920x1080、1280x720、640x480の3つのプリセットで撮影します。
それぞれの解像度でスクリーンショットを保存するために、CaptureScreenshot() メソッドを呼び出します。
#### 4. GenerateFilePath(string baseFilePath, int width, int height)
解像度に基づいてファイルパスを生成するメソッド。
- 引数:
- baseFilePath (string): 基本となるファイルパス。
- width (int): 解像度の横幅。
- height (int): 解像度の縦幅。
- 戻り値: (string): 解像度が追加された新しいファイルパス。
このメソッドは、解像度に基づいてファイルパスを生成します。
例えば、ファイル名に 1920x1080 の解像度を追加する形で保存先を決定します。
#### 5. CaptureScreenshot(string filePath)
指定した解像度とカメラ設定でスクリーンショットを撮るメソッド。
- 引数:
- filePath (string): 保存先のファイルパス。
- 戻り値: なし
このメソッドは、指定された filePath にスクリーンショットを保存します。
レイヤー設定に基づいて、カメラの cullingMask を設定し、特定のレイヤーをキャプチャ対象にします。
#### 6. ConvertLayerMasksToStrings(List layerMasks)
レイヤーマスクをレイヤー名に変換するメソッド。
- 引数:
- layerMasks (List): レイヤーマスクのリスト。
- 戻り値: (List): レイヤー名のリスト。
このメソッドは、指定された LayerMask のリストをレイヤー名に変換します。
「Everything」の場合にはその文字列を返し、他のレイヤーの場合はそれに対応するレイヤー名を返します。
#### 7. TakeScreenshot()
スクリーンショットを撮影するメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、captureMultipleResolutions が true の場合、複数の解像度でスクリーンショットを撮影します。
それ以外の場合は、CaptureScreenshot() メソッドを呼び出して通常のスクリーンショットを撮影します。
### 7. ScreenshotDisplayExtension.cs
#### 1. BeforeScreenshot()
スクリーンショット撮影前に呼ばれるメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、スクリーンショットが撮影される前に呼び出されます。
現在は特別な処理を行っていませんが、必要に応じて拡張することができます。
#### 2. AfterScreenshot(string filePath)
スクリーンショット撮影後に呼ばれるメソッド。
- 引数:
- filePath (string): 保存されたスクリーンショットのファイルパス。
- 戻り値: なし
このメソッドは、スクリーンショットが撮影された後に呼び出されます。
ファイルが存在するまで待機し、画像を読み込んで表示します。
オプションで、フェードアウトや縮小処理を実行できます。
#### 3. WaitForFileToExist(string filePath)
指定されたファイルが存在するまで待機するメソッド。
- 引数:
- filePath (string): ファイルのパス。
- 戻り値: なし
このメソッドは、指定されたファイルが存在するまで待機します。
ファイルが存在するようになると、処理を続行します。
#### 4. FadeOut(RawImage image, float duration)
指定された RawImage をフェードアウトさせるメソッド。
- 引数:
- image (RawImage): フェードアウトさせる対象の RawImage コンポーネント。
- duration (float): フェードアウトにかかる時間（秒）。
- 戻り値: UniTask
このメソッドは、指定された RawImage を指定された duration の間にフェードアウトさせます。
オプションで、フェードアウト中に画像のサイズを縮小する処理も行えます。
#### 5. initImage()
RawImage の初期設定を行うメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、RawImage の色を透明に初期化します。
画像の表示を開始する前に、このメソッドを呼び出しておきます。
#### 6. SetRawImageResolution()
解像度プリセットに基づいて RawImage の解像度を設定するメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、resolutionPreset に応じて RawImage の解像度を設定します。
解像度プリセットは、FullHD、HD、SD、画面サイズの半分、四分の一、八分の一、またはカスタム解像度に設定できます。
#### 7. SetRawImageSize(float width, float height)
RawImage のサイズを設定するメソッド。
- 引数:
- width (float): 設定する幅。
- height (float): 設定する高さ。
- 戻り値: なし
このメソッドは、指定した width と height に基づいて RawImage のサイズを設定します。
#### 8. SetRawImagePosition()
解像度プリセットに基づいて RawImage の位置を設定するメソッド。
- 引数: なし
- 戻り値: なし
このメソッドは、positionPreset に基づいて RawImage の位置を設定します。
位置の選択肢として、中央、右上、右下、左上、左下、またはカスタム位置を選べます。