Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > VT > URuntimeVirtualTexture

Light Theme

Dark Theme

URuntimeVirtualTexture

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

URuntimeVirtualTexture

References

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

Syntax

class URuntimeVirtualTexture : public UObject

Remarks

Runtime virtual texture UObject

Variables

	Name	Description
bool	bClearTextures	Enable clear before rendering a page of the virtual texture.
bool	bCompressTextures	Enable storing the virtual texture in GPU supported compression formats.
bool	bEnable	Enable usage of the virtual texture.
bool	bEnableCompressCrunch	Enable Crunch compression of streamed low mips. ZLib compression is used when Crunch is disabled.
bool	bEnableScalability	Enable device scalability settings to modify the TileCount of the virtual texture.
bool	bPrivateSpace	Enable private page table allocation.
bool	bSinglePhysicalSpace	Enable page table channel packing.
ERuntimeVirtual...	MaterialType	Contents of virtual texture.
int32	RemoveLowMips	Number of low mips to cut from the virtual texture.
URuntimeVirtual...	StreamingTexture	Texture object containing streamed low mips.
int32	StreamLowMips	Number of low mips to serialize and stream for the virtual texture.
int32	TileBorderSize	Page tile border size divided by 2 (Actual values increase in multiples of 2).
int32	TileCount	Size of virtual texture in tiles.
int32	TileSize	Page tile size. (Actual values increase in powers of 2)

Constructors

	Name	Description
	URuntimeVirtualTexture ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~URuntimeVirtualTexture()

Functions

	Name	Description
IVirtualText...	CreateStreamingTextureProducer ( IVirtualTexture* InProducer, int32 InMaxLevel, int32& OutTransitionLevel )	Create the streaming texture producer to wrap an existing producer.
IAllocatedVi...	GetAllocatedVirtualTexture()	Getter for the associated virtual texture allocation. Call on render thread only.
bool	GetClearTextures()	Returns true if texture pages should be cleared before render
bool	GetEnabled()	Public getter for enabled status
int32	GetEstimatedPageTableTextureMemoryKb()	Returns an approximate estimated value for the memory used by the page table texture.
int32	GetEstimatedPhysicalTextureMemoryKb()	Returns an approximate estimated value for the memory used by the physical texture.
int32	GetLayerCount ( ERuntimeVirtualTextureMaterialType ... )	Returns number of texture layers in the virtual texture of a given material type
int32	GetLayerCount()	Returns number of texture layers in the virtual texture
EPixelFormat	GetLayerFormat ( int32 LayerIndex )	Returns the texture format for the virtual texture layer
ERuntimeVirt...	GetMaterialType()	Get the material set that this virtual texture stores.
void	GetProducerDescription ( FVTProducerDescription& OutDesc, FTransform const& VolumeToWorld )	Get virtual texture description based on the properties of this object and the passed in volume transform.
FVirtualText...	GetProducerHandle()	Getter for the associated virtual texture producer. Call on render thread only.
int32	GetRemoveLowMips()	Public getter for virtual texture removed low mips
bool	GetSinglePhysicalSpace()	Public getter for virtual texture using single physical space flag.
int32	GetSize()	Public getter for virtual texture size
URuntimeVirt...	GetStreamingTexture()	Get the streaming texture
uint32	GetStreamingTextureBuildHash()	Get a hash of the current state to use for streaming texture invalidation.
int32	GetStreamLowMips()	Public getter for virtual texture streaming low mips
int32	GetTileBorderSize()	Public getter for virtual texture tile border size
int32	GetTileCount()	Public getter for virtual texture tile count
int32	GetTileCount ( int32 InTileCount )
int32	GetTileSize()	Public getter for virtual texture tile size
FVector4	GetUniformParameter ( int32 Index )	Getter for the shader uniform parameters.
void	Initialize ( IVirtualTexture* InProducer, FTransform const& VolumeToWorld, FBox const& WorldBounds )	(Re)Initialize this object. Call this whenever we modify the producer or transform.
void	InitializeStreamingTexture ( uint32 InSizeX, uint32 InSizeY, uint8* InData )	Initialize the low mip streaming texture with the passed in size and data.
void	InitNullResource()	Initialize the render resources with a null producer. This kicks off render thread work.
void	InitResource ( IVirtualTexture* InProducer, FTransform const& VolumeToWorld )	Initialize the render resources. This kicks off render thread work.
bool	IsLayerSRGB ( int32 LayerIndex )	Return true if the virtual texture layer should be sampled as sRGB
bool	IsLayerYCoCg ( int32 LayerIndex )	Return true if the virtual texture layer should be sampled as YCoCg
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.

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	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	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	int32	Size_DEPRECATED	Size of virtual texture along the largest axis. (Actual values increase in powers of 2)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss