1. Epic GamesDeveloper
  3. USparseVolumeTextureFrame

USparseVolumeTextureFrame

Represents a frame in a SparseVolumeTexture sequence and owns the actual data needed for rendering. Is owned by a [UStreamableSparseVolumeTexture](API\Runtime\Engine\UStreamableSparseVolumeTexture) object.

API > API/Runtime > API/Runtime/Engine

Represents a frame in a SparseVolumeTexture sequence and owns the actual data needed for rendering. Is owned by a UStreamableSparseVolumeTexture object.

   
Name USparseVolumeTextureFrame
Type class
Header File /Engine/Source/Runtime/Engine/Classes/SparseVolumeTexture/SparseVolumeTexture.h
Include Path #include "SparseVolumeTexture/SparseVolumeTexture.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=Rendering, BlueprintType)  
class USparseVolumeTextureFrame : public USparseVolumeTexture

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  SparseVolumeTexture/SparseVolumeTexture.h  

USparseVolumeTextureFrame ( const FObjectInitializer& ObjectInitializer
)

   SparseVolumeTexture/SparseVolumeTexture.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~USparseVolumeTextureFrame()

   SparseVolumeTexture/SparseVolumeTexture.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FrameIndex int32   SparseVolumeTexture/SparseVolumeTexture.h  
Owner TObjectPtr< USparseVolumeTexture >   SparseVolumeTexture/SparseVolumeTexture.h  
Resources UE::SVT::FResources Derived data used at runtime. SparseVolumeTexture/SparseVolumeTexture.h  
SourceData UE::Serialization::FEditorBulkData FTextureData from which the FResources data can be built with a call to FResources::Build() SparseVolumeTexture/SparseVolumeTexture.h  
TextureRenderResources UE::SVT::FTextureRenderResources * Runtime render data. SparseVolumeTexture/SparseVolumeTexture.h  
Transform FTransform   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AssetRegistrySearchable

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Cache ( bool bSkipDDCAndSetResourcesToDefault
)

 Caches the derived data (FResources) of this frame to/from DDC and ensures that FTextureRenderResources exists. SparseVolumeTexture/SparseVolumeTexture.h  

bool CreateTextureRenderResources()

 Creates TextureRenderResources if they don't already exist. Returns false if they already existed. SparseVolumeTexture/SparseVolumeTexture.h  

int32 GetFrameIndex()

   SparseVolumeTexture/SparseVolumeTexture.h  

UE::SVT::FResources * GetResources()

   SparseVolumeTexture/SparseVolumeTexture.h  

bool Initialize ( USparseVolumeTexture* InOwner,
int32 InFrameIndex,
const FTransform& InFrameTransform,
UE::SVT::FTextureData& UncookedFrame
)

   SparseVolumeTexture/SparseVolumeTexture.h  

Overridden from USparseVolumeTexture

Name Remarks Include Path Unreal Specifiers

virtual FVector4f GetFallbackValue ( int32 AttributesIndex
) const

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual EPixelFormat GetFormat ( int32 AttributesIndex
) const

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual FTransform GetFrameTransform()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual int32 GetNumFrames()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual int32 GetNumMipLevels()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual TextureAddress GetTextureAddressX()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual TextureAddress GetTextureAddressY()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual TextureAddress GetTextureAddressZ()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual const UE::SVT::FTextureRenderResources * GetTextureRenderResources()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual FIntVector GetVolumeResolution()

   SparseVolumeTexture/SparseVolumeTexture.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void BeginDestroy()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void ClearAllCachedCookedPlatformData()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void ClearCachedCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void FinishDestroy()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void PostLoad()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void Serialize ( FArchive& Ar
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void WillNeverCacheCookedPlatformDataAgain()

   SparseVolumeTexture/SparseVolumeTexture.h  

Static

Name Remarks Include Path Unreal Specifiers

static USparseVolumeTextureFrame * GetFrameAndIssueStreamingRequest ( USparseVolumeTexture* SparseVolumeTexture,
uint32 StreamingInstanceKey,
float FrameRate,
float FrameIndex,
float MipLevel,
bool bBlocking,
bool bHasValidFrameRate
)

 Retrieves a frame from the given SparseVolumeTexture and also issues a streaming request for it. SparseVolumeTexture/SparseVolumeTexture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page