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

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

 

bEnable

Enable usage of the virtual texture.

Protected variable

bool

 

bEnableScalability

Enable device scalability settings to modify the TileCount of the virtual texture.

Protected variable

bool

 

bPrivateSpace

Enable private page table allocation.

Protected variable

bool

 

bSinglePhysicalSpace

Enable page table channel packing.

Protected variable

ERuntimeVirtualTextureMaterialType

 

MaterialType

Contents of virtual texture.

Protected variable

int32

 

RemoveLowMips

Number of low mips to cut from the virtual texture.

Protected variable

URuntimeVirtualTextureStreamingProxy *

 

StreamingTexture

Texture object containing streamed low mips.

Protected variable

int32

 

StreamLowMips

Number of low mips to serialize and stream for 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& ObjectInitializer
)

Destructors

Name Description

Public function

~URuntimeVirtualTexture()

Functions

Name Description

Public function Const

IVirtualTexture *

 

CreateStreamingTextureProducer

(
    IVirtualTexture* InProducer,
    int32 InMaxLevel,
    int32& OutTransitionLevel
)

Create the streaming texture producer to wrap an existing producer.

Public function Const

IAllocatedVirtualTexture *

 

GetAllocatedVirtualTexture()

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

Public function Const

bool

 

GetClearTextures()

Returns true if texture pages should be cleared before render

Public function

bool

 

GetEnabled()

Public getter for enabled status

Public function Const

int32

 

GetEstimatedPageTableTextureMemoryKb()

Returns an approximate estimated value for the memory used by the page table texture.

Public function Const

int32

 

GetEstimatedPhysicalTextureMemoryKb()

Returns an approximate estimated value for the memory used by the physical texture.

Public function Static

int32

 

GetLayerCount

(
    ERuntimeVirtualTextureMaterialType InMaterialType
)

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

Public function Const

int32

 

GetLayerCount()

Returns number of texture layers in the virtual texture

Public function Const

EPixelFormat

 

GetLayerFormat

(
    int32 LayerIndex
)

Returns the texture format for the virtual texture layer

Public function Const

ERuntimeVirtualTextureMaterialType

 

GetMaterialType()

Get the material set that this virtual texture stores.

Public function Const

void

 

GetProducerDescription

(
    FVTProducerDescription& OutDesc,
    FTransform const& VolumeToWorld
)

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

Public function Const

FVirtualTextureProducerHandle

 

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

Public function Const

uint32

 

GetStreamingTextureBuildHash()

Get a hash of the current state to use for streaming texture invalidation.

Public function Const

int32

 

GetStreamLowMips()

Public getter for virtual texture streaming low mips

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 Static

int32

 

GetTileCount

(
    int32 InTileCount
)

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,
    FTransform const& VolumeToWorld
)

(Re)Initialize this object. Call this whenever we modify the producer or transform.

Public function

void

 

InitializeStreamingTexture

(
    uint32 InSizeX,
    uint32 InSizeY,
    uint8* InData
)

Initialize the low mip streaming texture with the passed in size and data.

Protected function

void

 

InitNullResource()

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

Protected function

void

 

InitResource

(
    IVirtualTexture* InProducer,
    FTransform const& VolumeToWorld
)

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 >& 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

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyChangedEvent
)

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.

Protected function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

Name Description

Protected variable

int32

 

Size_DEPRECATED

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback