1. Epic GamesDeveloper
  3. UStreamableSparseVolumeTexture

UStreamableSparseVolumeTexture

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/SparseVolumeTexture

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/SparseVolumeTexture/SparseVolumeTexture.h
Include #include "SparseVolumeTexture/SparseVolumeTexture.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< enum TextureAddress > AddressX The addressing mode to use for the X axis.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< enum TextureAddress > AddressY The addressing mode to use for the Y axis.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< enum TextureAddress > AddressZ The addressing mode to use for the Z axis.
Public variable UProperty Category instanced, visibleanywhere TObjectPtr< class UAssetImportData > AssetImportData  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay instanced TArray< TObjectPtr< class UAssetUserData > > AssetUserData Array of user data stored with the asset
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite bool bLocalDDCOnly 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.
Public variable UProperty Category, AdvancedDisplay visibleanywhere FVector4f FallbackValueA  
Public variable UProperty Category, AdvancedDisplay visibleanywhere FVector4f FallbackValueB  
Public variable UProperty Category assetregistrysearchable, visibleanywhere TEnumAsByte< enum EPixelFormat > FormatA  
Public variable UProperty Category assetregistrysearchable, visibleanywhere TEnumAsByte< enum EPixelFormat > FormatB  
Protected variable UProperty export TArray< TObjectPtr< USparseVolumeTextureFrame > > Frames  
Protected variable UProperty uint8 InitState  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay int32 NumberOfPrefetchFrames When using non-blocking streaming requests, upcoming frames are loaded into memory in advance. This property controls how many frames to prefetch.
Public variable UProperty Category assetregistrysearchable, visibleanywhere int32 NumFrames  
Public variable UProperty Category assetregistrysearchable, visibleanywhere int32 NumMipLevels  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay float PrefetchPercentageBias When using non-blocking streaming requests, upcoming frames are loaded into memory in advance.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay float PrefetchPercentageStepSize When using non-blocking streaming requests, upcoming frames are loaded into memory in advance.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay float StreamingPoolSizeFactor 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.
Protected variable UProperty FIntVector VolumeBoundsMax  
Protected variable UProperty FIntVector VolumeBoundsMin  
Public variable UProperty Category assetregistrysearchable, visibleanywhere FIntVector VolumeResolution  

Constructors

  Type Name Description
Public function    
Public function  

UStreamableSparseVolumeTexture ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual bool

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

  
Public function 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().
Public function Virtual bool  
Public function Const USparseVolumeTextureFrame *

GetFrame ( int32 FrameIndex
)

 Consider using USparseVolumeTextureFrame::GetFrameAndIssueStreamingRequest() if the frame should have streaming requests issued.
Public function Virtual bool

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

 Convenience function wrapping the multi-phase initialization functions above.
Public function void

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

  
Public function void  
Protected function void 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.
Protected function void  
Protected function bool  
Protected function void  

Overridden from USparseVolumeTexture

  Type Name Description
Public function Virtual Const FVector4f

GetFallbackValue ( int32 AttributesIndex
)

  
Public function Virtual Const EPixelFormat

GetFormat ( int32 AttributesIndex
)

  
Public function Virtual Const FTransform  
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function Virtual Const TextureAddress  
Public function Virtual Const TextureAddress  
Public function Virtual Const TextureAddress  
Public function Virtual Const const UE::SVT::FTextureRenderResources *  
Public function Virtual Const FIntVector  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called to finish destroying the object.
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual void  
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData * Returns an instance of the provided AssetUserData class if it's contained in the target asset.
Public function Virtual void  

Enums

  Type Name Description
Protected enum EInitState    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page