UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FMetalViewport Class Reference

#include <MetalViewport.h>

+ Inheritance diagram for FMetalViewport:

Public Member Functions

 FMetalViewport (FMetalDevice &InDevice, void *WindowHandle, uint32 InSizeX, uint32 InSizeY, bool bInIsFullscreen, EPixelFormat InFormat)
 
 ~FMetalViewport ()
 
void Resize (uint32 InSizeX, uint32 InSizeY, bool bInIsFullscreen, EPixelFormat Format)
 
TRefCountPtr< FMetalSurface > GetBackBuffer (EMetalViewportAccessFlag Accessor) const
 
CA::MetalDrawable * GetDrawable (EMetalViewportAccessFlag Accessor)
 
MTL::Texture * GetDrawableTexture (EMetalViewportAccessFlag Accessor)
 
MTL::Texture * GetCurrentTexture (EMetalViewportAccessFlag Accessor)
 
void ReleaseDrawable (void)
 
virtual void * GetNativeBackBufferTexture () const override
 
virtual void * GetNativeBackBufferRT () const override
 
void Present (FMetalCommandQueue &CommandQueue, bool bLockToVsync)
 
void Swap ()
 
- Public Member Functions inherited from FRHIViewport
 FRHIViewport ()
 
virtual void * GetNativeSwapChain () 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

◆ FMetalViewport()

FMetalViewport::FMetalViewport ( FMetalDevice &  InDevice,
void *  WindowHandle,
uint32  InSizeX,
uint32  InSizeY,
bool  bInIsFullscreen,
EPixelFormat  InFormat 
)

◆ ~FMetalViewport()

FMetalViewport::~FMetalViewport ( )

Member Function Documentation

◆ GetBackBuffer()

TRefCountPtr< FMetalSurface > FMetalViewport::GetBackBuffer ( EMetalViewportAccessFlag  Accessor) const

◆ GetCurrentTexture()

MTL::Texture * FMetalViewport::GetCurrentTexture ( EMetalViewportAccessFlag  Accessor)

◆ GetDrawable()

CA::MetalDrawable * FMetalViewport::GetDrawable ( EMetalViewportAccessFlag  Accessor)

◆ GetDrawableTexture()

MTL::Texture * FMetalViewport::GetDrawableTexture ( EMetalViewportAccessFlag  Accessor)

◆ GetNativeBackBufferRT()

virtual void * FMetalViewport::GetNativeBackBufferRT ( ) const
inlineoverridevirtual

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 from FRHIViewport.

◆ GetNativeBackBufferTexture()

virtual void * FMetalViewport::GetNativeBackBufferTexture ( ) const
inlineoverridevirtual

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 from FRHIViewport.

◆ Present()

void FMetalViewport::Present ( FMetalCommandQueue &  CommandQueue,
bool  bLockToVsync 
)

◆ ReleaseDrawable()

void FMetalViewport::ReleaseDrawable ( void  )

◆ Resize()

void FMetalViewport::Resize ( uint32  InSizeX,
uint32  InSizeY,
bool  bInIsFullscreen,
EPixelFormat  Format 
)

◆ Swap()

void FMetalViewport::Swap ( )
The documentation for this class was generated from the following files: