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	bAdaptive	Enable sparse adaptive page tables.
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	bContinuousUpdate	Enable continuous update of the virtual texture pages.
bool	bPrivateSpace	Enable private page table allocation.
bool	bSinglePhysicalSpace	Enable page table channel packing.
TEnumAsByte< en...	LODGroup	Texture group this texture belongs to
ERuntimeVirtual...	MaterialType	Contents of virtual texture.
int32	RemoveLowMips	Number of low mips to cut from 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
bool	GetAdaptivePageTable()	Public getter for virtual texture using adaptive flag.
IAllocatedVi...	GetAllocatedVirtualTexture()	Getter for the associated virtual texture allocation. Call on render thread only.
int32	GetClampedTileCount ( int32 InTileCount, bool InAdaptive )
int32	GetClampedTileSize ( int32 InTileSize )
bool	GetClearTextures()	Returns true if texture pages should be cleared before render
bool	GetCompressTextures()	Get if this virtual texture uses compressed texture formats.
bool	GetContinuousUpdate()	Public getter for virtual texture using continuous update flag.
int32	GetLayerCount()	Returns number of texture layers in the virtual texture
int32	GetLayerCount ( ERuntimeVirtualTextureMaterialType ... )	Returns number of texture layers in the virtual texture of a given material type
EPixelFormat	GetLayerFormat ( int32 LayerIndex )	Returns the texture format for the virtual texture layer
TEnumAsByte<...	GetLODGroup()	Public getter for texture LOD Group
ERuntimeVirt...	GetMaterialType()	Get the material set that this virtual texture stores.
int32	GetMaxTileCountLog2 ( bool InAdaptive )
int32	GetPageTableSize()	Public getter for virtual texture page table size.
bool	GetPrivateSpace()	Public getter for virtual texture using private space flag.
void	GetProducerDescription ( FVTProducerDescription& OutDesc, FInitSettings const& InitSettings, 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. This is derived from the TileCount and TileSize.
int32	GetTileBorderSize()	Public getter for virtual texture tile border size
int32	GetTileCount()	Public getter for virtual texture tile count
int32	GetTileSize()	Public getter for virtual texture tile size
FVector4	GetUniformParameter ( int32 Index )	Getter for the shader uniform parameters.
void	Initialize ( IVirtualTexture* InProducer, FVTProducerDescription const& InPr..., FTransform const& InVolumeToWorld, FBox const& InWorldBounds )	(Re)Initialize this object. Call this whenever we modify the producer or transform.
void	InitNullResource()	Initialize the render resources with a null producer. This kicks off render thread work.
void	InitResource ( IVirtualTexture* InProducer, FVTProducerDescription const& InPr... )	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.

Classes

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

Deprecated Variables

		Name	Description
	int32	Size_DEPRECATED	Deprecated size of virtual texture.
	URuntimeVirtual...	StreamingTexture_DEPRECATED	Deprecated texture object containing streamed low mips.

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

Take our survey

Dismiss