FViewport::FHitProxyMap Class Reference

#include <UnrealClient.h>

Inheritance diagram for FViewport::FHitProxyMap:

Public Member Functions
	FHitProxyMap ()
virtual ENGINE_API	~FHitProxyMap ()
void	Init (uint32 NewSizeX, uint32 NewSizeY)
void	Release ()
void	Invalidate ()
virtual void	AddHitProxy (HHitProxy *HitProxy) override
virtual FIntPoint	GetSizeXY () const override
virtual void	AddReferencedObjects (FReferenceCollector &Collector) override
virtual FString	GetReferencerName () const override
const FTextureRHIRef &	GetHitProxyTexture (void) const
const FTextureRHIRef &	GetHitProxyCPUTexture (void) const
Public Member Functions inherited from FRenderTarget
ENGINE_API	FRenderTarget ()
virtual ENGINE_API	~FRenderTarget ()
virtual ENGINE_API const FTextureRHIRef &	GetRenderTargetTexture () const
virtual ENGINE_API FUnorderedAccessViewRHIRef	GetRenderTargetUAV () const
virtual ENGINE_API FRDGTextureRef	GetRenderTargetTexture (FRDGBuilder &GraphBuilder) const
virtual ENGINE_API const FTextureRHIRef &	GetShaderResourceTexture () const
virtual ENGINE_API float	GetDisplayGamma () const
virtual EDisplayColorGamut	GetDisplayColorGamut () const
virtual EDisplayOutputFormat	GetDisplayOutputFormat () const
virtual bool	GetSceneHDREnabled () const
virtual void	ProcessToggleFreezeCommand ()
virtual bool	HasToggleFreezeCommand ()
virtual ENGINE_API bool	ReadPixels (TArray< FColor > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
ENGINE_API bool	ReadPixelsPtr (FColor *OutImageBytes, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
ENGINE_API bool	ReadFloat16Pixels (TArray< FFloat16Color > &OutImageData, ECubeFace CubeFace)
virtual ENGINE_API bool	ReadFloat16Pixels (TArray< FFloat16Color > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
virtual ENGINE_API bool	ReadLinearColorPixels (TArray< FLinearColor > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_MinMax, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
ENGINE_API bool	ReadLinearColorPixelsPtr (FLinearColor *OutImageBytes, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_MinMax, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
virtual FRHIGPUMask	GetGPUMask (FRHICommandListImmediate &RHICmdList) const
Public Member Functions inherited from FGCObject
	FGCObject ()
	FGCObject (const FGCObject &Other)
	FGCObject (FGCObject &&Other)
	FGCObject (EFlags Flags)
virtual	~FGCObject ()
FGCObject &	operator= (const FGCObject &)
FGCObject &	operator= (FGCObject &&)
COREUOBJECT_API void	RegisterGCObject ()
COREUOBJECT_API void	UnregisterGCObject ()
virtual bool	GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const

Additional Inherited Members
Public Types inherited from FGCObject
enum class	EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }
Static Public Member Functions inherited from FRenderTarget
static float	GetEngineDisplayGamma ()
Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void	StaticInit ()
Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer *	GGCObjectReferencer = nullptr
Protected Attributes inherited from FRenderTarget
FTextureRHIRef	RenderTargetTextureRHI

Detailed Description

A map from 2D coordinates to cached hit proxies.

Constructor & Destructor Documentation

FHitProxyMap()

FViewport::FHitProxyMap::FHitProxyMap

(

)

Constructor

~FHitProxyMap()

FViewport::FHitProxyMap::~FHitProxyMap ( )

virtual

Destructor

Member Function Documentation

AddHitProxy()

void FViewport::FHitProxyMap::AddHitProxy ( HHitProxy *  HitProxy )

overridevirtual

Called when a new hit proxy is rendered. The hit proxy consumer should keep a TRefCountPtr to the HitProxy to prevent it from being deleted before the rendered hit proxy map.

Implements FHitProxyConsumer.

AddReferencedObjects()

void FViewport::FHitProxyMap::AddReferencedObjects ( FReferenceCollector &  Collector )

overridevirtual

FGCObject interface

FGCObject: add UObject references to GC

Implements FGCObject.

GetHitProxyCPUTexture()

const FTextureRHIRef & FViewport::FHitProxyMap::GetHitProxyCPUTexture ( void  ) const

inline

GetHitProxyTexture()

const FTextureRHIRef & FViewport::FHitProxyMap::GetHitProxyTexture ( void  ) const

inline

GetReferencerName()

FString FViewport::FHitProxyMap::GetReferencerName ( ) const

overridevirtual

Overload this method to report a name for your referencer

Implements FGCObject.

GetSizeXY()

virtual FIntPoint FViewport::FHitProxyMap::GetSizeXY ( ) const

inlineoverridevirtual

Implements FRenderTarget.

Init()

void FViewport::FHitProxyMap::Init	(	uint32	NewSizeX,
		uint32	NewSizeY
	)

Initializes the hit proxy map with the given dimensions.

Invalidate()

void FViewport::FHitProxyMap::Invalidate

(

)

Invalidates the cached hit proxy map.

Release()

void FViewport::FHitProxyMap::Release

(

)

Releases the hit proxy resources.

---

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

• Engine/Source/Runtime/Engine/Public/UnrealClient.h
• Engine/Source/Runtime/Engine/Private/UnrealClient.cpp