UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::SVT::FTileDataTexture Class Reference

#include <SparseVolumeTextureTileDataTexture.h>

+ Inheritance diagram for UE::SVT::FTileDataTexture:

Public Types

enum class  EUploaderState { Ready , Reserving , Reserved , Uploading }
 
- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 

Public Member Functions

 FTileDataTexture (const FIntVector3 &ResolutionInTiles, EPixelFormat FormatA, EPixelFormat FormatB, const FVector4f &FallbackValueA, const FVector4f &FallbackValueB)
 
EUploaderState GetUploaderState () const
 
int32 GetTileCapacity () const
 
FIntVector3 GetResolutionInTiles () const
 
TRefCountPtr< IPooledRenderTargetGetTileDataTextureA ()
 
TRefCountPtr< IPooledRenderTargetGetTileDataTextureB ()
 
void BeginReserveUpload ()
 
void ReserveUpload (int32 NumTiles, int32 NumVoxelsA, int32 NumVoxelsB)
 
void EndReserveUpload ()
 
void BeginUpload (FRDGBuilder &GraphBuilder)
 
FTileUploader::FAddResult AddUpload (int32 NumTiles, int32 NumVoxelsA, int32 NumVoxelsB)
 
void EndUpload (FRDGBuilder &GraphBuilder)
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () 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 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
 

Static Public Member Functions

static bool ShouldUseReservedResources ()
 
static int64 GetMaxTileDataTextureResourceSize (int32 InVoxelMemSize)
 
static FIntVector3 GetVolumeResolutionInTiles (int32 InNumRequiredTiles)
 
static FIntVector3 GetLargestPossibleVolumeResolutionInTiles (int32 InVoxelMemSize)
 
- 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)
 

Additional Inherited Members

- 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 FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 

Member Enumeration Documentation

◆ EUploaderState

Enumerator
Ready 
Reserving 
Reserved 
Uploading 

Constructor & Destructor Documentation

◆ FTileDataTexture()

UE::SVT::FTileDataTexture::FTileDataTexture ( const FIntVector3 ResolutionInTiles,
EPixelFormat  FormatA,
EPixelFormat  FormatB,
const FVector4f FallbackValueA,
const FVector4f FallbackValueB 
)
explicit

Member Function Documentation

◆ AddUpload()

FTileUploader::FAddResult UE::SVT::FTileDataTexture::AddUpload ( int32  NumTiles,
int32  NumVoxelsA,
int32  NumVoxelsB 
)

◆ BeginReserveUpload()

void UE::SVT::FTileDataTexture::BeginReserveUpload ( )

◆ BeginUpload()

void UE::SVT::FTileDataTexture::BeginUpload ( FRDGBuilder GraphBuilder)

◆ EndReserveUpload()

void UE::SVT::FTileDataTexture::EndReserveUpload ( )

◆ EndUpload()

void UE::SVT::FTileDataTexture::EndUpload ( FRDGBuilder GraphBuilder)

◆ GetLargestPossibleVolumeResolutionInTiles()

FIntVector3 UE::SVT::FTileDataTexture::GetLargestPossibleVolumeResolutionInTiles ( int32  InVoxelMemSize)
static

◆ GetMaxTileDataTextureResourceSize()

int64 UE::SVT::FTileDataTexture::GetMaxTileDataTextureResourceSize ( int32  InVoxelMemSize)
static

◆ GetResolutionInTiles()

FIntVector3 UE::SVT::FTileDataTexture::GetResolutionInTiles ( ) const
inline

◆ GetTileCapacity()

int32 UE::SVT::FTileDataTexture::GetTileCapacity ( ) const
inline

◆ GetTileDataTextureA()

TRefCountPtr< IPooledRenderTarget > UE::SVT::FTileDataTexture::GetTileDataTextureA ( )
inline

◆ GetTileDataTextureB()

TRefCountPtr< IPooledRenderTarget > UE::SVT::FTileDataTexture::GetTileDataTextureB ( )
inline

◆ GetUploaderState()

EUploaderState UE::SVT::FTileDataTexture::GetUploaderState ( ) const
inline

◆ GetVolumeResolutionInTiles()

FIntVector3 UE::SVT::FTileDataTexture::GetVolumeResolutionInTiles ( int32  InNumRequiredTiles)
static

◆ InitRHI()

void UE::SVT::FTileDataTexture::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.

◆ ReleaseRHI()

void UE::SVT::FTileDataTexture::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.

◆ ReserveUpload()

void UE::SVT::FTileDataTexture::ReserveUpload ( int32  NumTiles,
int32  NumVoxelsA,
int32  NumVoxelsB 
)

◆ ShouldUseReservedResources()

bool UE::SVT::FTileDataTexture::ShouldUseReservedResources ( )
static

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