URuntimeVirtualTextureComponent | Unreal Engine 5.6 Documentation

Component used to place a URuntimeVirtualTexture in the world.


Name	URuntimeVirtualTextureComponent
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/Components/RuntimeVirtualTextureComponent.h
Include Path	#include "Components/RuntimeVirtualTextureComponent.h"

Syntax

UCLASS (Blueprintable, ClassGroup=Rendering,  
       HideCategories=(Activation, Collision, Cooking, HLOD, Mobility, LOD, Navigation, Object, Physics),  
       MinimalAPI)  
class URuntimeVirtualTextureComponent : public USceneComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → URuntimeVirtualTextureComponent

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
URuntimeVirtualTextureComponent ( const FObjectInitializer& ObjectInitializer )		Components/RuntimeVirtualTextureComponent.h

Enums

Public

Name	Remarks
EStreamingTextureStatusFlags

Typedefs

Name	Type	Remarks	Include Path
FGetHidePrimitivesDelegate	TMulticastDelegate_TwoParams< void, bool &, bool & >	Delegate that this virtual texture will call to evaluated the full HidePrimitives state.	Components/RuntimeVirtualTextureComponent.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
SceneProxy	FRuntimeVirtualTextureSceneProxy *	Scene proxy object. Managed by the scene but stored here.	Components/RuntimeVirtualTextureComponent.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
TSoftObjectPtr< AActor > & GetBoundsAlignActor()	Get the BoundsAlignActor on this component.	Components/RuntimeVirtualTextureComponent.h
FVector4f GetCustomMaterialData()	Public getter for the custom material data on this component.	Components/RuntimeVirtualTextureComponent.h
float GetExpandBounds()	Get amount to expand the calculated bounds on this component.	Components/RuntimeVirtualTextureComponent.h
FGetHidePrimitivesDelegate & GetHidePrimitivesDelegate()	Get the delegate used to extend the calculation of the HidePrimitives state.	Components/RuntimeVirtualTextureComponent.h
void GetHidePrimitiveSettings ( bool& OutHidePrimitiveEditor, bool& OutHidePrimitiveGame ) const	Get the full hide primitive state including the evaluating the GetHidePrimitivesDelegate delegate.	Components/RuntimeVirtualTextureComponent.h
TEnumAsByte< ETextureLossyCompressionAmount > GetLossyCompressionAmount()	Public getter for lossy compression setting.	Components/RuntimeVirtualTextureComponent.h
EVTProducerPriority GetPriority()	Public getter for priority setting.	Components/RuntimeVirtualTextureComponent.h
uint32 GetScalabilityGroup()	Get group index of the scalability settings.	Components/RuntimeVirtualTextureComponent.h
bool GetSnapBoundsToLandscape()	Get if SnapBoundsToLandscape is set on this component.	Components/RuntimeVirtualTextureComponent.h
FLinearColor GetStreamingMipsFixedColor()	Public getter for streaming mips fixed color.	Components/RuntimeVirtualTextureComponent.h
UVirtualTextureBuilder * GetStreamingTexture()	Get the streaming virtual texture object on this component.	Components/RuntimeVirtualTextureComponent.h
EStreamingTextureStatusFlags GetStreamingTextureStatus ( EShadingPath ShadingPath ) const	Returns the status of the StreamingTexure contents for the specified shading path	Components/RuntimeVirtualTextureComponent.h
EStreamingTextureStatusFlags GetStreamingTextureStatus ()	Returns the status of the StreamingTexure contents, taking into account all rendering modes	Components/RuntimeVirtualTextureComponent.h
FTransform GetTexelSnapTransform()	Get a translation to account for any vertex sample offset from the use of bSnapBoundsToLandscape.	Components/RuntimeVirtualTextureComponent.h
URuntimeVirtualTexture * GetVirtualTexture()	Get the runtime virtual texture object on this component.	Components/RuntimeVirtualTextureComponent.h
void InitializeStreamingTexture ( EShadingPath ShadingPath, uint32 InSizeX, uint32 InSizeY, uint8* InData )	Initialize the low mip streaming texture with the passed in size and data.	Components/RuntimeVirtualTextureComponent.h
void Invalidate ( FBoxSphereBounds const& WorldBounds, EVTInvalidatePriority InvalidatePriority )	This function marks an area of the runtime virtual texture as dirty.	Components/RuntimeVirtualTextureComponent.h	BlueprintCallable Category=VirtualTexture
bool IsEnabledInScene()	Get if the runtime virtual texture should be fully instantiated by it's render proxy.	Components/RuntimeVirtualTextureComponent.h
bool IsScalable()	Get if scalability settings are enabled.	Components/RuntimeVirtualTextureComponent.h
bool IsStreamingLowMips ( EShadingPath ShadingPath ) const	Get if we want to use any streaming low mips on this component.	Components/RuntimeVirtualTextureComponent.h
bool IsStreamingLowMipsOnly()	Public getter for using streaming low mips only.	Components/RuntimeVirtualTextureComponent.h
bool IsStreamingTextureInvalid ()	Returns whether the StreamingTexure contents is valid for use, taking into account all rendering modes	Components/RuntimeVirtualTextureComponent.h
bool IsStreamingTextureInvalid ( EShadingPath ShadingPath ) const	Returns whether the StreamingTexure contents is valid for use for the specified shading path	Components/RuntimeVirtualTextureComponent.h
int32 NumStreamingMips()	Public getter for virtual texture streaming low mips	Components/RuntimeVirtualTextureComponent.h
void RequestPreload ( FBoxSphereBounds const& WorldBounds, int32 Level )	Request preload of an area of the runtime virtual texture at a given mip level.	Components/RuntimeVirtualTextureComponent.h	BlueprintCallable Category=VirtualTexture
void SetBoundsAlignActor ( AActor* InActor )	Get the BoundsAlignActor on this component.	Components/RuntimeVirtualTextureComponent.h
void SetStreamingTexture ( UVirtualTextureBuilder* InTexture )	Set a new asset to hold the low mip streaming texture.	Components/RuntimeVirtualTextureComponent.h
void SetVirtualTexture ( URuntimeVirtualTexture* InVirtualTexture )	Set the runtime virtual texture object on this component.	Components/RuntimeVirtualTextureComponent.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
uint64 CalculateStreamingTextureSettingsHash ()	Calculate a hash used to determine if the StreamingTexture contents are valid for use.	Components/RuntimeVirtualTextureComponent.h
bool IsActiveInWorld()		Components/RuntimeVirtualTextureComponent.h

