URuntimeVirtualTexture

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

Choose your operating system:

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

Protected variable

bool

 

bAdaptive

Enable sparse adaptive page tables.

Protected variable

bool

 

bClearTextures

Enable clear before rendering a page of the virtual texture.

Protected variable

bool

 

bCompressTextures

Enable storing the virtual texture in GPU supported compression formats.

Protected variable

bool

 

bContinuousUpdate

Enable continuous update of the virtual texture pages.

Protected variable

bool

 

bPrivateSpace

Enable private page table allocation.

Protected variable

bool

 

bSinglePhysicalSpace

Enable page table channel packing.

Protected variable

bool

 

bUseLowQualityCompression

Use low quality textures (RGB565/RGB555A1) to replace runtime compression

Protected variable

TEnumAsByte< en...

 

LODGroup

Texture group this texture belongs to

Protected variable

ERuntimeVirtual...

 

MaterialType

Contents of virtual texture.

Protected variable

int32

 

RemoveLowMips

Number of low mips to cut from the virtual texture.

Protected variable

int32

 

TileBorderSize

Page tile border size divided by 2 (Actual values increase in multiples of 2).

Protected variable

int32

 

TileCount

Size of virtual texture in tiles.

Protected variable

int32

 

TileSize

Page tile size. (Actual values increase in powers of 2)

Constructors

Name Description

Public function

URuntimeVirtualTexture

(
    const FObjectInitializer& ObjectIn...
)

Destructors

Name Description

Public function

~URuntimeVirtualTexture()

Functions

Name Description

Public function Const

bool

 

GetAdaptivePageTable()

Public getter for virtual texture using adaptive flag.

Public function Const

IAllocatedVi...

 

GetAllocatedVirtualTexture()

Getter for the associated virtual texture allocation. Call on render thread only.

Public function Static

int32

 

GetClampedTileCount

(
    int32 InTileCount,
    bool InAdaptive
)

Public function Static

int32

 

GetClampedTileSize

(
    int32 InTileSize
)

Public function Const

bool

 

GetClearTextures()

Returns true if texture pages should be cleared before render

Public function Const

bool

 

GetCompressTextures()

Get if this virtual texture uses compressed texture formats.

Public function Const

bool

 

GetContinuousUpdate()

Public getter for virtual texture using continuous update flag.

Public function Const

int32

 

GetLayerCount()

Returns number of texture layers in the virtual texture

Public function Static

int32

 

GetLayerCount

Returns number of texture layers in the virtual texture of a given material type

Public function Const

EPixelFormat

 

GetLayerFormat

(
    int32 LayerIndex
)

Returns the texture format for the virtual texture layer

Public function Const

TEnumAsByte<...

 

GetLODGroup()

Public getter for texture LOD Group

Public function Const

bool

 

GetLQCompression()

Public function Const

ERuntimeVirt...

 

GetMaterialType()

Get the material set that this virtual texture stores.

Public function Static

int32

 

GetMaxTileCountLog2

(
    bool InAdaptive
)

Public function Const

int32

 

GetPageTableSize()

Public getter for virtual texture page table size.

Public function Const

bool

 

GetPrivateSpace()

Public getter for virtual texture using private space flag.

Public function Const

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.

Public function Const

FVirtualText...

 

GetProducerHandle()

Getter for the associated virtual texture producer. Call on render thread only.

Public function Const

int32

 

GetRemoveLowMips()

Public getter for virtual texture removed low mips

Public function Const

bool

 

GetSinglePhysicalSpace()

Public getter for virtual texture using single physical space flag.

Public function Const

int32

 

GetSize()

Public getter for virtual texture size. This is derived from the TileCount and TileSize.

Public function Const

int32

 

GetTileBorderSize()

Public getter for virtual texture tile border size

Public function Const

int32

 

GetTileCount()

Public getter for virtual texture tile count

Public function Const

int32

 

GetTileSize()

Public getter for virtual texture tile size

Public function Const

FVector4

 

GetUniformParameter

(
    int32 Index
)

Getter for the shader uniform parameters.

Public function

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.

Protected function

void

 

InitNullResource()

Initialize the render resources with a null producer. This kicks off render thread work.

Protected function

void

 

InitResource

(
    IVirtualTexture* InProducer,
    FVTProducerDescription const& InPr...
)

Initialize the render resources. This kicks off render thread work.

Public function Const

bool

 

IsLayerSRGB

(
    int32 LayerIndex
)

Return true if the virtual texture layer should be sampled as sRGB

Public function Const

bool

 

IsLayerYCoCg

(
    int32 LayerIndex
)

Return true if the virtual texture layer should be sampled as YCoCg

Public function

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

Protected function Virtual Const

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

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Classes

Name

Description

Public struct

FInitSettings

Structure containing additional settings for initializing the producer.

Deprecated Variables

Name Description

Protected variable

int32

 

Size_DEPRECATED

Deprecated size of virtual texture.

Protected variable

TObjectPtr< cla...

 

StreamingTexture_DEPRECATED

Deprecated texture object containing streamed low mips.