data/Assets/NorthStar/Scripts/Player/ScreenFader.cs

// Copyright (c) Meta Platforms, Inc. and affiliates.
using DG.Tweening;
using Meta.XR.Samples;
using UnityEngine;
using UnityEngine.Rendering;

namespace NorthStar
{
    /// <summary>
    /// Used to gradually fade the screen in and out when required by game logic and events
    /// </summary>
    [MetaCodeSample("NorthStar")]
    public class ScreenFader : MonoBehaviour
    {
        [SerializeField] private Volume m_ppVolume;
        public float HeadFadeValue;
        public float TeleportFadeValue;
        public float TimedFadeValue;

        private void OnEnable()
        {
            Instance = this;
        }

        private void Update()
        {
            m_ppVolume.weight = Mathf.Clamp01(HeadFadeValue + TeleportFadeValue + TimedFadeValue);
        }

        public Tween DoFadeOut(float duration, float fade = 1.0f)
        {
            return DOTween.To(() => TimedFadeValue, x => TimedFadeValue = x, fade, duration);
        }

        public void DoFadeOutNoReturn(float duration) => DoFadeOut(duration);


        public static ScreenFader Instance;
    }
}