1. Epic GamesDeveloper
  3. UStreamableSparseVolumeTexture

UStreamableSparseVolumeTexture

Represents a streamable SparseVolumeTexture asset and serves as base class for [UStaticSparseVolumeTexture](API\Runtime\Engine\UStaticSparseVolumeTexture) and [UAnimatedSparseVolumeTexture](API\Runtime\Engine\UAnimatedSparseVolumeTexture). It has an array of [USparseVolumeTextureFrame](API\Runtime\Engine\USparseVolumeTextureFrame).

API > API/Runtime > API/Runtime/Engine

Represents a streamable SparseVolumeTexture asset and serves as base class for UStaticSparseVolumeTexture and UAnimatedSparseVolumeTexture. It has an array of USparseVolumeTextureFrame.

   
Name UStreamableSparseVolumeTexture
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 UStreamableSparseVolumeTexture :  
    public USparseVolumeTexture ,  
    public IInterface_AssetUserData

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  SparseVolumeTexture/SparseVolumeTexture.h  

UStreamableSparseVolumeTexture ( const FObjectInitializer& ObjectInitializer
)

   SparseVolumeTexture/SparseVolumeTexture.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UStreamableSparseVolumeTexture()

   SparseVolumeTexture/SparseVolumeTexture.h  

Enums

Protected

Name Remarks
EInitState  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AddressX TEnumAsByte< enum TextureAddress > The addressing mode to use for the X axis. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Texture"
  • Meta=(DisplayName="X-axis Tiling Method")
  • AssetRegistrySearchable
  • AdvancedDisplay
AddressY TEnumAsByte< enum TextureAddress > The addressing mode to use for the Y axis. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Texture"
  • Meta=(DisplayName="Y-axis Tiling Method")
  • AssetRegistrySearchable
  • AdvancedDisplay
AddressZ TEnumAsByte< enum TextureAddress > The addressing mode to use for the Z axis. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Texture"
  • Meta=(DisplayName="Z-axis Tiling Method")
  • AssetRegistrySearchable
  • AdvancedDisplay
AssetImportData TObjectPtr< class UAssetImportData >   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Instanced
  • Category=ImportSettings
AssetUserData TArray< TObjectPtr< class UAssetUserData > > Array of user data stored with the asset SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • AdvancedDisplay
  • Instanced
  • Category="Texture"
bLocalDDCOnly bool If enabled, the SparseVolumeTexture is only going to use the local DDC. For certain assets it might be reasonable to also use the remote DDC, but for larger assets this will mean long up- and download times. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Texture"
  • AdvancedDisplay
FallbackValueA FVector4f   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AdvancedDisplay
FallbackValueB FVector4f   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AdvancedDisplay
FormatA TEnumAsByte< enum EPixelFormat >   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AssetRegistrySearchable
FormatB TEnumAsByte< enum EPixelFormat >   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AssetRegistrySearchable
NumberOfPrefetchFrames int32 When using non-blocking streaming requests, upcoming frames are loaded into memory in advance. This property controls how many frames to prefetch. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • Category="Texture"
  • AdvancedDisplay
NumFrames int32   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AssetRegistrySearchable
NumMipLevels int32   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AssetRegistrySearchable
PrefetchPercentageBias float When using non-blocking streaming requests, upcoming frames are loaded into memory in advance. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • Category="Texture"
  • AdvancedDisplay
PrefetchPercentageStepSize float When using non-blocking streaming requests, upcoming frames are loaded into memory in advance. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • Category="Texture"
  • AdvancedDisplay
StreamingPoolSizeFactor float The SVT streaming pool is sized such that it can hold the largest frame multiplied by this value. There should be some slack to allow for prefetching frames. SparseVolumeTexture/SparseVolumeTexture.h
  • EditAnywhere
  • Category="Texture"
  • AdvancedDisplay
VolumeResolution FIntVector   SparseVolumeTexture/SparseVolumeTexture.h
  • VisibleAnywhere
  • Category="Texture"
  • AssetRegistrySearchable

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AppendFrame ( UE::SVT::FTextureData& UncookedFrame,
const FTransform& FrameTransform
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual bool BeginInitialize ( int32 NumExpectedFrames
)

 Multi-phase initialization: Call BeginInitialize(), then call AppendFrame() for each frame to add and then finish initialization with a call to EndInitialize(). SparseVolumeTexture/SparseVolumeTexture.h  

virtual bool EndInitialize()

   SparseVolumeTexture/SparseVolumeTexture.h  

USparseVolumeTextureFrame * GetFrame ( int32 FrameIndex
) const

 Consider using USparseVolumeTextureFrame::GetFrameAndIssueStreamingRequest() if the frame should have streaming requests issued. SparseVolumeTexture/SparseVolumeTexture.h  

virtual bool Initialize ( const TArrayView< UE::SVT::FTextureData >& UncookedData,
const TArrayView< FTransform >& FrameTransforms
)

 Convenience function wrapping the multi-phase initialization functions above. SparseVolumeTexture/SparseVolumeTexture.h  

void OnAddExtraObjectsToDelete ( const TArray< UObject* >& InObjectsToDelete,
TSet< UObject* >& OutSecondaryObjects
)

   SparseVolumeTexture/SparseVolumeTexture.h  

void OnAssetsAddExtraObjectsToDelete ( TArray< UObject* >& ObjectsToDelete
)

   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 BeginDestroy()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void FinishDestroy()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void PostInitProperties()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void PostLoad()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual void Serialize ( FArchive& Ar
)

   SparseVolumeTexture/SparseVolumeTexture.h  

Overridden from IInterface_AssetUserData

Name Remarks Include Path Unreal Specifiers

virtual void AddAssetUserData ( UAssetUserData* InUserData
)

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual const TArray< UAssetUserData * > * GetAssetUserDataArray()

   SparseVolumeTexture/SparseVolumeTexture.h  

virtual UAssetUserData * GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

 Returns an instance of the provided AssetUserData class if it's contained in the target asset. SparseVolumeTexture/SparseVolumeTexture.h  

virtual void RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

   SparseVolumeTexture/SparseVolumeTexture.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RecacheFrames ()

 Ensures all frames have derived data (based on the source data and the current settings like TextureAddress modes etc.) cached to DDC and are ready for rendering. SparseVolumeTexture/SparseVolumeTexture.h  

void RegisterEditorDelegates()

   SparseVolumeTexture/SparseVolumeTexture.h  

bool ShouldRegisterDelegates()

   SparseVolumeTexture/SparseVolumeTexture.h  

void UnregisterEditorDelegates()

   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