1. Epic GamesDeveloper
  3. URuntimeVirtualTexture

URuntimeVirtualTexture

Runtime virtual texture [UObject](API\Runtime\CoreUObject\UObject)

API > API/Runtime > API/Runtime/Engine

Runtime virtual texture UObject

   
Name URuntimeVirtualTexture
Type class
Header File /Engine/Source/Runtime/Engine/Classes/VT/RuntimeVirtualTexture.h
Include Path #include "VT/RuntimeVirtualTexture.h"

Syntax

UCLASS (ClassGroup=Rendering, BlueprintType, MinimalAPI)  
class URuntimeVirtualTexture : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URuntimeVirtualTexture ( const FObjectInitializer& ObjectInitializer
)

   VT/RuntimeVirtualTexture.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~URuntimeVirtualTexture()

   VT/RuntimeVirtualTexture.h  

Structs

Name Remarks
FInitSettings Structure containing additional settings for initializing the producer.

Typedefs

Name Type Remarks Include Path
FOnReInitDelegate TBaseDelegate_NoParams< void > Declare a delegate funtion signiture for a function that is registered in Initialize() to be called if we call Initialize() without calling Release(). VT/RuntimeVirtualTexture.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
OnReInitDelegate FOnReInitDelegate Delegate to be called on ReInitialize(). VT/RuntimeVirtualTexture.h  
Resource FRuntimeVirtualTextureRenderResource * Render thread resource container. VT/RuntimeVirtualTexture.h  
WorldHeightUnpackParameter FVector4 Material uniform parameter used to pack world height. VT/RuntimeVirtualTexture.h  
WorldToUVTransformParameters FVector4 Material uniform parameters to support transform from world to UV coordinates. VT/RuntimeVirtualTexture.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetAdaptivePageTable()

 Public getter for virtual texture using adaptive flag. VT/RuntimeVirtualTexture.h  

IAllocatedVirtualTexture * GetAllocatedVirtualTexture()

 Getter for the associated virtual texture allocation. Call on render thread only. VT/RuntimeVirtualTexture.h  

bool GetClearTextures()

 Returns true if texture pages should be cleared before render VT/RuntimeVirtualTexture.h  

bool GetCompressTextures()

 Get if this virtual texture uses compressed texture formats. VT/RuntimeVirtualTexture.h  

bool GetContinuousUpdate()

 Public getter for virtual texture using continuous update flag. VT/RuntimeVirtualTexture.h  

FVector4f GetCustomMaterialData()

 Public getter for the custom material data. VT/RuntimeVirtualTexture.h  

EVTProducerPriority GetDefaultPriority()

   VT/RuntimeVirtualTexture.h  

int32 GetLayerCount ()

 Returns number of texture layers in the virtual texture VT/RuntimeVirtualTexture.h  

EPixelFormat GetLayerFormat ( int32 LayerIndex
) const

 Returns the texture format for the virtual texture layer VT/RuntimeVirtualTexture.h  

TEnumAsByte< enum TextureGroup > GetLODGroup()

 Public getter for texture LOD Group VT/RuntimeVirtualTexture.h  

bool GetLQCompression()

 Public getter for virtual texture using low quality compression flag. VT/RuntimeVirtualTexture.h  
Get the material set that this virtual texture stores. VT/RuntimeVirtualTexture.h  

int32 GetPageTableSize ()

 Public getter for virtual texture page table size. VT/RuntimeVirtualTexture.h
  • BlueprintPure
  • Category=Size

EVTProducerPriority GetPriority()

   VT/RuntimeVirtualTexture.h  

bool GetPrivateSpace()

 Public getter for virtual texture using private space flag. VT/RuntimeVirtualTexture.h  

void GetProducerDescription ( FVTProducerDescription& OutDesc,
FInitSettings const& InitSettings,
FTransform const& VolumeToWorld
) const

 Get virtual texture description based on the properties of this object and the passed in volume transform. VT/RuntimeVirtualTexture.h  

