1. Epic GamesDeveloper
  3. FRenderResource

FRenderResource

A rendering resource which is owned by the rendering thread.

API > API/Runtime > API/Runtime/RenderCore

A rendering resource which is owned by the rendering thread.

   
Name FRenderResource
Type class
Header File /Engine/Source/Runtime/RenderCore/Public/RenderResource.h
Include Path #include "RenderResource.h"

Syntax

class FRenderResource

Derived Classes

FRenderResource derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Misc copy/assignment RenderResource.h  
  RenderResource.h  
Constructor when we know what feature level this resource should support RenderResource.h  
Default constructor. RenderResource.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FRenderResource()

 Destructor used to catch unreleased resources. RenderResource.h  

Enums

Public

Name Remarks
EInitPhase Controls initialization order of render resources.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ResourceState ERenderResourceState   RenderResource.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
FeatureLevel TEnumAsByte< ERHIFeatureLevel::Type >   RenderResource.h  
InitPhase EInitPhase   RenderResource.h  
ListIndex int32   RenderResource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FString GetFriendlyName()

   RenderResource.h  

EInitPhase GetInitPhase()

   RenderResource.h  

int32 GetListIndex()

   RenderResource.h  

FName GetOwnerName()

   RenderResource.h  

FName GetResourceName()

   RenderResource.h  

virtual void InitResource ( FRHICommandListBase& RHICmdList
)

 Initializes the resource. This is only called by the rendering thread. RenderResource.h  

virtual void InitRHI ( FRHICommandListBase& RHICmdList
)

 Initializes the RHI resources used by this resource. RenderResource.h  

bool IsInitialized()

 Accessors. RenderResource.h  

virtual void ReleaseResource()

 Prepares the resource for deletion. This is only called by the rendering thread. RenderResource.h  

virtual void ReleaseRHI ()

 Releases the RHI resources used by this resource. RenderResource.h  

void SetOwnerName ( FName InOwnerName
)

 SetOwnerName should be called before BeginInitResource for the owner name to be successfully tracked. RenderResource.h  

void SetResourceName ( FName InResourceName
)

   RenderResource.h  

void UpdateRHI ( FRHICommandListBase& RHICmdList
)

 If the resource's RHI resources have been initialized, then release and reinitialize it. RenderResource.h  

Protected

Name Remarks Include Path Unreal Specifiers

FBufferRHIRef CreateRHIBuffer ( FRHICommandListBase& RHICmdList,
T& InOutResourceObject,
uint32 ResourceCount,
EBufferUsageFlags InBufferUsageFlags,
const TCHAR* InDebugName
)

 Helper for submitting a resource array to RHI and freeing eligible CPU memory. RenderResource.h  

const FStaticFeatureLevel GetFeatureLevel()

   RenderResource.h  

bool HasValidFeatureLevel()

   RenderResource.h  

void SetFeatureLevel ( const FStaticFeatureLevel InFeatureLevel
)

 This is used during mobile editor preview refactor, this will eventually be replaced with a parameter to InitRHI() etc.. RenderResource.h  

void SetInitPhase ( EInitPhase InInitPhase
)

   RenderResource.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ChangeFeatureLevel ( ERHIFeatureLevel::Type NewFeatureLevel
)

 Reinitializes render resources at a new feature level. RenderResource.h  

static FBufferRHIRef CreateRHIBufferInternal ( FRHICommandListBase& RHICmdList,
const TCHAR* InDebugName,
const FName& InOwnerName,
uint32 ResourceCount,
EBufferUsageFlags InBufferUsageFlags,
FResourceArrayInterface* ResourceArray,
bool bWithoutNativeResource
)

   RenderResource.h  

static FRHICommandListBase & GetImmediateCommandList()

   RenderResource.h  

static void InitPreRHIResources ()

 Initialize all resources initialized before the RHI was initialized. RenderResource.h  

static void ReleaseRHIForAllResources()

 Release all render resources that are currently initialized. RenderResource.h  

static FName SetScopeName ( FName Name
)

 Set the scoped (thread local) resource name, used for error reporting RenderResource.h  

static bool ShouldFreeResourceObject ( void* ResourceObject,
FResourceArrayInterface* ResourceArray
)

   RenderResource.h  

Operators

Name Remarks Include Path Unreal Specifiers
  RenderResource.h  
  RenderResource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page