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 > Components > URuntimeVirtualTextureComponent

Light Theme

Dark Theme

URuntimeVirtualTextureComponent

Component used to place a [URuntimeVirtualTexture](API\Runtime\Engine\VT\URuntimeVirtualTexture) in the world.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

URuntimeVirtualTextureComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/RuntimeVirtualTextureComponent.h
Include	#include "Components/RuntimeVirtualTextureComponent.h"

Syntax

class URuntimeVirtualTextureComponent : public USceneComponent

Remarks

Component used to place a URuntimeVirtualTexture in the world.

Variables

	Name	Description
bool	bBuildDebugStreamingMips	Build the streaming low mips using debug coloring.
bool	bBuildStreamingMipsButton	Placeholder for details customization button.
bool	bEnableCompressCrunch	Enable Crunch texture compression for the streaming low mips.
bool	bEnableScalability	Set to true to enable scalability settings for the virtual texture.
bool	bHidePrimitives	Hide primitives in the main pass.
TSoftObjectPtr<...	BoundsAlignActor	Actor to align rotation to. If set this actor is always included in the bounds calculation.
bool	bSetBoundsButton	Placeholder for details customization button.
bool	bSnapBoundsToLandscape	If the Bounds Align Actor is a Landscape then this will snap the bounds so that virtual texture texels align with landscape vertex positions.
bool	bUseStreamingLowMipsInEditor	Use any streaming low mips when rendering in editor.
FGetHidePrimiti...	HidePrimitivesDelegate
FDelegateHandle	PieEndDelegateHandle	Delegate handle for our function called on PIE end.
uint32	ScalabilityGroup	Group index of the scalability settings to use for the virtual texture.
FRuntimeVirtual...	SceneProxy	Scene proxy object. Managed by the scene but stored here.
UVirtualTexture...	StreamingTexture	Texture object containing streamed low mips.
int32	StreamLowMips	Number of low mips to serialize and stream for the virtual texture.
URuntimeVirtual...	VirtualTexture	The virtual texture object to use.

Constructors

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

Functions

	Name	Description
uint64	CalculateStreamingTextureSettingsHash()	Calculate a hash used to determine if the StreamingTexture contents are valid for use.
TSoftObjectP...	GetBoundsAlignActor()	Get the BoundsAlignActor on this component.
FGetHidePrim...	GetHidePrimitivesDelegate()	Get the delegate used to extend the calculation of the HidePrimitives state.
void	GetHidePrimitiveSettings ( bool& OutHidePrimitiveEditor, bool& OutHidePrimitiveGame )	Get the full hide primitive state including the evaluating the GetHidePrimitivesDelegate delegate.
uint32	GetScalabilityGroup()	Get group index of the scalability settings.
bool	GetSnapBoundsToLandscape()	Get if SnapBoundsToLandscape is set on this component.
UVirtualText...	GetStreamingTexture()	Get the streaming virtual texture object on this component.
FTransform	GetTexelSnapTransform()	Get a translation to account for any vertex sample offset from the use of bSnapBoundsToLandscape.
URuntimeVirt...	GetVirtualTexture()	Get the runtime virtual texture object on this component.
void	InitializeStreamingTexture ( uint32 InSizeX, uint32 InSizeY, uint8* InData )	Initialize the low mip streaming texture with the passed in size and data.
void	Invalidate ( FBoxSphereBounds const& WorldBound... )	This function marks an area of the runtime virtual texture as dirty.
bool	IsBuildDebugStreamingMips()	Public getter for debug streaming mips flag.
bool	IsCrunchCompressed()	Public getter for crunch compression flag.
bool	IsScalable()	Get if scalability settings are enabled.
bool	IsStreamingLowMips()	Get if we want to use any streaming low mips on this component.
bool	IsStreamingTextureValid()	Returns true if the StreamingTexure contents are valid for use.
int32	NumStreamingMips()	Public getter for virtual texture streaming low mips
void	SetStreamingTexture ( UVirtualTextureBuilder* InText... )	Set a new asset to hold the low mip streaming texture.

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
	bool	IsVisible()	Returns true if this component is visible in the current context

Overridden from UActorComponent

	Name	Description
void	ApplyWorldOffset ( const FVector& InOffset, bool bWorldShift )	Called by owner actor on position shifting Component should update all relevant data structures to reflect new actor location
void	CheckForErrors()	Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
void	CreateRenderState_Concurrent ( FRegisterComponentContext* Con... )	Used to create any rendering thread information for this component
void	DestroyRenderState_Concurrent()	Used to shut down any rendering thread structure for this component
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.
void	SendRenderTransform_Concurrent()	Called to send a transform update for this component to the rendering thread

Overridden from UObject

		Name	Description
	bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.

Typedefs

Name	Description
FGetHidePrimitivesDelegate	Delegate that this virtual texture will call to evaluated the full HidePrimitives state.

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

Take our survey

Dismiss