FVectorFieldResource Class Reference

#include <VectorField.h>

Inheritance diagram for FVectorFieldResource:

Public Member Functions
	FVectorFieldResource ()
virtual void	ReleaseRHI () override
virtual void	Update (FRHICommandListImmediate &RHICmdList, float DeltaSeconds)
virtual void	ResetVectorField ()
uint32	AddRef () const
uint32	Release () 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 FRenderResource &	operator= (const FRenderResource &Other)
RENDERCORE_API FRenderResource &	operator= (FRenderResource &&Other)
virtual RENDERCORE_API	~FRenderResource ()
virtual void	InitRHI (FRHICommandListBase &RHICmdList)
virtual RENDERCORE_API void	InitResource (FRHICommandListBase &RHICmdList)
virtual RENDERCORE_API void	ReleaseResource ()
RENDERCORE_API void	UpdateRHI (FRHICommandListBase &RHICmdList)
virtual FString	GetFriendlyName () const
bool	IsInitialized () const
int32	GetListIndex () const
EInitPhase	GetInitPhase () const
void	SetOwnerName (FName InOwnerName)
FName	GetOwnerName () const
void	SetResourceName (FName InResourceName)
FName	GetResourceName () const

Public Attributes
FTextureRHIRef	VolumeTextureRHI
int32	SizeX
int32	SizeY
int32	SizeZ
float	Intensity
FBox	LocalBounds
Public Attributes inherited from FRenderResource
ERenderResourceState	ResourceState = ERenderResourceState::Default

Protected Member Functions
virtual	~FVectorFieldResource ()
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)

Protected Attributes
FThreadSafeCounter	NumRefs

Additional Inherited Members
Public Types inherited from FRenderResource
enum class	EInitPhase : uint8 { Pre , Default , MAX }
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)
Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBase &	GetImmediateCommandList ()

Detailed Description

Vector field resource.

Constructor & Destructor Documentation

FVectorFieldResource()

FVectorFieldResource::FVectorFieldResource

(

)

Default constructor.

~FVectorFieldResource()

FVectorFieldResource::~FVectorFieldResource ( )

protectedvirtual

Member Function Documentation

AddRef()

uint32 FVectorFieldResource::AddRef ( ) const

inline

Ref couting

Release()

uint32 FVectorFieldResource::Release ( ) const

inline

ReleaseRHI()

void FVectorFieldResource::ReleaseRHI ( )

overridevirtual

Release RHI resources.

Reimplemented from FRenderResource.

Reimplemented in FVectorFieldAnimatedResource.

ResetVectorField()

virtual void FVectorFieldResource::ResetVectorField ( )

inlinevirtual

Resets the vector field simulation.

Reimplemented in FVectorFieldAnimatedResource.

Update()

virtual void FVectorFieldResource::Update ( FRHICommandListImmediate &  RHICmdList, float  DeltaSeconds  )

inlinevirtual

Updates the vector field.

Parameters

DeltaSeconds

- Elapsed time since the last update.

Reimplemented in FVectorFieldAnimatedResource.

Member Data Documentation

Intensity

float FVectorFieldResource::Intensity

The amount by which to scale vectors in the field.

LocalBounds

FBox FVectorFieldResource::LocalBounds

Local space bounds of the vector field.

NumRefs

FThreadSafeCounter FVectorFieldResource::NumRefs

mutableprotected

Ref couting. Required becauce of how resources are shared between FVectorFieldInstance and UVectorField...

SizeX

int32 FVectorFieldResource::SizeX

Size of the vector field (X).

SizeY

int32 FVectorFieldResource::SizeY

Size of the vector field (Y).

SizeZ

int32 FVectorFieldResource::SizeZ

Size of the vector field (Z).

VolumeTextureRHI

FTextureRHIRef FVectorFieldResource::VolumeTextureRHI

The volume texture containing the vector field.

---

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

• Engine/Source/Runtime/Engine/Private/VectorField.h
• Engine/Source/Runtime/Engine/Private/VectorField.cpp