FWebBrowserTextureSample Class Reference

#include <WebBrowserTextureSample.h>

Inheritance diagram for FWebBrowserTextureSample:

Public Member Functions
	FWebBrowserTextureSample ()
virtual	~FWebBrowserTextureSample ()
void *	GetMutableBuffer ()
bool	Initialize (const FIntPoint &InDim)
void	InitializeBuffer (void *InBuffer, bool Copy)
int32	InitializeBufferForCopy ()
FRHITexture *	InitializeTexture (FRHICommandListBase &RHICmdList)
void	SetScaleRotationOffset (FVector4 &InScaleRotation, FVector4 &InOffset)
virtual const void *	GetBuffer ()
virtual FIntPoint	GetDim () const
virtual uint32	GetStride () const
virtual FLinearColor	GetScaleRotation () const
virtual FLinearColor	GetOffset () const
Public Member Functions inherited from IMediaPoolable
virtual void	InitializePoolable ()
virtual void	ShutdownPoolable ()
virtual bool	IsReadyForReuse ()
virtual	~IMediaPoolable ()

Detailed Description

Texture sample generated by the WebBrowser.

Constructor & Destructor Documentation

FWebBrowserTextureSample()

FWebBrowserTextureSample::FWebBrowserTextureSample ( )

inline

Default constructor.

~FWebBrowserTextureSample()

virtual FWebBrowserTextureSample::~FWebBrowserTextureSample ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

GetBuffer()

virtual const void * FWebBrowserTextureSample::GetBuffer ( )

inlinevirtual

GetDim()

virtual FIntPoint FWebBrowserTextureSample::GetDim ( ) const

inlinevirtual

GetMutableBuffer()

void * FWebBrowserTextureSample::GetMutableBuffer ( )

inline

Get a writable pointer to the sample buffer.

Returns

Sample buffer.

GetOffset()

virtual FLinearColor FWebBrowserTextureSample::GetOffset ( ) const

inlinevirtual

GetScaleRotation()

virtual FLinearColor FWebBrowserTextureSample::GetScaleRotation ( ) const

inlinevirtual

GetStride()

virtual uint32 FWebBrowserTextureSample::GetStride ( ) const

inlinevirtual

Initialize()

bool FWebBrowserTextureSample::Initialize ( const FIntPoint &  InDim )

inline

Initialize the sample.

Parameters

InDim	The sample buffer's width and height (in pixels).
InDuration	The duration for which the sample is valid.

Returns

true on success, false otherwise.

InitializeBuffer()

void FWebBrowserTextureSample::InitializeBuffer ( void *  InBuffer, bool  Copy  )

inline

Initialize the sample with a memory buffer.

Parameters

InBuffer	The buffer containing the sample data.
Copy	Whether the buffer should be copied (true) or referenced (false).

See also

InitializeTexture

InitializeBufferForCopy()

int32 FWebBrowserTextureSample::InitializeBufferForCopy ( )

inline

Initialize the sample for copy externally.

Returns

The size of the buffer

See also

InitializeTexture

InitializeTexture()

FRHITexture * FWebBrowserTextureSample::InitializeTexture ( FRHICommandListBase &  RHICmdList )

inline

Initialize the sample with a texture resource.

Parameters

RHICmdList

the command list used to create the texture.

Returns

The texture resource object that will hold the sample data.

Note

This method must be called on the render thread.

See also

InitializeBuffer

SetScaleRotationOffset()

void FWebBrowserTextureSample::SetScaleRotationOffset ( FVector4 &  InScaleRotation, FVector4 &  InOffset  )

inline

Set the sample Scale, Rotation, Offset.

Parameters

InScaleRotation	The sample scale and rotation transform (2x2).
InOffset	The sample offset.

---

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

• Engine/Source/Runtime/WebBrowserTexture/Public/WebBrowserTextureSample.h