UniWindowController (UniWinC)

When a window is transparent, it still exists as a rectangular area. To allow users to click "through" the transparent parts to windows underneath, UniWindowController uses "Hit Testing".

You can choose between two methods:

If you use Raycast and forget to provide Colliders, the window will become unclickable.

When a window is transparent, it still exists as a rectangular area. To allow users to click "through" the transparent parts to windows underneath, UniWindowController uses hit testing.

There are two methods for hit testing:

If you use the Raycast method and forget to add colliders, you will not be able to interact with the screen.

Since windows are technically rectangular, UniWindowController uses "Hit Testing" to allow mouse clicks to pass through transparent areas to windows underneath (click-through).

Hit Test Methods

Windows-only Transparency Methods

On Windows, you can choose between two transparency modes. Note that ColorKey is better for touch input but lacks semi-transparency.

To set up window control in your scene, follow these steps:

1. Add the Prefab: Drag the UniWindowController prefab from Runtime/Prefabs into your scene.
2. Configure Settings: Select the UniWindowController instance in the Inspector.
   • Use the provided button to automatically update necessary Player Settings.
   • Adjust settings like IsTransparent to your preference.
3. Enable Window Dragging (Optional): If you want to move the window by dragging with the mouse, add the DragMoveCanvas prefab from Runtime/Prefabs to your scene.
   • Requirement: An EventSystem must be present in the scene. If you don't have one, go to UI -> Event System to add it.
4. Build and Run: Build the project as a PC / Mac Standalone application and run the build.

If you are using the Universal Render Pipeline (URP), you must maintain the alpha channel to enable background transparency. Configure the following:

1. Disable HDR: On your Main Camera (GameObject) -> Camera (Component) -> Output, set HDR to Off.
2. Enable AlphaProcessing: Ensure AlphaProcessing is enabled in your URP settings.

To use the controller in your project, follow these steps:

1. Add the Prefab: Add the UniWindowController prefab from Runtime/Prefabs to your scene.
2. Configure Inspector: Inspect the UniWindowController instance.
   • Use the green button in the inspector to automatically apply necessary Player Settings changes.
   • Configure settings like IsTransparent according to your needs.
3. Enable Window Dragging (Optional): If you want to move the window by dragging a specific area, add the DragMoveCanvas prefab from Runtime/Prefabs.
   • Note: This requires an EventSystem. If your scene doesn't have one, add it via UI -> Event System.
4. Build: Build the project as a PC / Mac Standalone application and run the build.

You can install UniWindowController using two methods:

Method A: Unity Package Manager (UPM)

This is recommended for easier version updates.

1. Open the Package Manager from the Window menu in the Unity Editor.
2. Click the [+] button and select Add package from git URL....
3. Enter the following URL: https://github.com/kirurobo/UniWindowController.git#upm and click Add.

Method B: UnityPackage

1. Download the .unitypackage file from the Releases page.
2. Import the package into your Unity project.

When using the Universal Render Pipeline (URP), you must ensure the alpha channel is maintained to support transparency. Apply these settings:

1. Disable HDR: On your Main Camera (GameObject), go to the Camera component > Output and set HDR to Off.
2. Enable Alpha Processing: Ensure AlphaProcessing is enabled in your URP settings.

Transparency Issues

• Direct3D12: Background transparency is not supported.
• Direct3D11: To enable transparency, you must disable Use DXGI flip model swapchain for D3D11 in Unity settings.
• Unity Editor: Transparency does not work inside the Unity Editor. You must build and run the application to see transparency effects.

General Limitations

• Touch Input: Support is limited. On Windows, switching TransparentType to ColorKey improves touch feel at the cost of semi-transparency.
• Multiple Windows: The package does not support multiple windows.
• Platform: Supports Windows 10/11 and macOS.

To allow users to move the window by dragging a specific UI element (like a handle bar):

1. Attach the UniWindowMoveHandler.cs script to a UI element (the element must be a Raycast Target).
2. The DragMoveCanvas prefab includes a Panel that covers the entire screen. This panel is set to the Ignore Raycast layer so that it doesn't interfere with the automatic hit test, allowing you to drag from anywhere on the screen while still allowing other UI operations to take precedence.

The UniWindowController script is the primary interface for controlling the window via C# scripting. The following properties can be manipulated: