https://github.com/mminer/big-image-recorder

Unity Recorder plugin to capture large image sequences.
https://github.com/mminer/big-image-recorder

unity unity-editor unity-package unity-tool unity3d unity3d-editor unity3d-package

Last synced: 4 months ago
JSON representation

Unity Recorder plugin to capture large image sequences.

• Host: GitHub
• URL: https://github.com/mminer/big-image-recorder
• Owner: mminer
• License: mit
• Created: 2021-05-23T18:48:00.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T02:24:43.000Z (7 months ago)
• Last Synced: 2024-09-27T23:20:11.188Z (4 months ago)
• Topics: unity, unity-editor, unity-package, unity-tool, unity3d, unity3d-editor, unity3d-package
• Language: C#
• Homepage:
• Size: 539 KB
• Stars: 37
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Big Image Recorder

This [Unity Recorder](https://docs.unity3d.com/Manual/com.unity.recorder.html)

plugin captures an image sequence at a higher resolution than the

maximum texture size. Want to output your scene at 100,000 x 100,000 pixels? You

got it friend.

![8K - 100K size comparison](Documentation~/8k-100k-size-comparison.png)

To do this it divides the camera's projection matrix into tiles and saves the

renders as individual images to stitch together.

![Tiles stitched](Documentation~/tiles-stitched.jpg)

At present this stitching operation is left up to you (but see "Image Stitching"

below for recommendations).

## Installing

Add this package to your project using the Unity Package Manager (UPM).

1. Open *Window > Package Manager*

2. If it's not already in your project, install Recorder from the Unity Registry

3. Click "+" in the top-left corner and choose "Add package from git URL..."

4. Enter https://github.com/mminer/big-image-recorder.git

You can also clone this repository and point UPM to your local copy. Do this if

you want to modify the source code.

## Using

1. Open *Window > General > Recorder > Recorder Window*

2. Click "Add Recorder" and choose "Big Image Sequence"

3. Enter the tag of your target camera (or keep the default to use your main camera)

4. Enter your desired output size, number of rows and columns, and start recording

![Recorder screenshot](Documentation~/recorder-screenshot.png)

Recorder spits out multiple images per frame, one for each "tile". By default

these are named `image__-.png`, e.g.

*image_0003_01-01.png*.

![Tile images](Documentation~/tile-images.png)

### Image Stitching

[ImageMagick](https://imagemagick.org) is one option to stitch the image tiles

together into a final image.

    # Stitches together a frame of two columns.

    montage -mode concatenate -tile 2x *.png out.png

To run this automatically, enter the absolute path to the executable in the

"Stitch Command" field and its arguments (i.e. `-mode ...`) in "Arguments". For

example, if you install ImageMagick on macOS using Homebrew, enter

`/usr/local/bin/montage` as the command.

![Stitch command field](Documentation~/stitch-command-field.png)

The arguments can contain the same wildcards as the file name. Use these to

specify the frame, rows, and columns, e.g. `-mode concatenate -tile

x image_*.png .png`.

## Caveats

Dividing a projection matrix into tiles and stitching together the results works

poorly with post-processing effects. Vignette, for example, gets applied after

the camera renders and leaves noticeable seams where the edges meet.

![Stitch vignetting](Documentation~/stitch-vignetting.jpg)

For best results, turn off all screen space effects.