UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWebBrowserTextureResource Class Reference

#include <WebBrowserTextureResource.h>

+ Inheritance diagram for FWebBrowserTextureResource:

Classes

struct  FRenderParams
 

Public Member Functions

 FWebBrowserTextureResource (UWebBrowserTexture &InOwner, FIntPoint &InOwnerDim, SIZE_T &InOwnerSize)
 
virtual ~FWebBrowserTextureResource ()
 
void Render (FRHICommandList &RHICmdList, const FRenderParams &Params)
 
virtual FIntPoint GetSizeXY () const override
 
virtual FString GetFriendlyName () const override
 
virtual uint32 GetSizeX () const override
 
virtual uint32 GetSizeY () const override
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
- Public Member Functions inherited from FRenderTarget
ENGINE_API FRenderTarget ()
 
virtual ENGINE_API ~FRenderTarget ()
 
virtual ENGINE_API const FTextureRHIRefGetRenderTargetTexture () const
 
virtual ENGINE_API FUnorderedAccessViewRHIRef GetRenderTargetUAV () const
 
virtual ENGINE_API FRDGTextureRef GetRenderTargetTexture (FRDGBuilder &GraphBuilder) const
 
virtual ENGINE_API const FTextureRHIRefGetShaderResourceTexture () 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 FTextureResource
 FTextureResource ()
 
virtual ~FTextureResource ()
 
virtual bool IsProxy () const
 
virtual FTexture2DResourceGetTexture2DResource ()
 
virtual FTexture3DResourceGetTexture3DResource ()
 
virtual FTexture2DArrayResourceGetTexture2DArrayResource ()
 
virtual FStreamableTextureResourceGetStreamableTextureResource ()
 
virtual FVirtualTexture2DResourceGetVirtualTexture2DResource ()
 
virtual const FTexture2DResourceGetTexture2DResource () const
 
virtual const FTexture3DResourceGetTexture3DResource () const
 
virtual const FTexture2DArrayResourceGetTexture2DArrayResource () const
 
virtual const FStreamableTextureResourceGetStreamableTextureResource () const
 
virtual const FVirtualTexture2DResourceGetVirtualTexture2DResource () const
 
int32 GetCurrentMipCount () const
 
bool IsTextureRHIPartiallyResident () const
 
FRHITextureGetTexture2DRHI () const
 
FRHITextureGetTexture3DRHI () const
 
FRHITextureGetTexture2DArrayRHI () const
 
void SetTextureReference (FRHITextureReference *TextureReference)
 
FRHITextureReferenceGetTextureReference () const
 
- Public Member Functions inherited from FTexture
RENDERCORE_API FTexture ()
 
virtual RENDERCORE_API ~FTexture ()
 
RENDERCORE_API FTexture (const FTexture &)
 
RENDERCORE_API FTexture (FTexture &&)
 
RENDERCORE_API FTextureoperator= (const FTexture &Other)
 
RENDERCORE_API FTextureoperator= (FTexture &&Other)
 
const FTextureRHIRefGetTextureRHI ()
 
virtual RENDERCORE_API uint32 GetSizeZ () const
 
- Public Member Functions inherited from FRenderResource
RENDERCORE_API FRenderResource ()
 
RENDERCORE_API FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
 
RENDERCORE_API FRenderResource (const FRenderResource &)
 
RENDERCORE_API FRenderResource (FRenderResource &&)
 
RENDERCORE_API FRenderResourceoperator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResourceoperator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
virtual RENDERCORE_API void InitResource (FRHICommandListBase &RHICmdList)
 
virtual RENDERCORE_API void ReleaseResource ()
 
RENDERCORE_API void UpdateRHI (FRHICommandListBase &RHICmdList)
 
bool IsInitialized () const
 
int32 GetListIndex () const
 
EInitPhase GetInitPhase () const
 
void SetOwnerName (FName InOwnerName)
 
FName GetOwnerName () const
 
void SetResourceName (FName InResourceName)
 
FName GetResourceName () const
 

Protected Member Functions

void ClearTexture (FRHICommandList &RHICmdList, const FLinearColor &ClearColor)
 
void CopySample (FRHICommandListBase &RHICmdList, const TSharedPtr< FWebBrowserTextureSample, ESPMode::ThreadSafe > &Sample, const FLinearColor &ClearColor)
 
void UpdateResourceSize ()
 
void UpdateTextureReference (FRHICommandListBase &RHICmdList, FRHITexture *NewTexture)
 
- Protected Member Functions inherited from FRenderResource
void SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
 
