1. Epic GamesDeveloper
  3. IStereoRendering

IStereoRendering

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/StereoRendering.h
Include #include "StereoRendering.h"

Syntax

class IStereoRendering

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

AdjustViewRect ( const int32 ViewIndex,
int32& X,
int32& Y,
uint32& SizeX,
uint32& SizeY
)

 Adjusts the viewport rectangle for stereo, based on which eye pass is being rendered.
Public function void

CalculateStereoViewOffset ( const int32 ViewIndex,
FRotator& ViewRotation,
const float WorldToMeters,
FVector& ViewLocation
)

 Calculates the offset for the camera position, given the specified position, rotation, and world scale Specifying eSSE_MONOSCOPIC for the view index returns a center offset behind the stereo views
Public function bool

EnableStereo ( bool stereo
)

 Switches stereo rendering on / off. Returns current state of stereo.
Public function Virtual void

EndFinalPostprocessSettings ( FPostProcessSettings* FinalPostProcessingSettings,
const enum EStereoscopicPass StereoPassType,
const int32 StereoViewIndex
)

  
Public function Virtual Const int32

GetDesiredNumberOfViews ( bool bStereoRequested
)

 Returns the desired number of views, so that devices that require additional views can allocate them.
Public function Virtual Const uint32 Return the index of the view that is used for selecting LODs
Public function Virtual IStereoRenderTargetManager * Returns currently active render target manager.
Public function Virtual IStereoLayers * Returns an IStereoLayers implementation, if one is present
Public function Const FMatrix

GetStereoProjectionMatrix ( const int32 ViewIndex
)

 Gets a projection matrix for the device, given the specified view index Specifying eSSE_MONOSCOPIC for the view index returns a center projection matrix encompassing all views
Public function Virtual Const FVector2D Gets the percentage bounds of the safe region to draw in.
Public function Virtual Const EStereoscopicPass

GetViewPassForIndex ( bool bStereoRequested,
int32 ViewIndex
)

 For the specified view index in the view family, assign a stereoscopic pass type based on the extension's usage
Public function void

InitCanvasFromView ( FSceneView* InView,
UCanvas* Canvas
)

 Sets view-specific params (such as view projection matrix) for the canvas.
Public function Static bool

IsAPrimaryPass ( EStereoscopicPass Pass
)

 Static helper.
Public function Static bool

IsAPrimaryView ( const FSceneView& View
)

 Static helper. Return true if primary view
Public function Static bool

IsASecondaryPass ( EStereoscopicPass Pass
)

 Static helper.
Public function Static bool

IsASecondaryView ( const FSceneView& View
)

 Static helper. Return true if secondary view
Public function Virtual Const bool True when a device has only stereo display (like a self contained mobile vr headset).
Public function Static bool Static helper.
Public function Const bool Whether or not stereo rendering is on this frame.
Public function Virtual Const bool Whether or not stereo rendering is on on next frame.
Public function Static bool

IsStereoEyePass ( EStereoscopicPass Pass
)

 Static helper. Return true if this pass is for a stereo eye view
Public function Static bool

IsStereoEyeView ( const FSceneView& View
)

 Static helper. Return true if this is a stereoscopic view
Public function Virtual bool

OverrideFinalPostprocessSettings ( FPostProcessSettings* OverridePostProcessingSettings,
const enum EStereoscopicPass StereoPassType,
const int32 StereoViewIndex,
float& BlendWeight
)

  
Public function Virtual Const void

RenderTexture_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture* BackBuffer,
FRHITexture* SrcTexture,
FVector2D WindowSize
)

 Renders texture into a backbuffer.
Public function Virtual void

SetFinalViewRect ( FRHICommandListImmediate& RHICmdList,
const int32 ViewIndex,
const FIntRect& FinalViewRect
)

 Provides the final view rect that the renderer will render into.
Public function Virtual void

StartFinalPostprocessSettings ( FPostProcessSettings* StartPostProcessingSettings,
const enum EStereoscopicPass StereoPassType,
const int32 StereoViewIndex
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page