Chroma Keying with the Unity Editor

Use the Unity Keyer package (com.unity.media.keyer) to create an alpha mask from green screen images in the Unity Editor.

This repository contains the code package, the test package and test projects related with Unity Keyer.

Get started

To learn about the Unity Keyer package (concepts, features, and workflows) read the Keyer package documentation in this repository.

Check out the licensing model

The Keyer package is licensed under the Apache License, Version 2.0.

Contribution and maintenance

We appreciate your interest in contributing to the Unity Keyer package.
It's important to note that this package is provided as is, without any maintenance or release plan.
Therefore, we are unable to monitor bug reports, accept feature requests, or review pull requests for this package.

However, we understand that users may want to make improvements to the package.
In that case, we recommend that you fork the repository. This will allow you to make changes and enhancements as you see fit.

Keyer package

Access the Keyer package folder

Package	Description
Keyer	The package that allows you to create an alpha mask from green screen images.

Test the Keyer package

Use these Unity projects to run various tests against the Keyer package.

Project	Description
Keyer-api-tests	Runs the API tests.
KeyerGraphicsTestsHDRP	Runs the Keyer Graphics Tests with HDRP installed.
KeyerGraphicsTestsLRP	Runs the Keyer Graphics Tests on the Legacy (built-in) render pipeline
KeyerGraphicsTestsURP	Runs the Keyer Graphics Tests with URP installed.

These test projects use an additional internal package available in this repository:

Package	Description
Keyer Graphics Tests	Includes all the graphics tests required by the test projects listed above.