const FStaticFeatureLevel GetFeatureLevel () const
 
bool HasValidFeatureLevel () const
 
template<typename T >
FBufferRHIRef CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
 
void SetInitPhase (EInitPhase InInitPhase)
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- Static Public Member Functions inherited from FRenderTarget
static float GetEngineDisplayGamma ()
 
- Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void ReleaseRHIForAllResources ()
 
static RENDERCORE_API void InitPreRHIResources ()
 
static RENDERCORE_API void ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
 
static RENDERCORE_API FName SetScopeName (FName Name)
 
- Public Attributes inherited from FTexture
FTextureRHIRef TextureRHI
 
FSamplerStateRHIRef SamplerStateRHI
 
FSamplerStateRHIRef DeferredPassSamplerStateRHI
 
double LastRenderTime = -FLT_MAX
 
FMipBiasFade MipBiasFade
 
bool bGreyScaleFormat = false
 
bool bIgnoreGammaConversions = false
 
bool bSRGB = false
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 
- Static Protected Member Functions inherited from FTexture
static RENDERCORE_API FRHISamplerStateGetOrCreateSamplerState (const FSamplerStateInitializerRHI &Initializer)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 
- Protected Attributes inherited from FRenderTarget
FTextureRHIRef RenderTargetTextureRHI
 
- Protected Attributes inherited from FTextureResource
FTextureReferenceRHIRef TextureReferenceRHI
 

Detailed Description

Texture resource type for webbrowser textures.

Constructor & Destructor Documentation

◆ FWebBrowserTextureResource()

FWebBrowserTextureResource::FWebBrowserTextureResource ( UWebBrowserTexture InOwner,
FIntPoint InOwnerDim,
SIZE_T InOwnerSize 
)

Creates and initializes a new instance.

Parameters
InOwnerThe Movie texture object to create a resource for (must not be nullptr).
InOwnerDimThe initial width and height of the texture.
InOwnerSizeThe initial memory allocated to the texture.

◆ ~FWebBrowserTextureResource()

virtual FWebBrowserTextureResource::~FWebBrowserTextureResource ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ ClearTexture()

void FWebBrowserTextureResource::ClearTexture ( FRHICommandList RHICmdList,
const FLinearColor ClearColor 
)
protected

Clear the texture using the given clear color.

Parameters
ClearColorThe clear color to use.

◆ CopySample()

void FWebBrowserTextureResource::CopySample ( FRHICommandListBase RHICmdList,
const TSharedPtr< FWebBrowserTextureSample, ESPMode::ThreadSafe > &  Sample,
const FLinearColor ClearColor 
)
protected

Render the given texture sample by using it as or copying it to the render target.

Parameters
SampleThe texture sample to copy.
ClearColorThe clear color to use for the output texture.
See also
ConvertSample

◆ GetFriendlyName()

FString FWebBrowserTextureResource::GetFriendlyName ( ) const
overridevirtual
Returns
The resource's friendly name. Typically a UObject name.

Reimplemented from FTexture.

◆ GetSizeX()

uint32 FWebBrowserTextureResource::GetSizeX ( ) const
overridevirtual

Returns the width of the texture in pixels.

Reimplemented from FTexture.

◆ GetSizeXY()

FIntPoint FWebBrowserTextureResource::GetSizeXY ( ) const
overridevirtual

Implements FRenderTarget.

◆ GetSizeY()

uint32 FWebBrowserTextureResource::GetSizeY ( ) const
overridevirtual

Returns the height of the texture in pixels.

Reimplemented from FTexture.

◆ InitRHI()

void FWebBrowserTextureResource::InitRHI ( FRHICommandListBase RHICmdList)
overridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

◆ ReleaseRHI()

void FWebBrowserTextureResource::ReleaseRHI ( )
overridevirtual

Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FTexture.

◆ Render()

void FWebBrowserTextureResource::Render ( FRHICommandList RHICmdList,
const FRenderParams Params 
)

Render the texture resource.

This method is called on the render thread by the WebBrowserTexture that owns this texture resource to clear or redraw the resource using the given parameters.

Parameters
ParamsRender parameters.

◆ UpdateResourceSize()

void FWebBrowserTextureResource::UpdateResourceSize ( )
protected

Calculates the current resource size and notifies the owner texture.

◆ UpdateTextureReference()

void FWebBrowserTextureResource::UpdateTextureReference ( FRHICommandListBase RHICmdList,
FRHITexture NewTexture 
)
protected

Set the owner's texture reference to the given texture.

Parameters
NewTextureThe texture to set.

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