FVirtualTextureProducerHandle GetProducerHandle()

 Getter for the associated virtual texture producer. Call on render thread only. VT/RuntimeVirtualTexture.h  

int32 GetRemoveLowMips()

 Public getter for virtual texture removed low mips VT/RuntimeVirtualTexture.h  

bool GetSinglePhysicalSpace()

 Public getter for virtual texture using single physical space flag. VT/RuntimeVirtualTexture.h  

int32 GetSize()

 Public getter for virtual texture size. This is derived from the TileCount and TileSize. VT/RuntimeVirtualTexture.h
  • BlueprintPure
  • Category=Size

int32 GetTileBorderSize()

 Public getter for virtual texture tile border size VT/RuntimeVirtualTexture.h
  • BlueprintGetter

int32 GetTileCount()

 Public getter for virtual texture tile count VT/RuntimeVirtualTexture.h
  • BlueprintGetter

int32 GetTileSize()

 Public getter for virtual texture tile size VT/RuntimeVirtualTexture.h
  • BlueprintGetter

FVector4 GetUniformParameter ( int32 Index
) const

 Getter for the shader uniform parameters. VT/RuntimeVirtualTexture.h  

bool GetUseCustomPriority()

   VT/RuntimeVirtualTexture.h  

void Initialize ( IVirtualTexture* InProducer,
FVTProducerDescription const& InProducerDesc,
FTransform const& InVolumeToWorld,
FBox const& InWorldBounds
)

   VT/RuntimeVirtualTexture.h  

void Initialize ( IVirtualTexture* InProducer,
FVTProducerDescription const& InProducerDesc,
FTransform const& InVolumeToWorld,
FBox const& InWorldBounds,
FOnReInitDelegate InDelegate
)

 (Re)Initialize this object. Call this whenever we modify the producer or transform. VT/RuntimeVirtualTexture.h  

bool IsLayerSRGB ( int32 LayerIndex
) const

 Return true if the virtual texture layer should be sampled as sRGB VT/RuntimeVirtualTexture.h  

bool IsLayerYCoCg ( int32 LayerIndex
) const

 Return true if the virtual texture layer should be sampled as YCoCg VT/RuntimeVirtualTexture.h  

void Release()

 Release the resources for this object This will need to be called if our producer becomes stale and we aren't doing a full reinit with a new producer. VT/RuntimeVirtualTexture.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitNullResource()

 Initialize the render resources with a null producer. This kicks off render thread work. VT/RuntimeVirtualTexture.h  

void InitResource ( IVirtualTexture* InProducer,
FVTProducerDescription const& InProducerDesc
)

 Initialize the render resources. This kicks off render thread work. VT/RuntimeVirtualTexture.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

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

   VT/RuntimeVirtualTexture.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   VT/RuntimeVirtualTexture.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   VT/RuntimeVirtualTexture.h  

virtual void PostLoad()

   VT/RuntimeVirtualTexture.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetClampedTileCount ( int32 InTileCount,
bool InAdaptive
)

   VT/RuntimeVirtualTexture.h
  • BlueprintGetter

static int32 GetClampedTileSize ( int32 InTileSize
)

   VT/RuntimeVirtualTexture.h
  • BlueprintGetter

static int32 GetLayerCount ( ERuntimeVirtualTextureMaterialType InMaterialType
)

 Returns number of texture layers in the virtual texture of a given material type VT/RuntimeVirtualTexture.h  

static int32 GetMaxTileCountLog2 ( bool InAdaptive
)

   VT/RuntimeVirtualTexture.h  

static UE::Shader::EValueType GetUniformParameterType ( int32 Index
)

 Getter for the shader uniform parameter type. VT/RuntimeVirtualTexture.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Size_DEPRECATED int32 Deprecated size of virtual texture. VT/RuntimeVirtualTexture.h  
StreamingTexture_DEPRECATED TObjectPtr< class URuntimeVirtualTextureStreamingProxy > Deprecated texture object containing streamed low mips. VT/RuntimeVirtualTexture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page