UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FSkyTextureCubeResource Class Reference

#include <SkyLightComponent.h>

+ Inheritance diagram for FSkyTextureCubeResource:

Public Member Functions

 FSkyTextureCubeResource ()
 
virtual ~FSkyTextureCubeResource ()
 
void SetupParameters (int32 InSize, int32 InNumMips, EPixelFormat InFormat)
 
virtual ENGINE_API void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
virtual uint32 GetSizeX () const override
 
virtual uint32 GetSizeY () const override
 
void AddRef ()
 
ENGINE_API void Release ()
 
- Public Member Functions inherited from FTexture
RENDERCORE_API FTexture ()
 
virtual RENDERCORE_API ~FTexture ()
 
RENDERCORE_API FTexture (const FTexture &)
 
RENDERCORE_API FTexture (FTexture &&)
 
RENDERCORE_API FTexture & operator= (const FTexture &Other)
 
RENDERCORE_API FTexture & operator= (FTexture &&Other)
 
const FTextureRHIRef & GetTextureRHI ()
 
virtual RENDERCORE_API uint32 GetSizeZ () const
 
virtual RENDERCORE_API FString GetFriendlyName () const override
 
- 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 RENDERCORE_API void InitResource (FRHICommandListBase &RHICmdList)
 
virtual RENDERCORE_API void ReleaseResource ()
 
RENDERCORE_API void UpdateRHI (FRHICommandListBase &RHICmdList)
 
bool IsInitialized () const
 
int32 GetListIndex () const
 
EInitPhase GetInitPhase () const
 
void SetOwnerName (FName InOwnerName)
 
FName GetOwnerName () const
 
void SetResourceName (FName InResourceName)
 
FName GetResourceName () const
 

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 FTexture
FTextureRHIRef TextureRHI
 
FSamplerStateRHIRef SamplerStateRHI
 
FSamplerStateRHIRef DeferredPassSamplerStateRHI
 
double LastRenderTime = -FLT_MAX
 
FMipBiasFade MipBiasFade
 
bool bGreyScaleFormat = false
 
bool bIgnoreGammaConversions = false
 
bool bSRGB = false
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 
- 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)
 
- Static Protected Member Functions inherited from FTexture
static RENDERCORE_API FRHISamplerState * GetOrCreateSamplerState (const FSamplerStateInitializerRHI &Initializer)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBase & GetImmediateCommandList ()
 

Detailed Description

A cubemap texture resource that knows how to upload the capture data from a sky capture.

Constructor & Destructor Documentation

◆ FSkyTextureCubeResource()

FSkyTextureCubeResource::FSkyTextureCubeResource ( )
inline

◆ ~FSkyTextureCubeResource()

virtual FSkyTextureCubeResource::~FSkyTextureCubeResource ( )
inlinevirtual

Member Function Documentation

◆ AddRef()

void FSkyTextureCubeResource::AddRef ( )
inline

◆ GetSizeX()

virtual uint32 FSkyTextureCubeResource::GetSizeX ( ) const
inlineoverridevirtual

Returns the width of the texture in pixels.

Reimplemented from FTexture.

◆ GetSizeY()

virtual uint32 FSkyTextureCubeResource::GetSizeY ( ) const
inlineoverridevirtual

Returns the height of the texture in pixels.

Reimplemented from FTexture.

◆ InitRHI()

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

◆ Release()

void FSkyTextureCubeResource::Release ( )

◆ ReleaseRHI()

virtual void FSkyTextureCubeResource::ReleaseRHI ( )
inlineoverridevirtual

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 FTexture.

◆ SetupParameters()

void FSkyTextureCubeResource::SetupParameters ( int32  InSize,
int32  InNumMips,
EPixelFormat  InFormat 
)
inline
The documentation for this class was generated from the following files: