/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* Licensed under the Oculus SDK License Agreement (the "License");
* you may not use the Oculus SDK except in compliance with the License,
* which is provided at the time of installation or download, or which
* otherwise accompanies this software in either electronic or hard copy form.
*
* You may obtain a copy of the License at
*
* https://developer.oculus.com/licenses/oculussdk/
*
* Unless required by applicable law or agreed to in writing, the Oculus SDK
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using UnityEngine;
using UnityEngine.Profiling;
#if UNITY_EDITOR
using UnityEditor;
#endif
namespace Oculus.Interaction.UnityCanvas
{
///
/// A component that, given a Canvas, renders the canvas to a RenderTexture.
/// Used in Interaction SDK's curved canvas. Each render mode has a unique use case.
///
[DisallowMultipleComponent]
public class CanvasRenderTexture : MonoBehaviour
{
private class TransformChangeListener : MonoBehaviour
{
public event Action WhenRectTransformDimensionsChanged = delegate { };
private void OnRectTransformDimensionsChange()
{
WhenRectTransformDimensionsChanged();
}
}
public enum DriveMode
{
Auto,
Manual
}
public const int DEFAULT_UI_LAYERMASK = 1 << 5; //Hardcoded as the UI layer in Unity.
private static readonly Vector2Int DEFAULT_TEXTURE_RES = new Vector2Int(128, 128);
///
/// The Unity canvas that will be rendered.
///
[Tooltip("The Unity canvas that will be rendered.")]
[SerializeField]
private Canvas _canvas;
///
/// Used to increase resolution of rendered canvas.
/// If you need extra resolution, you can use this as a whole-integer multiplier of the final resolution used to render the texture.
///
[Tooltip("Used to increase resolution of rendered canvas. If you need extra resolution, you can use this as a whole-integer multiplier " +
"of the final resolution used to render the texture.")]
[Range(1, 3)]
[Delayed]
[SerializeField]
private int _renderScale = 1;
///
/// If set to auto, texture dimensions will take the size of the attached RectTransform into consideration, in addition to the configured pixel-per-unit ratio.
///
[Tooltip("If set to auto, texture dimensions will take the size of the attached " +
"RectTransform into consideration, in addition to the configured pixel-per-unit ratio.")]
[SerializeField]
private DriveMode _dimensionsDriveMode = DriveMode.Auto;
///
/// The exact pixel resolution of the texture used for interface rendering.
///
[Tooltip("The exact pixel resolution of the texture used for interface rendering.")]
[Delayed]
[SerializeField]
private Vector2Int _resolution = DEFAULT_TEXTURE_RES;
///
/// Whether or not mip-maps should be auto-generated for the texture. Can help aliasing if the texture can be viewed from many difference distances.
///
[Tooltip("Whether or not mip-maps should be auto-generated for the texture. " +
"Can help aliasing if the texture can be " +
"viewed from many difference distances.")]
[SerializeField]
private bool _generateMipMaps = false;
///
/// Pixels per unit ratio used to drive the texture dimensions. Determines the RenderTexture size from the canvas world size.
///
[Tooltip("Pixels per unit ratio used to drive the texture dimensions. Determines the RenderTexture size from the canvas world size.")]
[SerializeField]
private int _pixelsPerUnit = 100;
[Header("Rendering Settings")]
///
/// The layers to render when the rendering texture is created. All child renderers should be part of this mask.
///
[Tooltip("The layers to render when the rendering texture is created. " +
"All child renderers should be part of this mask.")]
[SerializeField]
private LayerMask _renderingLayers = DEFAULT_UI_LAYERMASK;
public LayerMask RenderingLayers => _renderingLayers;
public Action OnUpdateRenderTexture = delegate { };
public int RenderScale
{
get
{
return _renderScale;
}
set
{
if (_renderScale < 1 || _renderScale > 3)
{
throw new ArgumentException($"Render scale must be between 1 and 3, but was {value}");
}
if (_renderScale == value)
{
return;
}
_renderScale = value;
if (isActiveAndEnabled && Application.isPlaying)
{
UpdateCamera();
}
}
}
public Camera OverlayCamera => _camera;
public Texture Texture => _tex;
private TransformChangeListener _listener;
private RenderTexture _tex;
private Camera _camera;
protected bool _started = false;
public Vector2Int CalcAutoResolution()
{
if (_canvas == null)
{
return DEFAULT_TEXTURE_RES;
}
var rectTransform = _canvas.GetComponent();
if (rectTransform == null)
{
return DEFAULT_TEXTURE_RES;
}
Vector2 size = rectTransform.sizeDelta;
size.x *= rectTransform.lossyScale.x;
size.y *= rectTransform.lossyScale.y;
int x = Mathf.RoundToInt(UnitsToPixels(size.x));
int y = Mathf.RoundToInt(UnitsToPixels(size.y));
return new Vector2Int(Mathf.Max(x, 1), Mathf.Max(y, 1));
}
public Vector2Int GetBaseResolutionToUse()
{
if (_dimensionsDriveMode == DriveMode.Auto)
{
return CalcAutoResolution();
}
else
{
return _resolution;
}
}
public Vector2Int GetScaledResolutionToUse()
{
Vector2 resolution = GetBaseResolutionToUse();
return Vector2Int.RoundToInt(resolution * _renderScale);
}
public float PixelsToUnits(float pixels)
{
return (1f / _pixelsPerUnit) * pixels;
}
public float UnitsToPixels(float units)
{
return _pixelsPerUnit * units;
}
#if UNITY_EDITOR
protected void OnValidate()
{
if (Application.isPlaying && _started)
{
EditorApplication.delayCall += () =>
{
UpdateCamera();
};
}
}
#endif
protected void Start()
{
this.BeginStart(ref _started);
this.AssertField(_canvas, nameof(_canvas));
this.EndStart(ref _started);
}
protected void OnEnable()
{
if (_started)
{
if (_listener == null)
{
_listener = _canvas.gameObject.AddComponent();
}
_listener.WhenRectTransformDimensionsChanged += WhenCanvasRectTransformDimensionsChanged;
UpdateCamera();
}
}
private void WhenCanvasRectTransformDimensionsChanged()
{
UpdateCamera();
}
protected void OnDisable()
{
if (_started)
{
if (_camera?.gameObject != null)
{
Destroy(_camera.gameObject);
}
if (_tex != null)
{
DestroyImmediate(_tex);
}
if (_listener != null)
{
_listener.WhenRectTransformDimensionsChanged -= WhenCanvasRectTransformDimensionsChanged;
}
}
}
protected void UpdateCamera()
{
if (!Application.isPlaying || !_started)
{
return;
}
Profiler.BeginSample("InterfaceRenderer.UpdateCamera");
try
{
if (_camera == null)
{
GameObject cameraObj = CreateChildObject("__Camera");
_camera = cameraObj.AddComponent();
_camera.orthographic = true;
_camera.nearClipPlane = -0.1f;
_camera.farClipPlane = 0.1f;
_camera.backgroundColor = new Color(0, 0, 0, 0);
_camera.clearFlags = CameraClearFlags.SolidColor;
}
UpdateRenderTexture();
UpdateOrthoSize();
UpdateCameraCullingMask();
}
finally
{
Profiler.EndSample();
}
}
protected void UpdateRenderTexture()
{
Profiler.BeginSample("InterfaceRenderer.UpdateRenderTexture");
try
{
Vector2Int resolutionToUse = GetScaledResolutionToUse();
if (_tex == null ||
_tex.width != resolutionToUse.x ||
_tex.height != resolutionToUse.y ||
_tex.autoGenerateMips != _generateMipMaps)
{
if (_tex != null)
{
_camera.targetTexture = null;
DestroyImmediate(_tex);
}
_tex = new RenderTexture(resolutionToUse.x, resolutionToUse.y, 24, RenderTextureFormat.ARGB32, RenderTextureReadWrite.sRGB);
_tex.filterMode = FilterMode.Bilinear;
_tex.autoGenerateMips = _generateMipMaps;
_camera.targetTexture = _tex;
OnUpdateRenderTexture(_tex);
}
}
finally
{
Profiler.EndSample();
}
}
private void UpdateOrthoSize()
{
if (_camera != null)
{
_camera.orthographicSize = PixelsToUnits(GetBaseResolutionToUse().y) * 0.5f;
}
}
private void UpdateCameraCullingMask()
{
if (_camera != null)
{
_camera.cullingMask = _renderingLayers.value;
}
}
protected GameObject CreateChildObject(string name)
{
GameObject obj = new GameObject(name);
obj.transform.SetParent(_canvas.transform);
obj.transform.localPosition = Vector3.zero;
obj.transform.localRotation = Quaternion.identity;
obj.transform.localScale = Vector3.one;
return obj;
}
public static class Properties
{
public static readonly string DimensionDriveMode = nameof(_dimensionsDriveMode);
public static readonly string Resolution = nameof(_resolution);
public static readonly string RenderScale = nameof(_renderScale);
public static readonly string PixelsPerUnit = nameof(_pixelsPerUnit);
public static readonly string RenderLayers = nameof(_renderingLayers);
public static readonly string GenerateMipMaps = nameof(_generateMipMaps);
public static readonly string Canvas = nameof(_canvas);
}
#region Inject
public void InjectAllCanvasRenderTexture(Canvas canvas,
int pixelsPerUnit,
int renderScale,
LayerMask renderingLayers,
bool generateMipMaps)
{
InjectCanvas(canvas);
InjectPixelsPerUnit(pixelsPerUnit);
InjectRenderScale(renderScale);
InjectRenderingLayers(renderingLayers);
InjectGenerateMipMaps(generateMipMaps);
}
public void InjectCanvas(Canvas canvas)
{
_canvas = canvas;
}
public void InjectPixelsPerUnit(int pixelsPerUnit)
{
_pixelsPerUnit = pixelsPerUnit;
}
public void InjectRenderScale(int renderScale)
{
_renderScale = renderScale;
}
public void InjectRenderingLayers(LayerMask renderingLayers)
{
_renderingLayers = renderingLayers;
}
public void InjectGenerateMipMaps(bool generateMipMaps)
{
_generateMipMaps = generateMipMaps;
}
#endregion
}
}