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

#include <ScenePrivate.h>

+ Inheritance diagram for FReflectionEnvironmentCubemapArray:

Public Member Functions

 FReflectionEnvironmentCubemapArray (ERHIFeatureLevel::Type InFeatureLevel)
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
void UpdateMaxCubemaps (uint32 InMaxCubemaps, int32 CubemapSize)
 
void ResizeCubemapArrayGPU (uint32 InMaxCubemaps, int32 CubemapSize, const TArray< int32 > &IndexRemapping)
 
int32 GetMaxCubemaps () const
 
int32 GetCubemapSize () const
 
bool IsValid () const
 
const TRefCountPtr< IPooledRenderTarget > & GetRenderTarget () const
 
void Reset ()
 
- 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)
 
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
 

Protected Member Functions

void ReleaseCubeArray ()
 
- 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

uint32 MaxCubemaps
 
int32 CubemapSize
 
TRefCountPtr< IPooledRenderTargetReflectionEnvs
 

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)
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 

Detailed Description

Rendering resource class that manages a cubemap array for reflections.

Constructor & Destructor Documentation

◆ FReflectionEnvironmentCubemapArray()

FReflectionEnvironmentCubemapArray::FReflectionEnvironmentCubemapArray ( ERHIFeatureLevel::Type  InFeatureLevel)
inline

Member Function Documentation

◆ GetCubemapSize()

int32 FReflectionEnvironmentCubemapArray::GetCubemapSize ( ) const
inline

◆ GetMaxCubemaps()

int32 FReflectionEnvironmentCubemapArray::GetMaxCubemaps ( ) const
inline

◆ GetRenderTarget()

const TRefCountPtr< IPooledRenderTarget > & FReflectionEnvironmentCubemapArray::GetRenderTarget ( ) const
inline

◆ InitRHI()

void FReflectionEnvironmentCubemapArray::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.

◆ IsValid()

bool FReflectionEnvironmentCubemapArray::IsValid ( ) const
inline

◆ ReleaseCubeArray()

void FReflectionEnvironmentCubemapArray::ReleaseCubeArray ( )
protected

◆ ReleaseRHI()

void FReflectionEnvironmentCubemapArray::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 FRenderResource.

◆ Reset()

void FReflectionEnvironmentCubemapArray::Reset ( )

◆ ResizeCubemapArrayGPU()

void FReflectionEnvironmentCubemapArray::ResizeCubemapArrayGPU ( uint32  InMaxCubemaps,
int32  CubemapSize,
const TArray< int32 > &  IndexRemapping 
)

Updates the maximum number of cubemaps that this array is allocated for. This reallocates the resource and copies over the old contents, preserving indices

◆ UpdateMaxCubemaps()

void FReflectionEnvironmentCubemapArray::UpdateMaxCubemaps ( uint32  InMaxCubemaps,
int32  CubemapSize 
)

Updates the maximum number of cubemaps that this array is allocated for. This reallocates the resource but does not copy over the old contents.

Member Data Documentation

◆ CubemapSize

int32 FReflectionEnvironmentCubemapArray::CubemapSize
protected

◆ MaxCubemaps

uint32 FReflectionEnvironmentCubemapArray::MaxCubemaps
protected

◆ ReflectionEnvs

TRefCountPtr<IPooledRenderTarget> FReflectionEnvironmentCubemapArray::ReflectionEnvs
protected

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