Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > IStereoRendering

Light Theme

Dark Theme

IStereoRendering

Windows

MacOS

Linux

Inheritance Hierarchy

IStereoRendering

	FHeadMountedDisplayBase
	IDisplayClusterRenderDevice

References

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

Syntax

class IStereoRendering

Destructors

	Name	Description
	~IStereoRendering()

Functions

	Name	Description
void	AdjustViewRect ( enum EStereoscopicPass StereoPass, int32& X, int32& Y, uint32& SizeX, uint32& SizeY )	Adjusts the viewport rectangle for stereo, based on which eye pass is being rendered.
void	CalculateStereoViewOffset ( const enum EStereoscopicPass Stereo..., FRotator& ViewRotation, const float WorldToMeters, FVector& ViewLocation )	Calculates the offset for the camera position, given the specified position, rotation, and world scale
uint32	DeviceGetLODViewIndex()	Return the index of the view that is used for selecting LODs
bool	DeviceIsAnAdditionalPass ( EStereoscopicPass Pass )	Return true for additional eyes past the first two (a plugin could implement additional 'eyes').
bool	DeviceIsAnAdditionalView ( const FSceneView& View )	Return true if additional view
bool	DeviceIsAPrimaryPass ( EStereoscopicPass Pass )	Return true if this pass is for a view we do all the work for (ie this view can't borrow from another)
bool	DeviceIsAPrimaryView ( const FSceneView& View )	Return true if primary view
bool	DeviceIsASecondaryPass ( EStereoscopicPass Pass )	Return true if this pass is for a view for which we share some work done for eSSP_LEFT_EYE (ie borrow some intermediate state from that eye)
bool	DeviceIsASecondaryView ( const FSceneView& View )	Return true if secondary view
bool	DeviceIsStereoEyePass ( EStereoscopicPass Pass )	Return true if this pass is for a stereo eye view
bool	DeviceIsStereoEyeView ( const FSceneView& View )	Return true if this is a stereoscopic view
bool	EnableStereo ( bool stereo )	Switches stereo rendering on / off. Returns current state of stereo.
void	EndFinalPostprocessSettings ( FPostProcessSettings* FinalPos..., const enum EStereoscopicPass Stereo... )
int32	GetDesiredNumberOfViews ( bool bStereoRequested )	Returns the desired number of views, so that devices that require additional views can allocate them.
uint32	GetLODViewIndex()	Static helper. Passes request to the current stereo device
IStereoRende...	GetRenderTargetManager()	Returns currently active render target manager.
IStereoLayer...	GetStereoLayers()	Returns an IStereoLayers implementation, if one is present
FMatrix	GetStereoProjectionMatrix ( const enum EStereoscopicPass Stereo... )	Gets a projection matrix for the device, given the specified eye setup
FVector2D	GetTextSafeRegionBounds()	Gets the percentage bounds of the safe region to draw in.
uint32	GetViewIndexForPass ( EStereoscopicPass StereoPassType )	For the specified stereoscopic pass type, assign a view index based on the extension's sorting
EStereoscopi...	GetViewPassForIndex ( bool bStereoRequested, uint32 ViewIndex )	For the specified view index in the view family, assign a stereoscopic pass type based on the extension's usage
void	InitCanvasFromView ( FSceneView* InView, UCanvas* Canvas )	Sets view-specific params (such as view projection matrix) for the canvas.
bool	IsAnAdditionalPass ( EStereoscopicPass Pass )	Static helper. Passes request to the current stereo device
bool	IsAnAdditionalView ( const FSceneView& View )	Static helper. Passes request to the current stereo device
bool	IsAPrimaryPass ( EStereoscopicPass Pass )	Static helper. Passes request to the current stereo device
bool	IsAPrimaryView ( const FSceneView& View )	Static helper. Passes request to the current stereo device
bool	IsASecondaryPass ( EStereoscopicPass Pass )	Static helper. Passes request to the current stereo device
bool	IsASecondaryView ( const FSceneView& View )	Static helper. Passes request to the current stereo device
bool	IsStereoEnabled()	Whether or not stereo rendering is on this frame.
bool	IsStereoEnabledOnNextFrame()	Whether or not stereo rendering is on on next frame.
bool	IsStereoEyePass ( EStereoscopicPass Pass )	Static helper. Passes request to the current stereo device
bool	IsStereoEyeView ( const FSceneView& View )	Static helper. Passes request to the current stereo device
bool	OverrideFinalPostprocessSettings ( FPostProcessSettings* Override..., const enum EStereoscopicPass Stereo..., float& BlendWeight )
void	RenderTexture_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* BackBuffer, FRHITexture2D* SrcTexture, FVector2D WindowSize )	Renders texture into a backbuffer.
void	SetFinalViewRect ( FRHICommandListImmediate& RHICmdLi..., const enum EStereoscopicPass Stereo..., const FIntRect& FinalViewRect )	Provides the final view rect that the renderer will render into.
void	StartFinalPostprocessSettings ( FPostProcessSettings* StartPos..., const enum EStereoscopicPass Stereo... )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss