FRHIViewport Class Reference

#include <RHIResources.h>

Inheritance diagram for FRHIViewport:

Public Member Functions
	FRHIViewport ()
virtual void *	GetNativeSwapChain () const
virtual void *	GetNativeBackBufferTexture () const
virtual void *	GetNativeBackBufferRT () const
virtual void *	GetNativeWindow (void **AddParam=nullptr) const
virtual void	SetCustomPresent (class FRHICustomPresent *)
virtual class FRHICustomPresent *	GetCustomPresent () const
virtual FRHITexture *	GetOptionalSDRBackBuffer (FRHITexture *BackBuffer) const
virtual void	Tick (float DeltaTime)
virtual void	WaitForFrameEventCompletion ()
virtual void	IssueFrameEvent ()
Public Member Functions inherited from FRHIResource
RHI_API	FRHIResource (ERHIResourceType InResourceType)
uint32	AddRef () const
uint32	Release () const
uint32	GetRefCount () const
bool	IsValid () const
void	DisableLifetimeExtension ()
ERHIResourceType	GetType () const
FName	GetOwnerName () const
void	SetOwnerName (FName InOwnerName)

Additional Inherited Members
Protected Member Functions inherited from FRHIResource
virtual RHI_API	~FRHIResource ()

Constructor & Destructor Documentation

FRHIViewport()

FRHIViewport::FRHIViewport ( )

inline

Member Function Documentation

GetCustomPresent()

virtual class FRHICustomPresent * FRHIViewport::GetCustomPresent ( ) const

inlinevirtual

Returns currently set custom present handler.

Reimplemented in FOpenGLViewport, FD3D11Viewport, FD3D12Viewport, and FVulkanViewport.

GetNativeBackBufferRT()

virtual void * FRHIViewport::GetNativeBackBufferRT ( ) const

inlinevirtual

Returns access to the platform-specific native resource pointer to a backbuffer rendertarget. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns

The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

Reimplemented in FMetalViewport, FD3D12Viewport, and FD3D11Viewport.

GetNativeBackBufferTexture()

virtual void * FRHIViewport::GetNativeBackBufferTexture ( ) const

inlinevirtual

Returns access to the platform-specific native resource pointer to a backbuffer texture. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns

The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

Reimplemented in FMetalViewport, FD3D12Viewport, and FD3D11Viewport.

GetNativeSwapChain()

virtual void * FRHIViewport::GetNativeSwapChain ( ) const

inlinevirtual

Returns access to the platform-specific native resource pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns

The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

Reimplemented in FD3D12Viewport, and FD3D11Viewport.

GetNativeWindow()

virtual void * FRHIViewport::GetNativeWindow ( void **  AddParam = nullptr ) const

inlinevirtual

Returns access to the platform-specific native window. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns

The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason. AddParam could represent any additional platform-specific data (could be null).

Reimplemented in FOpenGLViewport, FD3D12Viewport, and FD3D11Viewport.

GetOptionalSDRBackBuffer()

virtual FRHITexture * FRHIViewport::GetOptionalSDRBackBuffer ( FRHITexture *  BackBuffer ) const

inlinevirtual

IssueFrameEvent()

virtual void FRHIViewport::IssueFrameEvent ( )

inlinevirtual

Reimplemented in FD3D12Viewport, FOpenGLViewport, FVulkanViewport, and FD3D11Viewport.

SetCustomPresent()

virtual void FRHIViewport::SetCustomPresent ( class FRHICustomPresent *  )

inlinevirtual

Sets custom Present handler on the viewport

Reimplemented in FD3D12Viewport, FOpenGLViewport, FD3D11Viewport, and FVulkanViewport.

Tick()

virtual void FRHIViewport::Tick ( float  DeltaTime )

inlinevirtual

Ticks the viewport on the Game thread

Reimplemented in FVulkanViewport.

WaitForFrameEventCompletion()

virtual void FRHIViewport::WaitForFrameEventCompletion ( )

inlinevirtual

Reimplemented in FD3D12Viewport, FOpenGLViewport, FVulkanViewport, and FD3D11Viewport.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/RHI/Public/RHIResources.h