Overridden from USceneComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld ) const	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.	Components/RuntimeVirtualTextureComponent.h

Overridden from UActorComponent

Name	Remarks	Include Path
virtual 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	Components/RuntimeVirtualTextureComponent.h
virtual 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.	Components/RuntimeVirtualTextureComponent.h
virtual void CreateRenderState_Concurrent ( FRegisterComponentContext* Context )	Used to create any rendering thread information for this component	Components/RuntimeVirtualTextureComponent.h
virtual void DestroyRenderState_Concurrent ()	Used to shut down any rendering thread structure for this component	Components/RuntimeVirtualTextureComponent.h
virtual void OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.	Components/RuntimeVirtualTextureComponent.h
virtual void OnUnregister ()	Called when a component is unregistered.	Components/RuntimeVirtualTextureComponent.h
virtual void SendRenderTransform_Concurrent ()	Called to send a transform update for this component to the rendering thread	Components/RuntimeVirtualTextureComponent.h
virtual bool ShouldCreateRenderState()	Return true if CreateRenderState() should be called	Components/RuntimeVirtualTextureComponent.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void BeginDestroy()		Components/RuntimeVirtualTextureComponent.h
virtual bool CanEditChange ( const FProperty* InProperty ) const		Components/RuntimeVirtualTextureComponent.h
virtual bool IsReadyForFinishDestroy()		Components/RuntimeVirtualTextureComponent.h
virtual void Serialize ( FArchive& Ar )		Components/RuntimeVirtualTextureComponent.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
bUseStreamingMipsInEditor_DEPRECATED	bool		Components/RuntimeVirtualTextureComponent.h