Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/SparseVolumeTexture
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- USparseVolumeTexture
- UStreamableSparseVolumeTexture
- UAnimatedSparseVolumeTexture
- UStaticSparseVolumeTexture
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/SparseVolumeTexture/SparseVolumeTexture.h |
| Include | #include "SparseVolumeTexture/SparseVolumeTexture.h" |
Syntax
class UStreamableSparseVolumeTexture : public USparseVolumeTexture
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 | |
|---|---|---|---|
 |
TEnumAsByte< enum TextureAddress > | AddressX | The addressing mode to use for the X axis. |
 |
TEnumAsByte< enum TextureAddress > | AddressY | The addressing mode to use for the Y axis. |
 |
TEnumAsByte< enum TextureAddress > | AddressZ | The addressing mode to use for the Z axis. |
 |
TObjectPtr< class UAssetImportData > | AssetImportData | |
 |
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. |
 |
FVector4f | FallbackValueA | |
 |
FVector4f | FallbackValueB | |
 |
TEnumAsByte< enum EPixelFormat > | FormatA | |
 |
TEnumAsByte< enum EPixelFormat > | FormatB | |
 |
TArray< TObjectPtr< USparseVolumeTextureFrame > > | Frames | |
 |
uint8 | InitState | |
 |
int32 | NumFrames | |
 |
int32 | NumMipLevels | |
 |
FIntVector | VolumeBoundsMax | |
 |
FIntVector | VolumeBoundsMin | |
 |
FIntVector | VolumeResolution |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
UStreamableSparseVolumeTexture
(
const FObjectInitializer& ObjectInitializer |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | AppendFrame
(
UE::SVT::FTextureData& UncookedFrame |
|
  |
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(). |
  |
bool | ||
  |
USparseVolumeTextureFrame * | GetFrame
(
int32 FrameIndex |
Consider using USparseVolumeTextureFrame::GetFrameAndIssueStreamingRequest() if the frame should have streaming requests issued. |
  |
bool | Initialize
(
const TArrayView< UE::SVT::FTextureData >& UncookedData |
Convenience function wrapping the multi-phase initialization functions above. |
 |
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. |
Overridden from USparseVolumeTexture
| Type | Name | Description | |
|---|---|---|---|
   |
FVector4f | GetFallbackValue
(
int32 AttributesIndex |
|
   |
EPixelFormat | GetFormat
(
int32 AttributesIndex |
|
   |
int32 | GetNumFrames () |
|
   |
int32 | ||
   |
TextureAddress | ||
   |
TextureAddress | ||
   |
TextureAddress | ||
   |
const UE::SVT::FTextureRenderResources * | ||
   |
FIntVector |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
  |
void | Called to finish destroying the object. | |
   |
void | GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
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 |
  |
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). |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | Handles reading, writing, and reference collecting using FArchive. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
EInitState |