UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RenderResource.h File Reference
#include "RHIFwd.h"
#include "RHIShaderPlatform.h"
#include "RHIFeatureLevel.h"
#include "RenderTimer.h"
#include "CoreGlobals.h"

Go to the source code of this file.

Classes

class  FRenderResource
 
struct  FMipFadeSettings
 
struct  FMipBiasFade
 
class  FTexture
 
class  FTextureWithSRV
 
class  FTextureReference
 
class  FVertexBuffer
 
class  FVertexBufferWithSRV
 
class  FIndexBuffer
 
class  FBufferWithRDG
 
class  TGlobalResource< ResourceType, InInitPhase >
 
struct  FRenderResourceNameScope
 

Enumerations

enum class  ERenderResourceState : uint8 { Default , BatchReleased , Deleted }
 
enum class  ERayTracingMode : uint8 { Disabled , Enabled , Dynamic }
 
enum  EMipFadeSettings { MipFade_Normal = 0 , MipFade_Slow , MipFade_NumSettings }
 

Functions

RENDERCORE_API void BeginInitResource (FRenderResource *Resource, FRenderCommandPipe *RenderCommandPipe=nullptr)
 
void BeginInitResource (FName OwnerName, FRenderResource *Resource, FRenderCommandPipe *RenderCommandPipe=nullptr)
 
RENDERCORE_API void BeginUpdateResourceRHI (FRenderResource *Resource, FRenderCommandPipe *RenderCommandPipe=nullptr)
 
RENDERCORE_API void BeginReleaseResource (FRenderResource *Resource, FRenderCommandPipe *RenderCommandPipe=nullptr)
 
RENDERCORE_API void StartBatchedRelease ()
 
RENDERCORE_API void EndBatchedRelease ()
 
RENDERCORE_API void ReleaseResourceAndFlush (FRenderResource *Resource)
 

Variables

RENDERCORE_API float GEnableMipLevelFading
 
RENDERCORE_API FMipFadeSettings GMipFadeSettings [MipFade_NumSettings]
 

Enumeration Type Documentation

◆ EMipFadeSettings

Enumerator
MipFade_Normal 
MipFade_Slow 
MipFade_NumSettings 

◆ ERayTracingMode

enum class ERayTracingMode : uint8
strong
Enumerator
Disabled 
Enabled 
Dynamic 

◆ ERenderResourceState

Enumerator
Default 
BatchReleased 
Deleted 

Function Documentation

◆ BeginInitResource() [1/2]

void BeginInitResource ( FName  OwnerName,
FRenderResource Resource,
FRenderCommandPipe RenderCommandPipe = nullptr 
)
inline

◆ BeginInitResource() [2/2]

RENDERCORE_API void BeginInitResource ( FRenderResource Resource,
FRenderCommandPipe RenderCommandPipe = nullptr 
)
extern

Sends a message to the rendering thread to initialize a resource. This is called in the game thread.

◆ BeginReleaseResource()

RENDERCORE_API void BeginReleaseResource ( FRenderResource Resource,
FRenderCommandPipe RenderCommandPipe = nullptr 
)
extern

Sends a message to the rendering thread to release a resource. This is called in the game thread.

◆ BeginUpdateResourceRHI()

RENDERCORE_API void BeginUpdateResourceRHI ( FRenderResource Resource,
FRenderCommandPipe RenderCommandPipe = nullptr 
)
extern

Sends a message to the rendering thread to update a resource. This is called in the game thread.

◆ EndBatchedRelease()

RENDERCORE_API void EndBatchedRelease ( )
extern

Disables the batching of calls to BeginReleaseResource This is called in the game thread.

◆ ReleaseResourceAndFlush()

RENDERCORE_API void ReleaseResourceAndFlush ( FRenderResource Resource)
extern

Sends a message to the rendering thread to release a resource, and spins until the rendering thread has processed the message. This is called in the game thread.

◆ StartBatchedRelease()

RENDERCORE_API void StartBatchedRelease ( )
extern

Enables the batching of calls to BeginReleaseResource This is called in the game thread.

Variable Documentation

◆ GEnableMipLevelFading

RENDERCORE_API float GEnableMipLevelFading
extern

Whether to enable mip-level fading or not: +1.0f if enabled, -1.0f if disabled.

◆ GMipFadeSettings

Global mip fading settings, indexed by EMipFadeSettings.