StereoRendering.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    StereoRendering.h: Abstract stereoscopic rendering interface
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "RenderGraphFwd.h"
 
class FSceneView;
class IStereoLayers;
class IStereoRenderTargetManager;
 
enum class EStereoscopicPass
{
    eSSP_FULL,
    eSSP_PRIMARY,
    eSSP_SECONDARY
};
 
enum EStereoscopicEye : int32
{
    eSSE_MONOSCOPIC = INDEX_NONE,
    eSSE_LEFT_EYE = 0,
    eSSE_RIGHT_EYE = 1,
    eSSE_LEFT_EYE_SIDE = 2,
    eSSE_RIGHT_EYE_SIDE = 3,
};
 
class IStereoRendering
{
public:
    virtual ~IStereoRendering() { }
 
    virtual bool IsStereoEnabled() const = 0;
 
    virtual bool IsStereoEnabledOnNextFrame() const { return IsStereoEnabled(); }
 
    virtual bool EnableStereo(bool stereo = true) = 0;
 
    virtual int32 GetDesiredNumberOfViews(bool bStereoRequested) const { return (bStereoRequested) ? 2 : 1; }
 
    virtual EStereoscopicPass GetViewPassForIndex(bool bStereoRequested, int32 ViewIndex) const
    {
        if (!bStereoRequested)
            return EStereoscopicPass::eSSP_FULL;
        else if (ViewIndex == 0)
            return EStereoscopicPass::eSSP_PRIMARY;
        else
            return EStereoscopicPass::eSSP_SECONDARY;
    }
 
    static bool IsStereoEyePass(EStereoscopicPass Pass)
    {
        return !(Pass == EStereoscopicPass::eSSP_FULL);
    }
 
    static ENGINE_API bool IsStereoEyeView(const FSceneView& View);
 
    static bool IsAPrimaryPass(EStereoscopicPass Pass)
    {
        return Pass == EStereoscopicPass::eSSP_FULL || Pass == EStereoscopicPass::eSSP_PRIMARY;
    }
 
    static ENGINE_API bool IsAPrimaryView(const FSceneView& View);
 
    static bool IsASecondaryPass(EStereoscopicPass Pass)
    {
        return Pass == EStereoscopicPass::eSSP_SECONDARY;
    }
 
    static ENGINE_API bool IsASecondaryView(const FSceneView& View);
 
    virtual uint32 GetLODViewIndex() const
    {
        return 0;
    }
 
    virtual bool IsStandaloneStereoOnlyDevice() const
    { 
        return false; 
    }
 
    virtual void AdjustViewRect(const int32 ViewIndex, int32& X, int32& Y, uint32& SizeX, uint32& SizeY) const = 0;
 
    virtual void SetFinalViewRect(class FRHICommandListImmediate& RHICmdList, const int32 ViewIndex, const FIntRect& FinalViewRect) {}
 
    virtual FVector2D GetTextSafeRegionBounds() const { return FVector2D(0.75f, 0.75f); }
 
    virtual void CalculateStereoViewOffset(const int32 ViewIndex, FRotator& ViewRotation, const float WorldToMeters, FVector& ViewLocation) = 0;
 
    virtual FMatrix GetStereoProjectionMatrix(const int32 ViewIndex) const = 0;
 
    virtual void InitCanvasFromView(class FSceneView* InView, class UCanvas* Canvas) = 0;
 
    // Renders texture into a backbuffer. Could be empty if no rendertarget texture is used, or if direct-rendering 
    // through RHI bridge is implemented. 
    UE_DEPRECATED(5.6, "Use the FRDGBuilder overload instead")
    virtual void RenderTexture_RenderThread(class FRHICommandListImmediate& RHICmdList, class FRHITexture* BackBuffer, class FRHITexture* SrcTexture, FVector2D WindowSize) const final {}
    virtual ENGINE_API void RenderTexture_RenderThread(class FRDGBuilder& GraphBuilder, FRDGTextureRef BackBuffer, FRDGTextureRef SrcTexture, FVector2f WindowSize) const;
 
    virtual IStereoRenderTargetManager* GetRenderTargetManager() { return nullptr; }
 
    virtual IStereoLayers* GetStereoLayers () { return nullptr; }
 
    
    virtual void StartFinalPostprocessSettings(struct FPostProcessSettings* StartPostProcessingSettings, const enum EStereoscopicPass StereoPassType, const int32 StereoViewIndex) {}
    virtual bool OverrideFinalPostprocessSettings(struct FPostProcessSettings* OverridePostProcessingSettings, const enum EStereoscopicPass StereoPassType, const int32 StereoViewIndex, float& BlendWeight) { return false; }
    virtual void EndFinalPostprocessSettings(struct FPostProcessSettings* FinalPostProcessingSettings, const enum EStereoscopicPass StereoPassType, const int32 StereoViewIndex) {}
 
    static ENGINE_API bool IsStartInVR();
};