code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) * > * GetAssetUserDataArray() const


module: Engine

code: virtual [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) * GetAssetUserDataOfClass ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) > InUserDataClass )


code: [UBodySetup](API\Runtime\Engine\PhysicsEngine\UBodySetup) * GetBodySetup() const


description: Returns the bounding box, in local space including bounds extension(s), of the StaticMesh asset

code: FBox GetBoundingBox() const


description:
Returns the number of bounds of the mesh.
The bounding box represented as box origin with extents and also a sphere that encapsulates that box

code: FBoxSphereBounds GetBounds() const


description: Returns a one line description of an object for viewing in the thumbnail view of the generic browser


description: Get whether this mesh should use LOD streaming for the given platform.

code: bool GetEnableLODStreaming ( const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform ) const


code: const FBoxSphereBounds & GetExtendedBounds() const


code: [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * GetHiResMeshDescription() const


code: const [FStaticMeshSourceModel](API\Runtime\Engine\Engine\FStaticMeshSourceModel) & GetHiResSourceModel() const


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetLightingGuid() const


code: int32 GetLightMapResolution() const


code: float GetLightmapUVDensity() const


code: int32 GetLightmapUVVersion() const


description: Returns the render data to use for exporting the specified LOD. This method should always be called when exporting a static mesh.

code: const [FStaticMeshLODResources](API\Runtime\Engine\FStaticMeshLODResources) & GetLODForExport ( int32 LODIndex ) const


description: Retrieves the names of all LOD groups.

code: static void GetLODGroups ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutLODGroups )


description: Retrieves the localized display names of all LOD groups.

code: static void GetLODGroupsDisplayNames ( [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutLODGroupsDisplayNames )


description: Helper function for resource tracking, construct a name using the mesh's path name and LOD index .

code: static [FName](API\Runtime\Core\UObject\FName) GetLODPathName ( const [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * Mesh, int32 LODIndex )


description:
Gets a Material given a MaterialIndexand an LOD number
Requested material

code: [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetMaterial ( int32 MaterialIndex ) const


description:
Returns the material bounding box. Computed from all lod-section using the material index.
false if some parameters are invalid

code: FBox GetMaterialBox ( int32 MaterialIndex, const FTransform & Transform ) const


code: int32 GetMaterialIndexFromImportedMaterialSlotName ( [FName](API\Runtime\Core\UObject\FName) ImportedMaterialSlotName ) const


description:
Gets a Material index given a slot name
Requested material

code: int32 GetMaterialIndex ( [FName](API\Runtime\Core\UObject\FName) MaterialSlotName ) const


description: Return the MeshDescription associate to the LODIndex. The mesh description can be created on the fly if it was null and there is aFRawMeshdata for this LODIndex.

code: [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * GetMeshDescription ( int32 LodIndex ) const


description: An optional string identifying the mesh data.

code: virtual void GetMeshId ( [FString](API\Runtime\Core\Containers\FString) & OutMeshId )


code: void GetMinimumLODForPlatforms ( [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), int32 > & PlatformMinimumLODs ) const


code: int32 GetMinimumLODForPlatform ( const [FName](API\Runtime\Core\UObject\FName) & PlatformName ) const


code: int32 GetMinimumLODForQualityLevel ( const [FName](API\Runtime\Core\UObject\FName) & QualityLevel ) const


code: void GetMinimumLODForQualityLevels ( [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), int32 > & QualityLevelMinimumLODs ) const


code: const [FPerPlatformInt](API\Runtime\Engine\FPerPlatformInt) & GetMinLOD() const


code: void GetMinLODForQualityLevels ( [TMap](API\Runtime\Core\Containers\TMap)< EPerQualityLevels, int32 > & QualityLevelMinimumLODs, int32 & Default ) const


description: Choose either PerPlatform or PerQuality override. Note: Enable PerQuality override in the Project Settings/ General Settings/ UseStaticMeshMinLODPerQualityLevels

code: int32 GetMinLODIdx ( bool bForceLowestLODIdx ) const


code: virtual FIoFilenameHash GetMipIoFilenameHash ( const int32 MipIndex ) const


code: [UNavCollisionBase](API\Runtime\Engine\AI\Navigation\UNavCollisionBase) * GetNavCollision() const


code: const FVector & GetNegativeBoundsExtension() const


description: Returns the number of LODs used by the mesh.

code: int32 GetNumLODs() const


description: Returns the number of triangles of the Nanite representation of this mesh.

code: int32 GetNumNaniteTriangles() const


description: Returns the number of vertices of the Nanite representation of this mesh.

code: int32 GetNumNaniteVertices() const


description: Returns number of Sections that this StaticMesh has, in the supplied LOD (LOD 0 is the highest)

code: int32 GetNumSections ( int32 InLOD ) const


description: Return the number of sections of the StaticMesh with collision enabled


description: Returns the number of tex coords for the specified LOD.

code: int32 GetNumTexCoords ( int32 LODIndex ) const


description: Returns the number of triangles in the render data for the specified LOD.

code: int32 GetNumTriangles ( int32 LODIndex ) const


description:
Returns the number of UV channels for the given LOD of a StaticMesh.
the number of UV channels.

code: int32 GetNumUVChannels ( int32 LODIndex )


description: Returns the number of vertices for the specified LOD.

code: int32 GetNumVertices ( int32 LODIndex ) const


code: const [FMeshSectionInfoMap](API\Runtime\Engine\Engine\FMeshSectionInfoMap) & GetOriginalSectionInfoMap() const


description:
Interface for retrieving triangle mesh collision data from the implementing object
true if successful, false if unable to successfully fill in data structure

code: virtual bool GetPhysicsTriMeshData ( struct [FTriMeshCollisionData](API\Runtime\PhysicsCore\FTriMeshCollisionData) * CollisionData, bool InUseAllTriData )


description: Get a static mesh render data for requested platform.

code: static [FStaticMeshRenderData](API\Runtime\Engine\FStaticMeshRenderData) & GetPlatformStaticMeshRenderData ( [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * Mesh, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * Platform )


code: const FVector & GetPositiveBoundsExtension() const


code: const [FPerQualityLevelInt](API\Runtime\Engine\FPerQualityLevelInt) & GetQualityLevelMinLOD() const


description: Get a copy of the reduction settings for a specified LOD index.

code: [FMeshReductionSettings](API\Runtime\Engine\Engine\FMeshReductionSettings) GetReductionSettings ( int32 LODIndex ) const


code: virtual EStreamableRenderAssetType GetRenderAssetType() const


code: const [FStaticMeshRenderData](API\Runtime\Engine\FStaticMeshRenderData) * GetRenderData() const


description: Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


code: const [FMeshSectionInfoMap](API\Runtime\Engine\Engine\FMeshSectionInfoMap) & GetSectionInfoMap() const


description: Returns a list of sockets with the provided tag.

code: [TArray](API\Runtime\Core\Containers\TArray)< [UStaticMeshSocket](API\Runtime\Engine\Engine\UStaticMeshSocket) * > GetSocketsByTag ( const [FString](API\Runtime\Core\Containers\FString) & InSocketTag ) const


code: const [FStaticMeshSourceModel](API\Runtime\Engine\Engine\FStaticMeshSourceModel) & GetSourceModel ( int32 Index ) const


code: [FStaticMeshSourceModel](API\Runtime\Engine\Engine\FStaticMeshSourceModel) & GetSourceModel ( int32 Index )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FStaticMeshSourceModel](API\Runtime\Engine\Engine\FStaticMeshSourceModel) > & GetSourceModels() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FStaticMaterial](API\Runtime\Engine\Engine\FStaticMaterial) > & GetStaticMaterials()


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FStaticMaterial](API\Runtime\Engine\Engine\FStaticMaterial) > & GetStaticMaterials() const


description: Return a new StaticMeshDescription referencing the MeshDescription of the given LOD

code: [UStaticMeshDescription](API\Runtime\StaticMeshDescription\UStaticMeshDescription) * GetStaticMeshDescription ( int32 LODIndex )


description:
Returns an estimate of how much data would be retrieved by GetPhysicsTriMeshData.
true if successful, false if unable to successfully fill in data structure

code: virtual bool GetTriMeshSizeEstimates ( struct [FTriMeshCollisionDataEstimates](API\Runtime\PhysicsCore\FTriMeshCollisionDataEstimates) & OutTriMeshEstimates, bool bInUseAllTriData ) const


description:
Returns the UV channel data for a given material index. Used by the texture streamer. This data applies to all lod-section using the same material.
the data, or null if none exists.

code: const [FMeshUVChannelInfo](API\Runtime\Engine\FMeshUVChannelInfo) * GetUVChannelData ( int32 MaterialIndex ) const


description: Returns vertex color data by position. For matching to reimported meshes that may have changed or copying vertex paint data from mesh to mesh.

code: void GetVertexColorData ( [TMap](API\Runtime\Core\Containers\TMap)< FVector3f, [FColor](API\Runtime\Core\Math\FColor) > & VertexColorData )


description: Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete.

code: virtual bool HasPendingRenderResourceInitialization() const


description: Returns true if the mesh has valid Nanite render data.

code: bool HasValidNaniteData() const


description: Returns true if the mesh has data that can be rendered.

code: bool HasValidRenderData ( bool bCheckLODForVerts, int32 LODIndex ) const


description: Initializes the static mesh's render resources.

code: virtual void InitResources()


description:
Inserts an empty UV channel at the specified channel index on the given LOD of a StaticMesh.
true if a UV channel was added.

code: bool InsertUVChannel ( int32 LODIndex, int32 UVChannelIndex )


description: Deprecated*IsBuiltAtRuntime()is no longer used.

code: bool IsBuiltAtRuntime() const


description: Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData

code: virtual bool IsCachedCookedPlatformDataLoaded ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Returns whether or not the asset is currently being compiled

code: virtual bool IsCompiling() const


description:
Generic function to validate objects during changelist validations, etc.
Valid if this object has data validation rules set up for it and the data for this object is valid. Returns Invalid if it does not pass the rules. Returns NotValidated if no rules are set for this object.

code: virtual EDataValidationResult IsDataValid ( class [FDataValidationContext](API\Runtime\CoreUObject\Misc\FDataValidationContext) & Context ) const


code: bool IsMeshDescriptionValid ( int32 LodIndex ) const


description: Check the QualitLevel property is enabled for MinLod.

code: bool IsMinLodQualityLevelEnable() const


description: Returns true if this SM should have Nanite built for it. This also includes the result ofIsNaniteForceEnabled().

code: bool IsNaniteEnabled() const


description: Returns true if this SM should always have Nanite data built. This forces the SM to be Nanite even if the flag in the editor is set to false.

code: bool IsNaniteForceEnabled() const


description: TODO: Temp/deprecated hack - Do not call.

code: bool IsNaniteLandscape() const


description:
Called during async load to determine if PostLoad can be called on the loading thread.
true if this object's PostLoad is thread safe

code: virtual bool IsPostLoadThreadSafe() const


description:
Called to check if the object is ready for FinishDestroy. This is called after BeginDestroy to check the completion of the potentially asynchronous object cleanup.
True if the object's asynchronous cleanup has completed and it is ready for FinishDestroy to be called.

code: virtual bool IsReadyForFinishDestroy()


description: Return true if the reduction settings are setup to reduce a LOD

code: bool IsReductionActive ( int32 LODIndex ) const


code: bool IsSourceModelValid ( int32 Index ) const


code: bool LoadHiResMeshDescription ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & OutMeshDescription ) const


className: MinimumAutoLODPixelError

code: static const float MinimumAutoLODPixelError = (1.e-8f);


description: Configures this SM as bHasNavigationData = false and clears stored NavCollision

code: void MarkAsNotHavingNavigationData()


description: Performs a Modify on StaticMeshDescription objects for all LODs

code: bool ModifyAllMeshDescriptions ( bool bAlwaysMarkDirty )


description: Performs a Modify on the hi-res StaticMeshDescription

code: bool ModifyHiResMeshDescription ( bool bAlwaysMarkDirty )


description: Performs a Modify on the StaticMeshDescription object pertaining to the given LODIndex

code: bool ModifyMeshDescription ( int32 LodIndex, bool bAlwaysMarkDirty )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FStaticMeshSourceModel](API\Runtime\Engine\Engine\FStaticMeshSourceModel) > && MoveSourceModels()


code: static void OnLodStrippingQualityLevelChanged ( [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * Variable )


description: Get multicast delegate broadcast after mesh building

code: FOnPostMeshBuild & OnPostMeshBuild()


description: Get multicast delegate broadcast prior to mesh building

code: FOnPreMeshBuild & OnPreMeshBuild()


description:
Poll for availability of asynchronously-populated triangle mesh collision data
true if the triangle mesh collision can be accessed without blocking, false otherwise

code: virtual bool PollAsyncPhysicsTriMeshData ( bool InUseAllTriData ) const


description: Called after duplication & serialization and before PostLoad. Used to e.g. make sureUStaticMesh'sUModelgets copied as well. Note: NOT called on components on actor duplication (alt-drag or copy-paste). Use PostEditImport as well to cover that case.

code: virtual void PostDuplicate ( bool bDuplicateForPIE )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after applying a transaction to the object. Default implementation simply calls PostEditChange.

code: virtual void PostEditUndo()


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: This is called when a property is about to be modified externally

code: virtual void PreEditChange ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyAboutToChange )


description: Caches derived renderable for cooked platforms currently active.


description: Delete current NavCollision and create a new one if needed

code: void RecreateNavCollision()


description: Registers the mesh attributes required by the mesh description for a static mesh.

code: static void RegisterMeshAttributes ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription )


description: Releases the static mesh's render resources.

code: virtual void ReleaseResources()


description: Remove a socket object in this StaticMesh by providing it's pointer. UseFindSocket()if needed.

code: void RemoveSocket ( [UStaticMeshSocket](API\Runtime\Engine\Engine\UStaticMeshSocket) * Socket )


code: void RemoveSourceModel ( int32 Index )


code: virtual void RemoveUserDataOfClass ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) > InUserDataClass )


description:
Removes the UV channel at the specified channel index on the given LOD of a StaticMesh.
true if the UV channel was removed.

code: bool RemoveUVChannel ( int32 LODIndex, int32 UVChannelIndex )


description: Removes all vertex colors from this mesh and rebuilds it (Editor only

code: void RemoveVertexColors()


description: UStaticMesh::Serialize

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Set AssetImportData for the static mesh

code: void SetAssetImportData ( class [UAssetImportData](API\Runtime\Engine\EditorFramework\UAssetImportData) * InAssetImportData )


code: void SetBodySetup ( [UBodySetup](API\Runtime\Engine\PhysicsEngine\UBodySetup) * InBodySetup )


description: SourceStaticMesh - The data we want to use to add or modify the specified lod  LodIndex - The lod index we want to add or modify.  SourceDataFilename - The source filename thta need to set into the LOD to allow re-import.

code: bool SetCustomLOD ( const [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * SourceStaticMesh, int32 LodIndex, const [FString](API\Runtime\Core\Containers\FString) & SourceDataFilename )


code: void SetExtendedBounds ( const FBoxSphereBounds & InExtendedBounds )


code: void SetHiResSourceModel ( [FStaticMeshSourceModel](API\Runtime\Engine\Engine\FStaticMeshSourceModel) && SourceModel )


description: Deprecated*SetIsBuiltAtRuntime()is no longer used.

code: void SetIsBuiltAtRuntime ( bool InIsBuiltAtRuntime )


code: void SetLightingGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InLightingGuid )


code: void SetLightMapCoordinateIndex ( int32 InLightMapCoordinateIndex )


code: void SetLightMapResolution ( int32 InLightMapResolution )


code: void SetLightmapUVDensity ( float InLightmapUVDensity )


code: void SetLODGroup ( [FName](API\Runtime\Core\UObject\FName) NewGroup, bool bRebuildImmediately, bool bAllowModify )


description: Sets a Material given a MaterialIndex

code: void SetMaterial ( int32 MaterialIndex, [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * NewMaterial )


code: void SetMinimumLODForPlatform ( const [FName](API\Runtime\Core\UObject\FName) & PlatformName, int32 InMinLOD )


code: void SetMinimumLODForPlatforms ( const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), int32 > & PlatformMinimumLODs )


code: void SetMinLOD ( [FPerPlatformInt](API\Runtime\Engine\FPerPlatformInt) InMinLOD )


code: void SetMinLODForQualityLevels ( const [TMap](API\Runtime\Core\Containers\TMap)< EPerQualityLevels, int32 > & QualityLevelMinimumLODs, int32 Default )


code: void SetMinLODIdx ( int32 InMinLOD )


code: void SetNavCollision ( [UNavCollisionBase](API\Runtime\Engine\AI\Navigation\UNavCollisionBase) * )


code: void SetNegativeBoundsExtension ( FVector InNegativeBoundsExtension )


code: void SetPositiveBoundsExtension ( FVector InPositiveBoundsExtension )


code: void SetQualityLevelMinLOD ( [FPerQualityLevelInt](API\Runtime\Engine\FPerQualityLevelInt) InMinLOD )


code: void SetRenderData ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< class [FStaticMeshRenderData](API\Runtime\Engine\FStaticMeshRenderData) > && InRenderData )


code: void SetSourceModels ( [TArray](API\Runtime\Core\Containers\TArray)< [FStaticMeshSourceModel](API\Runtime\Engine\Engine\FStaticMeshSourceModel) > && SourceModels )


description:
Sets the texture coordinates at the specified UV channel index on the given LOD of a StaticMesh.
true if the UV channel could be set.

code: bool SetUVChannel ( int32 LODIndex, int32 UVChannelIndex, const [TMap](API\Runtime\Core\Containers\TMap)< [FVertexInstanceID](API\Runtime\MeshDescription\FVertexInstanceID), FVector2D > & TexCoords )


description: Sets vertex color data by position. Map of vertex color data by position is matched to the vertex position in the mesh and nearest matching vertex color is used.

code: void SetVertexColorData ( const [TMap](API\Runtime\Core\Containers\TMap)< FVector3f, [FColor](API\Runtime\Core\Math\FColor) > & VertexColorData )


description:
Loads mips from disk to memory. Only usable if the asset is streamable.
Whether any mips were resquested to be loaded.

code: virtual bool StreamIn ( int32 NewMipCount, bool bHighPrio )


description:
Unload some mips from memory. Only usable if the asset is streamable.
Whether any mips were requested to be unloaded.

code: virtual bool StreamOut ( int32 NewMipCount )


description: Try to cancel any pending async tasks. Returns true if there is no more async tasks pending, false otherwise.

code: bool TryCancelAsyncTasks()


description: Update missing material UV channel data used for texture streaming.

code: void UpdateUVChannelData ( bool bRebuildAll )


description: Do we want to create a negative version of this mesh

code: virtual bool WantsNegXTriMesh()


description: All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms)


code: UStaticMesh ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Default constructor


className: UStaticMesh

description: UStaticMeshComponent

code: class UStaticMesh : public [UStreamableRenderAsset](API\Runtime\Engine\Engine\UStreamableRenderAsset), public [IInterface_CollisionDataProvider](API\Runtime\Engine\Interfaces\IInterface_CollisionDataProvider), public [IInterface_AssetUserData](API\Runtime\Engine\Interfaces\IInterface_AssetUserData), public [IInterface_AsyncCompilation](API\Runtime\Engine\Interfaces\IInterface_AsyncCompilation)

AssetImportData

type: TObjectPtr< cla...

description: Importing data and options used for this mesh

AssetUserData

type: TArray<TObject...

description: Array of user data stored with the asset

AsyncTask

type: TUniquePtr<FSt...

bAllowCPUAccess

type: uint8: 1

description: If true, will keep geometry data CPU-accessible in cooked builds, rather than uploading to GPU memory and releasing it from CPU memory.

bAutoComputeLODScreenSize

type: uint8:  1

description: If true, the screen sizes at which LODs swap are computed automatically.

bCustomizedCollision

type: bool

description: If the user has modified collision in any way or has custom collision imported.

bGenerateMeshDistanceField

description: Whether to generate a distance field for this mesh, which can be used by DistanceField Indirect Shadows.

bHasNavigationData

description: If true, mesh will have NavCollision property with additional data for navmesh generation and usage.

bRenderingResourcesInitialized

description: Tracks whether InitResources has been called, and rendering resources are initialized.

bRequiresLODDistanceConversion

description: If true on post load we need to calculate Display Factors from the loaded LOD distances.

bRequiresLODScreenSizeConversion

description: If true on post load we need to calculate resolution independent Display Factors from the loaded LOD screen sizes.

bSupportGpuUniformlyDistributedSampling

description: If true, a GPU buffer containing required data for uniform mesh surface sampling will be created at load time.

bSupportPhysicalMaterialMasks

description: If true, complex collision data will store UVs and face remap table for use when performing PhysicalMaterialMask lookups in cooked builds.

bSupportRayTracing

description: If true, a ray tracing acceleration structure will be built for this mesh and it may be used in ray tracing effects

bSupportUniformlyDistributedSampling

description: Mesh supports uniformly distributed sampling in constant time.

BuildCacheAutomationTestGuid

type: FGuid

description: This transient guid is use by the automation framework to modify the DDC key to force a build.

DistanceFieldSelfShadowBias

type: float

description: Useful for reducing self shadowing from distance field methods when using world position offset to animate the mesh's vertices.

EditorCameraPosition

type: FAssetEditorOrb...

description: The stored camera position to use as a default for the static mesh editor

ElementToIgnoreForTexFactor

description: Indexof an element to ignore while gathering streaming texture factors.

ImportVersion

description: The last import version

LODForCollision

description: Specifies which mesh LOD to use for complex (per-poly) collision.

LODGroup

type: FName

description: The LOD group to which this mesh belongs.

MaterialRemapIndexPerImportVersion

type: TArray<FMateri...

MinQualityLevelLOD

type: FPerQualityLeve...

description: PerQuality override.

NaniteSettings

type: FMeshNaniteSett...

description: Settings related to building Nanite data.

NumStreamedLODs

type: FPerPlatformInt

description: If non-negative, specify the maximum number of streamed LODs.

OnExtendedBoundsChanged

type: FOnExtendedBoun...

OnMeshChanged

type: FOnMeshChanged

ReleaseResourcesFence

type: FRenderCommandF...

description: A fence which is used to keep track of the rendering thread releasing the static mesh resources.

Sockets

description: Array of named socket locations, set up in editor and used as a shortcut instead of specifying everything explicitly to AttachComponent in the StaticMeshComponent.

SpeedTreeWind

type: TSharedPtr< cla...

description: Data that is only available if this static mesh is an imported SpeedTree

ThumbnailInfo

description: Information for thumbnail rendering


className: UStaticMeshDescriptionBulkData

description: UObjectwrapper forFMeshDescriptionBulkData

code: class UStaticMeshDescriptionBulkData : public [UMeshDescriptionBaseBulkData](API\Runtime\MeshDescription\UMeshDescriptionBaseBulkData)


description:
Utility to associate an actor with a socket
bool true if successful, false if not

code: bool AttachActor ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, class [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent) * MeshComp ) const


className: FChangedEvent

description: Broadcasts a notification whenever the socket property has changed.

code: class FChangedEvent : public TBaseMulticastDelegate_TwoParams< void, const class UStaticMeshSocket *, const class FProperty * >


description: Utility that returns the current matrix for this socket.

code: bool GetSocketMatrix ( FMatrix & OutMatrix, class [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent) const * MeshComp ) const


description: Utility that returns the current transform for this socket. Returns false if socket was not valid

code: bool GetSocketTransform ( FTransform & OutTransform, class [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent) const * MeshComp ) const


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: UStaticMeshSocket ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UStaticMeshSocket

code: class UStaticMeshSocket : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bSocketCreatedAtImport

description: Whether the socket was imported with the asset or created in the editor.

PreviewStaticMesh

type: TObjectPtr< cla...

RelativeLocation

type: FVector

RelativeRotation

type: FRotator

SocketName

description: Defines a named attachment location on theUStaticMesh.

Tag

type: FString


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: virtual int32 CalcCumulativeLODSize ( int32 NumLODs ) const


description: Tries to cancel a pending LOD change request. Requests cannot be canceled if they are in the finalization phase.

code: void CancelPendingStreamingRequest()


code: virtual bool DoesMipDataExist ( const int32 MipIndex ) const


code: FLODStreamingCallbackPayload &40; UPrimitiveComponent &42; InComponent, double InDeadlineDone, int32 ExpectedResidentMips, bool bInOnStreamIn, FLODStreamingCallback && InCallbackStreamingDone &41;


code: FLODStreamingCallbackPayload &40; UPrimitiveComponent &42; InComponent, double InDeadlineStart, FLODStreamingCallback && InCallbackStreamingStart, double InDeadlineDone, FLODStreamingCallback && InCallbackStreamingDone &41;


description:
Returns the combined LOD bias based on texture LOD group and LOD bias. Function name is legacy and incorrect, it is no longer cached
LOD bias

code: virtual int32 GetCachedLODBias() const


className: FLODStreamingCallbackPayload

code: struct FLODStreamingCallbackPayload

bIsExpectedResidentMipPayload

type: bool

CallbackDone

type: FLODStreamingCa...

Component

type: UPrimitiveCompo...

DeadlineDone

type: double


description: Get the per-asset last render time. FLT_MAX means never use UnknownRefHeuristic and the asset will only keep non-streamable LODs when there is no instance/reference in the scene

code: virtual float GetLastRenderTimeForStreaming() const


description: Get an integer representation of the LOD group

code: virtual int32 GetLODGroupForStreaming() const


code: virtual FIoFilenameHash GetMipIoFilenameHash ( const int32 MipIndex ) const


code: virtual EStreamableRenderAssetType GetRenderAssetType() const


code: const [FPerQualityLevelInt](API\Runtime\Engine\FPerQualityLevelInt) & GetNoRefStreamingLODBias() const


description: Return the streaming state of the render resources. Mirrors the state and lowers cache misses. Cleared if there are no resources.

code: const [FStreamableRenderResourceState](API\Runtime\Engine\Streaming\FStreamableRenderResourceState) & GetStreamableResourceState() const


description: Whether a stream in / out request is pending. Only one request can exists at anytime for a streamable asset. This also includes the resource initialization!

code: bool HasPendingInitOrStreaming ( bool bWaitForLODTransition ) const


code: virtual bool HasPendingLODTransition() const


description: Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete.

code: virtual bool HasPendingRenderResourceInitialization() const


description: Invalidates per-asset last render time. Mainly used to opt in UnknownRefHeuristic during LOD index calculation. See FStreamingRenderAsset::bUseUnknownRefHeuristic


description: Whether there is a pending update and it is locked within an update step. Used to prevent dealocks in SuspendRenderAssetStreaming().


description: Whether all miplevels of this texture have been fully streamed in, LOD settings permitting. Note that if optional mips are not mounted it will always return false.

code: bool IsFullyStreamedIn()


description:
Called to check if the object is ready for FinishDestroy. This is called after BeginDestroy to check the completion of the potentially asynchronous object cleanup.
True if the object's asynchronous cleanup has completed and it is ready for FinishDestroy to be called.

code: virtual bool IsReadyForFinishDestroy()


description: Whether the current asset render resource is streamable from a gamethread timeline.

code: bool IsStreamable() const


description: Links texture to the texture streaming manager.

code: void LinkStreaming()


description: Register a callback to get notified when a certain mip or LOD is resident or evicted.

code: void RegisterMipLevelChangeCallback ( [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * Component, int32 LODIdx, float TimeoutSecs, bool bOnStreamIn, FLODStreamingCallback && Callback )


description: Register a set of callbacks to get notified when new mips/LODs start streaming in and when streaming is complete. If the target mips/LODs are already streamed in, CallbackStreamingDone is called immediately and CallbackStreamingStart is not called.

code: void RegisterMipLevelChangeCallback ( [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * Component, float TimeoutStartSecs, FLODStreamingCallback && CallbackStreamingStart, float TimeoutDoneSecs, FLODStreamingCallback && CallbackStreamingDone )


description: Not thread safe and must be called on GT timeline but not necessarily on GT (e.g. ParallelFor called from GT).

code: void RemoveAllMipLevelChangeCallbacks()


description: Remove mip level change callbacks registered by a component.

code: void RemoveMipLevelChangeCallback ( [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * Component )


description: Tells the streaming system that it should force all mip-levels to be resident for a number of seconds.

code: void SetForceMipLevelsToBeResident ( float Seconds, int32 CinematicLODGroupMask )


code: void SetNoRefStreamingLODBias ( [FPerQualityLevelInt](API\Runtime\Engine\FPerQualityLevelInt) NewValue )


description:
Returns whether miplevels should be forced resident.
true if either transient or serialized override requests miplevels to be resident, false otherwise

code: virtual bool ShouldMipLevelsBeForcedResident() const


description:
Unload some mips from memory. Only usable if the asset is streamable.
Whether any mips were requested to be unloaded.

code: virtual bool StreamOut ( int32 NewMipCount )


description:
Loads mips from disk to memory. Only usable if the asset is streamable.
Whether any mips were resquested to be loaded.

code: virtual bool StreamIn ( int32 NewMipCount, bool bHighPrio )


description: Invoke registered mip level change callbacks.

code: void TickMipLevelChangeCallbacks ( [TArray](API\Runtime\Core\Containers\TArray)< [UStreamableRenderAsset](API\Runtime\Engine\Engine\UStreamableRenderAsset) * > * DeferredTickCBAssets )


code: void TickStreaming ( bool bSendCompletionEvents, [TArray](API\Runtime\Core\Containers\TArray)< [UStreamableRenderAsset](API\Runtime\Engine\Engine\UStreamableRenderAsset) * > * DeferredTickCBAssets )


description: Unlinks texture from the texture streaming manager.

code: void UnlinkStreaming()


description: Wait for any pending operation (like InitResource and Streaming) to complete.

code: void WaitForPendingInitOrStreaming ( bool bWaitForLODTransition, bool bSendCompletionEvents )


description: Wait for any pending operation and make sure that the asset streamer has performed requested ops on this asset.

code: void WaitForStreaming ( bool bWaitForLODTransition, bool bSendCompletionEvents )


code: UStreamableRenderAsset ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Destructor

code: virtual ~UStreamableRenderAsset()


className: UStreamableRenderAsset

code: class UStreamableRenderAsset : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bForceMiplevelsToBeResident

type: uint8:  1

description: Override whether to fully stream even if texture hasn't been rendered.

bGlobalForceMipLevelsToBeResident

description: Global and serialized version of ForceMiplevelsToBeResident.

bHasStreamingUpdatePending

description: Whether some mips might be streamed soon.

bIgnoreStreamingMipBias

description: When forced fully resident, ignores the streaming mip bias used to accommodate memory constraints.

bUseCinematicMipLevels

description: Whether to use the extra cinematic quality mip-levels, when we're forcing mip-levels to be resident.

CachedSRRState

type: FStreamableRend...

description: Gamethread coherent state of the resource.

ForceMipLevelsToBeResidentTimestamp

description: WorldSettings timestamp that tells the streamer to force all miplevels to be resident up until that time.

MipChangeCallbacks

type: TArray<FLODStr...

NumCinematicMipLevels

description: Number of mip-levels to use for cinematic quality.

PendingUpdate

type: TRefCountPtr< c...

description: An update structure used to handle streaming strategy.

StreamingIndex

description: FStreamingRenderAsset index used by the texture streaming system.


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


className: UStreamingSettings

description: Streaming settings.

code: class UStreamingSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)

ConsoleVariable

description: Whether to use the entire time limit even if blocked on I/O


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Upgrade parameters from Separable to Burley.

code: virtual void PostLoad()


code: USubsurfaceProfile ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: USubsurfaceProfile

description: Subsurface Scattering profile asset, can be specified at the material. Only for "Subsurface Profile" materials, is use during Screenspace Subsurface Scattering Don't change at runtime. All properties in here are per material - texture like variations need to come from properties that are in the GBuffer.

code: class USubsurfaceProfile : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Settings

type: FSubsurfaceProf...


description: Generate a frame time value, including subframe, using the high performance clock Using the high performance clock is faster but will make the value drift over time. This is an optimized version. Prefer GenerateTimecodeFromSystemTime, if the value need to be accurate.

code: static [FFrameTime](API\Runtime\Core\Misc\FFrameTime) GenerateFrameTimeFromHighPerformanceClock ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) Rate )


description: Generate a timecode value using the system clock.

code: static [FTimecode](API\Runtime\Core\Misc\FTimecode) GenerateTimecodeFromSystemTime ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) Rate )


description: Generate a timecode value using the high performance clock Using the high performance clock is faster but will make the value drift over time. This is an optimized version. Prefer GenerateTimecodeFromSystemTime, if the value need to be accurate.

code: static [FTimecode](API\Runtime\Core\Misc\FTimecode) GenerateTimecodeFromHighPerformanceClock ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) Rate )


description: Return current frame time. Since it may be called several times per frame, it is suggested to return a cached value.

code: virtual [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) GetQualifiedFrameTime() const


description: The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.

code: virtual ETimecodeProviderSynchronizationState GetSynchronizationState() const


description: This Provider became the Engine's Provider.

code: virtual bool Initialize ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Generate a frame time value, including subframe, using the system clock.

code: static [FFrameTime](API\Runtime\Core\Misc\FFrameTime) GenerateFrameTimeFromSystemTime ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) Rate )


description: This Provider stopped being the Engine's Provider.

code: virtual void Shutdown ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


className: USystemTimeTimecodeProvider

description: Converts the current system time to timecode, relative to a provided frame rate.

code: class USystemTimeTimecodeProvider : public [UTimecodeProvider](API\Runtime\Engine\Engine\UTimecodeProvider)

bGenerateFullFrame

description: When generating frame time, should we generate full frame without subframe value.

bUseHighPerformanceClock

description: Use the high performance clock instead of the system time to generate the timecode value.

FrameRate

type: FFrameRate

description: The frame rate at which the timecode value will be generated.


code: virtual void AddAssetUserData ( [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) * InUserData )


description: Begins caching platform data in the background for the platform requested

code: virtual void BeginCacheForCookedPlatformData ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


code: static void AppendToClassSchema ( [FAppendToClassSchemaContext](API\Runtime\CoreUObject\UObject\FAppendToClassSchemaContext) & Context )


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Begins caching platform data in the background.

code: void BeginCachePlatformData()


description: Gets the memory size of the texture, in bytes. This is the size in GPU memory of the built platformdata, accounting for LODBias, etc. Returns zero for error.

code: int64 Blueprint_GetMemorySize() const


description: Gets the memory size of the texture source top mip, in bytes, and the size on disk of the asset, which may be compressed. Uses texture source, not available in runtime games. Does not cause texture source to be loaded, queries cached values. Returns zero for error.

code: void Blueprint_GetTextureSourceDiskAndMemorySize ( int64 & OutDiskSize, int64 & OutMemorySize ) const


description: This is called optionally from worker threads via theFAsyncEncodeclass (LightMaps, ShadowMaps)

code: void CachePlatformData ( bool bAsyncCache, bool bAllowAsyncBuild, bool bAllowAsyncLoading, class [ITextureCompressorModule](API\Developer\TextureCompressor\ITextureCompressorModule) * Compressor )


description:
Calculates the size of this texture if it had MipCount miplevels streamed in. This is the size in GPU memory of the built platformdata, accounting for LODBias, etc.
Total size of all specified mips, in bytes. Returns 0 for error.

code: virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum ) const


description:
Calculate the combined LOD bias based on texture LOD group and LOD bias. CalculateLODBias(true) >= CalculateLODBias(false) CalculateLODBias(true) == CalculateLODBias(false) + NumCinematicMipLevels , except when a clamp was applied
LOD bias

code: int32 CalculateLODBias ( bool bWithCinematicMipBias ) const


description: Cancels any pending texture streaming actions if possible. Returns when no more async loading requests are in flight.


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


code: void CleanupCachedRunningPlatformData()


description: Clear all cached cooked platform data


description: Clears cached cooked platform data for specific platform

code: virtual void ClearCachedCookedPlatformData ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Scan the texture source pixels to compute the min & max values of the RGBA channels. Uses texture source, not available in runtime games. Causes texture source data to be loaded, is computed by scanning pixels when called. Will set Min=Max=zero and return false on failure

code: bool ComputeTextureSourceChannelMinMax ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutColorMin, [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutColorMax ) const


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()


code: virtual bool DoesMipDataExist ( const int32 MipIndex ) const


description: Downsize the 2D Image with the build setting of the texture. Try to get as close as it can to the target resolution but it will stay above it if it can reach it

code: bool DownsizeImageUsingTextureSettings ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, [FImage](API\Runtime\ImageCore\FImage) & InOutImage, int32 TargetSize, int32 LayerIndex )


className: ENotifyMaterialsEffectOnShaders

code: enum ENotifyMaterialsEffectOnShaders { Default, DoesNotInvalidate, }


description: ImportCustomProperties()

code: virtual void ExportCustomProperties ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Out, uint32 Indent )


description: Blocks on async cache tasks and prepares platform data for use.

code: void FinishCachePlatformData()


description: Because properties are destroyed here,Super::FinishDestroy()should always be called at the end of your child class'sFinishDestroy()method, rather than at the beginning.

code: virtual void FinishDestroy()


description: Forces platform data to be rebuilt.

code: void ForceRebuildPlatformData ( uint8 InEncodeSpeedOverride )


className: FOnTextureSaved

description: Delegate type for texture save events ( Params: UTexture* TextureToSave )

code: typedef TMulticastDelegate_OneParam< void, class [UTexture](API\Runtime\Engine\Engine\UTexture) * > FOnTextureSaved


description:
Forces textures to recompute LOD settings and stream as needed.
true if the settings were applied, false if they couldn't be applied immediately.


description: 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

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) * > * GetAssetUserDataArray() const


code: virtual [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) * GetAssetUserDataOfClass ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) > InUserDataClass )


description:
Gets the average brightness of the texture (in linear space)
float The average brightness of the texture

code: virtual float GetAverageBrightness ( bool bIgnoreTrueBlack, bool bUseGrayscale )


description: Get the dimensions of the largest mip of the texture when built for the target platform accounting for LODBias and other constraints

code: void GetBuiltTextureSize ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, int32 & OutSizeX, int32 & OutSizeY ) const


description: Get an estimate of the peak amount of memory required to build this texture.

code: int64 GetBuildRequiredMemory() const


description:
Returns the combined LOD bias based on texture LOD group and LOD bias. Function name is legacy and incorrect, it is no longer cached
LOD bias

code: virtual int32 GetCachedLODBias() const


code: [UTexture](API\Runtime\Engine\Engine\UTexture) * GetCompositeTexture() const


code: virtual [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * > * GetCookedPlatformData()


code: void GetDefaultFormatSettings ( [FTextureFormatSettings](API\Runtime\Engine\Engine\FTextureFormatSettings) & OutSettings ) const


description: Access the GUID which defines this texture's resources externally throughFExternalTextureRegistry

code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) GetExternalTextureGuid() const


description: Get the per-asset last render time. FLT_MAX means never use UnknownRefHeuristic and the asset will only keep non-streamable LODs when there is no instance/reference in the scene

code: virtual float GetLastRenderTimeForStreaming() const


description: Returns a unique identifier for this texture. Used by the lighting build and texture streamer.

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetLightingGuid() const


description: Gets settings used to choose format for the given layer

code: void GetLayerFormatSettings ( int32 LayerIndex, [FTextureFormatSettings](API\Runtime\Engine\Engine\FTextureFormatSettings) & OutSettings ) const


description: Get an integer representation of the LOD group

code: virtual int32 GetLODGroupForStreaming() const


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


description: Return maximum dimension for this texture type (2d/cube/vol) in the current RHI use GetMaximumDimensionOfNonVT for platform-independent max dim

code: virtual uint32 GetMaximumDimension() const


description: Get the largest allowed dimension of non-VT texture this is not for the current RHI (which may have a lower limit), this is for a Texture in general


code: static const TCHAR * GetMipGenSettingsString ( TextureMipGenSettings InEnum )


code: virtual FIoFilenameHash GetMipIoFilenameHash ( const int32 MipIndex ) const


description: Retrieves the pixel format enum for enum <-> string conversions.

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetPixelFormatEnum()


description: Get TextureFormatName with platform remaps and conditional prefix this is the entry point API for getting the final texture format name OutFormats will be resized to the number of sub-flavors of the platform (typically just 1) OutFormats[i] gets an array of format names, one per layer

code: void GetPlatformTextureFormatNamesWithPrefix ( const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > > & OutFormats ) const


code: static TextureMipGenSettings GetMipGenSettingsFromString ( const TCHAR * InStr, bool bTextureGroup )


code: virtual EStreamableRenderAssetType GetRenderAssetType() const


description: Get the texture's resource, can be NULL


description: Get the const texture's resource, can be NULL

code: const [FTextureResource](API\Runtime\Engine\FTextureResource) * GetResource() const


description:
Calculates the render resource initial state, expected to be used in InitResource() for derived classes implementing streaming.
The state to be passed toFStreamableTextureResource.

code: [FStreamableRenderResourceState](API\Runtime\Engine\Streaming\FStreamableRenderResourceState) GetResourcePostInitState ( const [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * PlatformData, bool bAllowStreaming, int32 MinRequestMipCount, int32 MaxMipCount, bool bSkipCanBeLoaded ) const


description: Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data.

code: virtual [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) ** GetRunningPlatformData()


description: Returns the minimum number of mips that must be resident in memory (cannot be streamed).


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


code: virtual TextureAddress GetTextureAddressX() const


code: virtual TextureAddress GetTextureAddressY() const


code: virtual TextureAddress GetTextureAddressZ() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


code: static const TCHAR * GetTextureGroupString ( TextureGroup InGroup )


className: GMinTextureResidentMipCount

description: The minimum number of mips that must be resident in memory (cannot be streamed).

code: static int32 GMinTextureResidentMipCount = NUM_INLINE_DERIVED_MIPS;


description: Returns the virtual texture build settings.

code: virtual void GetVirtualTextureBuildSettings ( struct [FVirtualTextureBuildSettings](API\Runtime\Engine\VT\FVirtualTextureBuildSettings) & OutSettings ) const


description:
Checks whether this texture has a high dynamic range (HDR) source.
true if the texture has an HDR source, false otherwise.

code: bool HasHDRSource ( int32 LayerIndex ) const


code: virtual bool HasPendingLODTransition() const


description: Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete.

code: virtual bool HasPendingRenderResourceInitialization() const


description: ExportCustomProperties()

code: virtual void ImportCustomProperties ( const TCHAR * SourceText, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn )


description: Invalidates per-asset last render time. Mainly used to opt in UnknownRefHeuristic during LOD index calculation. See FStreamingRenderAsset::bUseUnknownRefHeuristic


description: Returns true if all async caching has completed.

code: bool IsAsyncCacheComplete() const


description: Called by ULevel::MarkNoStreamableTexturesPrimitiveComponents when cooking level. Return false for VT.

code: bool IsCandidateForTextureStreamingOnPlatformDuringCook ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * InTargetPlatform ) const


description:
Checks whether this texture should be tiled to a platform-specific format during cook, or whether the bNotOfflineProcessed flag should be set to true at runtime because it has not been tiled at cook
true if platform tiling during cook is disabled for this texture

code: bool IsCookPlatformTilingDisabled ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform ) const


description: Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData

code: virtual bool IsCachedCookedPlatformDataLoaded ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Returns whether or not the asset is currently being compiled

code: virtual bool IsCompiling() const


description: Returns if the texture is actually being rendered using virtual texturing right now. Unlike the 'VirtualTextureStreaming' property which reflects the user's desired state this reflects the actual current state on the renderer depending on the platform, VT data being built, project settings, ....

code: virtual bool IsCurrentlyVirtualTextured() const


description: Returns true if the current texture is a default placeholder because compilation is still ongoing.

code: virtual bool IsDefaultTexture() const


description: true if the compression type is a normal map compression type

code: bool IsNormalMap() const


description: Do the Texture properties make it a possible candidate for streaming. Can be called by editor or runtime. If true, does not mean it will actually be streamed, but if false will definitely not be streamed.

code: bool IsPossibleToStream() const


description:
Called during async load to determine if PostLoad can be called on the loading thread.
true if this object's PostLoad is thread safe

code: virtual bool IsPostLoadThreadSafe() const


description:
Called to check if the object is ready for FinishDestroy. This is called after BeginDestroy to check the completion of the potentially asynchronous object cleanup.
True if the object's asynchronous cleanup has completed and it is ready for FinishDestroy to be called.

code: virtual bool IsReadyForFinishDestroy()


description: true if the texture has an uncompressed texture setting

code: bool IsUncompressed() const


description: Marks platform data as transient. This optionally removes persistent or cached data associated with the platform.

code: void MarkPlatformDataTransient()


description: Notify any loaded material instances that the texture has changed.

code: void NotifyMaterials ( const [ENotifyMaterialsEffectOnShaders](API\Runtime\Engine\Engine\UTexture\ENotifyMaterialsEffectOnShaders) EffectOnShaders )


description:
Note that the object will be modified. If we are currently recording into the transaction buffer (undo/redo), save a copy of this object into the buffer and marks the package as needing to be saved.
true if the object was saved to the transaction buffer

code: virtual bool Modify ( bool bAlwaysMarkDirty )


description: Called after the C++ constructor has run on the Class Default Object (CDO) for a class. This is an obscure routine used to deal with the recursion in the construction of the default materials

code: virtual void PostCDOContruct()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

code: virtual void PostEditImport()


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Deprecated* Use version that takesFObjectPreSaveContextinstead.

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid PreSave ( const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Objects created from within PreSave will NOT have PreSave called on them!!!

code: virtual void PreSave ( [FObjectPreSaveContext](API\Runtime\CoreUObject\UObject\FObjectPreSaveContext) SaveContext )


className: PreSaveEvent

description: Triggered before a texture is being saved


description: Resets the resource for the texture.

code: void ReleaseResource()


code: virtual void RemoveUserDataOfClass ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UAssetUserData](API\Runtime\Engine\Engine\UAssetUserData) > InUserDataClass )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetCompositeTexture ( [UTexture](API\Runtime\Engine\Engine\UTexture) * InCompositeTexture )


description: Serializes cooked platform data.

code: void SerializeCookedPlatformData ( class [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, const bool bSerializeMipData )


description: Generates a deterministic GUID for the texture based on the full name of the object. Used to ensure that assets created during cook can be deterministic

code: void SetDeterministicLightingGuid()


code: void SetLayerFormatSettings ( int32 LayerIndex, const [FTextureFormatSettings](API\Runtime\Engine\Engine\FTextureFormatSettings) & InSettings )


description: Assigns a new GUID to a texture. This will be called whenever a texture is created or changes. In game, the GUIDs are only used by the texture streamer to link build data to actual textures, that means new textures don't actually need GUIDs (seeFStreamingTextureLevelContext)

code: void SetLightingGuid()


code: void SetLightingGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Guid )


description: Sets the minimum number of mips that must be resident in memory (cannot be streamed).

code: static void SetMinTextureResidentMipCount ( int32 InMinTextureResidentMipCount )


description: Set texture's resource, can be NULL

code: void SetResource ( [FTextureResource](API\Runtime\Engine\FTextureResource) * Resource )


description:
Returns whether miplevels should be forced resident.
true if either transient or serialized override requests miplevels to be resident, false otherwise

code: virtual bool ShouldMipLevelsBeForcedResident() const


description: Try to cancel any async tasks on PlatformData. Returns true if there is no more async tasks pending, false otherwise.

code: bool TryCancelCachePlatformData()


description: Cache the combined LOD bias based on texture LOD group and LOD bias.

code: void UpdateCachedLODBias()


description: Change the Oodle Texture Sdk Version used to encode this texture to latest. You should do this any time the texture is modified, such as on reimport, since the bits are changing anyway.

code: virtual void UpdateOodleTextureSdkVersionToLatest ( bool bDoPrePostEditChangeIfChanging )


description: Creates a new resource for the texture, and updates any cached references to the resource.

code: virtual void UpdateResource()


code: UTexture ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Ensure settings are valid after import or edit; this is called by PostEditChange.

code: virtual void ValidateSettingsAfterImportOrEdit ( bool * pRequiresNotifyMaterials )


code: UTexture ( [FVTableHelper](API\Runtime\CoreUObject\UObject\FVTableHelper) & Helper )


className: UTexture

code: class UTexture : public [UStreamableRenderAsset](API\Runtime\Engine\Engine\UStreamableRenderAsset), public [IInterface_AssetUserData](API\Runtime\Engine\Interfaces\IInterface_AssetUserData), public [IInterface_AsyncCompilation](API\Runtime\Engine\Interfaces\IInterface_AsyncCompilation)

AdjustBrightness

type: float

description: Static texture brightness adjustment (scales HSV value.) (Non-destructive; Requires texture source art to be available.)

AdjustBrightnessCurve

description: Static texture curve adjustment (raises HSV value to the specified power.) (Non-destructive; Requires texture source art to be available.)

AdjustHue

description: Static texture hue adjustment (0 - 360) (offsets HSV hue by value in degrees.) (Non-destructive; Requires texture source art to be available.)

AdjustMaxAlpha

description: Remaps the alpha to the specified min/max range, defines the new value of 1 (Non-destructive; Requires texture source art to be available.)

AdjustMinAlpha

description: Remaps the alpha to the specified min/max range, defines the new value of 0 (Non-destructive; Requires texture source art to be available.)

AdjustRGBCurve

description: Static texture RGB curve adjustment (raises linear-space RGB color to the specified power.) (Non-destructive; Requires texture source art to be available.)

AdjustSaturation

description: Static texture saturation adjustment (scales HSV saturation.) (Non-destructive; Requires texture source art to be available.)

AdjustVibrance

description: Static texture "vibrance" adjustment (0 - 1) (HSV saturation algorithm adjustment.) (Non-destructive; Requires texture source art to be available.)

AlphaCoverageThresholds

description: Alpha values per channel to compare to when preserving alpha coverage.

AssetUserData

type: TArray<TObject...

description: Array of user data stored with the asset

bChromaKeyTexture

description: Whether to chroma key the image, replacing any pixels that match ChromaKeyColor with transparent black

bCustomPropertiesImported

description: Indicates ImportCustomProperties has been called (set in ImportCustomProperties, unset in the subsequent PostEditChange)

bDoScaleMipsForAlphaCoverage

description: Whether mip RGBA should be scaled to preserve the number of pixels with Value >= AlphaCoverageThresholds.

bFlipGreenChannel

type: uint32: 1

description: When true the texture's green channel will be inverted. This is useful for some normal maps.

bIsImporting

description: Indicates we're currently importing the object (set in PostEditImport, unset in the subsequent PostEditChange)

bNormalizeNormals

type: uint8: 1

description: Normalize colors in Normal Maps after mip generation for better and sharper quality; recommended on if not required to match legacy behavior.

bNoTiling

description: If true, the RHI texture will be created using TexCreate_NoTiling

bNotOfflineProcessed

description: If true, the RHI texture will be created without TexCreate_OfflineProcessed.

bPreserveBorder

description: When true the texture's border will be preserved during mipmap generation.

bUseLegacyGamma

description: A flag for using the simplified legacy gamma space e.g pow(color,1/2.2) for converting fromFColortoFLinearColor, if we're doing sRGB.

bUseNewMipFilter

description: Use faster mip generation filter, usually the same result but occasionally causes color shift in high contrast areas.

ChromaKeyColor

type: FColor

description: The color that will be replaced with transparent black if chroma keying is enabled

ChromaKeyThreshold

description: The threshold that components have to match for the texel to be considered equal to the ChromaKeyColor when chroma keying (<=, set to 0 to require a perfect exact match)

CompositePower

description: Default 1, high values result in a stronger effect e.g 1, 2, 4, 8 this is not a slider because the texture update would not be fast enough

CompositeTextureMode

type: TEnumAsByte< en...

description: Defines how the CompositeTexture is applied, e.g. CTM_RoughnessFromNormalAlpha

CompressFinal

description: If enabled, compress with Final quality during this Editor session.

CompressionCacheId

type: FGuid

description: Change this optional ID to force the texture to be recompressed by changing its cache key.

CompressionForceAlpha

description: If true, force alpha channel in output format when possible, eg. for AutoDXT BC1/BC3 choice

CompressionNoAlpha

description: If enabled, the texture's alpha channel will be forced to opaque for any compressed texture output format.

CompressionNone

description: If true, force the texture to be uncompressed no matter the format.

CompressionQuality

description: The compression quality for generated ASTC textures (i.e. mobile platform textures).

CompressionSettings

description: Compression settings to use when building the texture.

CompressionYCoCg

description: If true the texture stores YCoCg.

CookPlatformTilingSettings

description: If the platform supports it, tile the texture when cooking, or keep it linear and tile it when it's actually submitted to the GPU.

DeferCompression

description: If enabled, defer compression of the texture until save or manually compressed in the texture editor.

DidSerializeStreamingMipsForPlatform

type: TMap<FString, ...

description: Used to record texture streamable state when cooking.

Downscale

type: FPerPlatformFlo...

description: Downscale source texture, applied only to 2d textures without mips 0.0 - use scale value from texture group 1.0 - do not scale texture

DownscaleOptions

type: ETextureDownsca...

description: Texture downscaling options

Filter

description: The texture filtering mode to use when sampling this texture.

LayerFormatSettings

type: TArray<FTextur...

description: Array of settings used to control the format of given layer If this array doesn't include an entry for a given layer, values fromUTexturewill be used

LevelIndex

description: Level scope index of this texture.

LoadedMainStreamObjectVersion

type: int

description: Store theFUE5MainStreamObjectVersionof the Texture uasset loaded for debugging (== LatestVersion if not loaded)

LODBias

description: A bias to the index of the top mip level to use.

LODGroup

description: Texture group this texture belongs to

LossyCompressionAmount

type: TEnumAsByte< ET...

description: How aggressively should any relevant lossy compression be applied.

MaxTextureSize

description: The maximum resolution for generated textures.

MipGenSettings

description: Per asset specific setting to define the mip-map generation properties like sharpening and kernel size.

MipLoadOptions

type: ETextureMipLoad...

description: The texture mip load options.

OodleTextureSdkVersion

type: FName

description: Oodle Texture SDK Version to encode with.

PaddingColor

description: The color used to pad the texture out if it is resized due to PowerOfTwoMode

PowerOfTwoMode

description: How to pad the texture to a power of 2 size (if necessary)

ReleaseFence

description: Release fence to know when resources have been freed on the rendering thread.

Source

type: FTextureSource

description: Dynamic textures will have ! Source.IsValid() ; Also in UEFN , Textures from the cooked-only texture library.

SourceColorSettings

type: FTextureSourceC...

description: Texture color management settings: source encoding and color space.

SRGB

description: Whether Texture and its source are in SRGB Gamma color space.

TextureEditorCustomEncoding

type: TWeakPtr< class...

description: When we are open in an asset editor, we have a pointer to a custom encoding object which can optionally cause us to do something other than Fast/Final encode settings.

TextureReference

type: FTextureReferen...

description: Stable RHI texture reference that refers to the current RHI texture.

VirtualTextureStreaming

description: Is this texture streamed in using VT


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Gets the X size of the texture, in pixels

code: int32 Blueprint_GetSizeX() const


description: Gets the Y size of the texture, in pixels

code: int32 Blueprint_GetSizeY() const


description:
Calculates the size of this texture in bytes if it had MipCount miplevels streamed in.
Size of MipCount mips in bytes

code: int32 CalcTextureMemorySize ( int32 MipCount ) const


code: virtual int32 CalcCumulativeLODSize ( int32 NumLODs ) const


description:
Calculates the size of this texture if it had MipCount miplevels streamed in.
Total size of all specified mips, in bytes

code: virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum ) const


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()


description: Creates and initializes a new Texture2D with the requested settings

code: static [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CreateTransient ( int32 InSizeX, int32 InSizeY, EPixelFormat InFormat, const [FName](API\Runtime\Core\UObject\FName) InName )


description: 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

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


description:
Gets the average brightness of the texture (in linear space)
float The average brightness of the texture

code: virtual float GetAverageBrightness ( bool bIgnoreTrueBlack, bool bUseGrayscale )


description: Return a one line description of an object for viewing in the thumbnail view of the generic browser


code: virtual [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * > * GetCookedPlatformData()


description:
Retrieve initial texel data for mips, starting from FirstMipToLoad, up to the last mip in the texture. This function will only return mips that are currently loaded, or available via derived data. THIS FUNCTION WILL FAIL if you include in the requested range a streaming mip that is NOT currently loaded. Also note that ALL mip bulk data buffers are discarded (either returned or freed). So... in short, this function should only ever be called once.
true if the requested mip data has been successfully returned.

code: virtual bool GetInitialMipData ( int32 InFirstMipToLoad, [TArrayView](API\Runtime\Core\Containers\TArrayView)< void * > OutMipData, [TArrayView](API\Runtime\Core\Containers\TArrayView)< int64 > OutMipSize )


description: Returns the global mip map bias applied as an offset for 2d textures.

code: static float GetGlobalMipMapLODBias()


description: Retrieves the size of the source image from which the texture was created.

code: FIntPoint GetImportedSize() const


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


description: Returns the minimum number of mips that must be resident in memory (cannot be streamed). This does not correctly account for NonStreaming mips and other constraints. This function is not correct and should not be used.


description: todo: deprecate this API when possible this API is also duplicated in Texture2DArray and TextureCube unify and fix them all also don't use "GetMipData" as that is the name used for TextureSource

code: void GetMipData ( int32 FirstMipToLoad, void ** OutMipData )


description:
The cinematic mips will be considered as loadable, streaming enabled or not. Note that in the cooking process, mips smaller than the min residency count can be stripped out by the cooker.
The maximum allowed number mips for this texture.

code: int32 GetNumMipsAllowed ( bool bIgnoreMinResidency ) const


code: EPixelFormat GetPixelFormat ( uint32 LayerIndex ) const


description: Get the derived data for this texture on this platform.


description: Get the const derived data for this texture on this platform.

code: const [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * GetPlatformData() const


code: const [TIndirectArray](API\Runtime\Core\Containers\TIndirectArray)< [FTexture2DMipMap](API\Runtime\Engine\FTexture2DMipMap) > & GetPlatformMips() const


description:
Calculates and returns the corresponding ResourceMem parameters for this texture.
true if the texture should use a ResourceMem. If false, none of the out parameters will be filled in.

code: bool GetResourceMemSettings ( int32 FirstMipIdx, int32 & OutSizeX, int32 & OutSizeY, int32 & OutNumMips, uint32 & OutTexCreateFlags )


description:
Returns the size of the object/ resource for display to artists/ LDs in the Editor.
size of resource as to be displayed to artists/ LDs in the Editor.

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


description: Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data.

code: virtual [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) ** GetRunningPlatformData()


description: Trivial accessors.

code: int32 GetSizeX() const


description:
Get the CRC of the source art pixels.
bool true if successful, false if failed (or no source art)

code: bool GetSourceArtCRC ( uint32 & OutSourceCRC )


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


code: virtual TextureAddress GetTextureAddressX() const


code: virtual TextureAddress GetTextureAddressY() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


description:
See if the source art of the two textures matches...
bool true if they matche, false if not

code: bool HasSameSourceArt ( [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * InTexture )


description: Returns true if the runtime texture has an alpha channel that is not completely white.

code: bool HasAlphaChannel() const


description: Returns true if the current texture is a default placeholder because compilation is still ongoing.

code: virtual bool IsDefaultTexture() const


description: Returns if the texture is actually being rendered using virtual texturing right now. Unlike the 'VirtualTextureStreaming' property which reflects the user's desired state this reflects the actual current state on the renderer depending on the platform, VT data being built, project settings, ....

code: virtual bool IsCurrentlyVirtualTextured() const


description: Called before callingPostLoad()in FAsyncPackage::PostLoadObjects(). This is the safeguard to preventPostLoad()from stalling the main thread.

code: virtual bool IsReadyForAsyncPostLoad() const


description: Returns true if this virtual texture requests round-robin updates of the virtual texture pages.

code: virtual bool IsVirtualTexturedWithContinuousUpdate() const


description: Returns true if this virtual texture uses a single physical space all of its texture layers. This can reduce page table overhead but potentially increase the number of physical pools allocated.

code: virtual bool IsVirtualTexturedWithSinglePhysicalSpace() const


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after an editor or undo operation is formed on texture

code: virtual void PostEditUndo()


description: Called in response to the linker changing, this can only happen in the editor

code: virtual void PostLinkerChange()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Deprecated* Use version that takesFObjectPreSaveContextinstead.

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid PreSave ( const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Objects created from within PreSave will NOT have PreSave called on them!!!

code: virtual void PreSave ( [FObjectPreSaveContext](API\Runtime\CoreUObject\UObject\FObjectPreSaveContext) SaveContext )


description: Update the offset for mip map lod bias. This is added to any existing mip bias values.

code: virtual void RefreshSamplerStates()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Set the derived data for this texture on this platform.

code: void SetPlatformData ( [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * PlatformData )


description:
Loads mips from disk to memory. Only usable if the asset is streamable.
Whether any mips were resquested to be loaded.

code: virtual bool StreamIn ( int32 NewMipCount, bool bHighPrio )


description:
Unload some mips from memory. Only usable if the asset is streamable.
Whether any mips were requested to be unloaded.

code: virtual bool StreamOut ( int32 NewMipCount )


description: Temporarily disable streaming so we update subregions of this texture without streaming clobbering it.

code: void TemporarilyDisableStreaming()


description: Creates a new resource for the texture, and updates any cached references to the resource.

code: virtual void UpdateResource()


description: Asynchronously update a set of regions of a texture with new data.

code: void UpdateTextureRegions ( int32 MipIndex, uint32 NumRegions, const [FUpdateTextureRegion2D](API\Runtime\RHI\FUpdateTextureRegion2D) * Regions, uint32 SrcPitch, uint32 SrcBpp, uint8 * SrcData, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(uint8 *SrcData, const [FUpdateTextureRegion2D](API\Runtime\RHI\FUpdateTextureRegion2D) *Regions)> DataCleanupFunc )


code: UTexture2D ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: class UTexture2D : public [UTexture](API\Runtime\Engine\Engine\UTexture)

AddressX

description: The addressing mode to use for the X axis.

AddressY

description: The addressing mode to use for the Y axis.

bHasBeenPaintedInEditor

description: Whether the texture has been painted in the editor.

CookedPlatformData

description: Cooked platform data for this texture

FirstResourceMemMip

description: Keep track of first mip level used for ResourceMem creation

ResourceMem

description: Memory used for directly loading bulk mip data


code: virtual int32 CalcCumulativeLODSize ( int32 NumLODs ) const


description:
Calculates the size of this texture in bytes if it had MipCount mip-levels streamed in.
Size of MipCount mips in bytes

code: uint32 CalcTextureMemorySize ( int32 MipCount ) const


description:
Calculates the size of this texture if it had MipCount mip levels streamed in.
Total size of all specified mips, in bytes

code: virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum ) const


code: bool CheckArrayTexturesCompatibility()


description: Creates and initializes a new Texture2DArray with the requested settings

code: static [UTexture2DArray](API\Runtime\Engine\Engine\UTexture2DArray) * CreateTransient ( int32 InSizeX, int32 InSizeY, int32 InArraySize, EPixelFormat InFormat, const [FName](API\Runtime\Core\UObject\FName) InName )


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()


description: 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

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


code: virtual [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * > * GetCookedPlatformData()


description: Return a one line description of an object for viewing in the thumbnail view of the generic browser


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


description: Return maximum dimension for this texture type.

code: virtual uint32 GetMaximumDimension() const


description: In the editor this can potentially wait for texture builds to complete.

code: bool GetMipData ( int32 InFirstMipToLoad, [TArray](API\Runtime\Core\Containers\TArray)< [FUniqueBuffer](API\Runtime\Core\Memory\FUniqueBuffer), TInlineAllocator< MAX_TEXTURE_MIP_COUNT >> & OutMipData )


code: EPixelFormat GetPixelFormat() const


description: Get the derived data for this texture on this platform.


description: Get the const derived data for this texture on this platform.

code: const [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * GetPlatformData() const


description: Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


description: Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data.

code: virtual [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) ** GetRunningPlatformData()


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


code: virtual TextureAddress GetTextureAddressX() const


code: virtual TextureAddress GetTextureAddressY() const


code: virtual TextureAddress GetTextureAddressZ() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


description: Returns true if the current texture is a default placeholder because compilation is still ongoing.

code: virtual bool IsDefaultTexture() const


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Set the derived data for this texture on this platform.

code: void SetPlatformData ( [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * PlatformData )


description:
Loads mips from disk to memory. Only usable if the asset is streamable.
Whether any mips were resquested to be loaded.

code: virtual bool StreamIn ( int32 NewMipCount, bool bHighPrio )


description:
Unload some mips from memory. Only usable if the asset is streamable.
Whether any mips were requested to be unloaded.

code: virtual bool StreamOut ( int32 NewMipCount )


description: Creates a new resource for the texture, and updates any cached references to the resource.

code: virtual void UpdateResource()


code: bool UpdateSourceFromSourceTextures ( bool bCreatingNewTexture )


code: class UTexture2DArray : public [UTexture](API\Runtime\Engine\Engine\UTexture)

AddressX

description: The addressing mode to use for the X axis.

AddressY

description: The addressing mode to use for the Y axis.

AddressZ

description: The addressing mode to use for the Z axis.

bSourceGeneratedFromSourceTexturesArray

type: bool

description: Is set to true if the source texture was generated from the SourceTextures array (which is not always the case, i.e. the source texture could be imported from a DDS file containing multiple slices).

PrivatePlatformData

type: FTexturePlatfor...

description: The derived data for this texture on this platform.

SourceTextures

type: TArray<TObject...

description: Add Textures


code: UTexture2DArray ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Deprecated* Please useUTexture2DDynamic::Create()withFTexture2DDynamicCreateInfoinitialization

code: static [UTexture2DDynamic](API\Runtime\Engine\Engine\UTexture2DDynamic) * Create ( int32 InSizeX, int32 InSizeY, EPixelFormat InFormat )


description: Creates and initializes a new Texture2DDynamic with the requested settings

code: static [UTexture2DDynamic](API\Runtime\Engine\Engine\UTexture2DDynamic) * Create ( int32 InSizeX, int32 InSizeY, const [FTexture2DDynamicCreateInfo](API\Runtime\Engine\Engine\FTexture2DDynamicCreateInfo) & InCreateInfo )


code: static [UTexture2DDynamic](API\Runtime\Engine\Engine\UTexture2DDynamic) * Create ( int32 InSizeX, int32 InSizeY, EPixelFormat InFormat, bool InIsResolveTarget )


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


description: Initializes the texture with 1 mip-level and creates the render resource.

code: void Init ( int32 InSizeX, int32 InSizeY, EPixelFormat InFormat, bool InIsResolveTarget )


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


code: UTexture2DDynamic ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Note :UTexture2DDynamicderives directly fromUTexturenot fromUTexture2DUTexture2DDynamicis a base for textures that don't have a TextureSource

code: class UTexture2DDynamic : public [UTexture](API\Runtime\Engine\Engine\UTexture)

bIsResolveTarget

type: uint8:  1

description: Whether the texture can be used as a resolve target.

Format

type: TEnumAsByte< en...

description: The format of the texture.

NumMips

description: The number of mip-maps in the texture.

SamplerAddressMode

type: ESamplerAddress...

description: The sampler default address mode for this texture.

SizeX

description: The width of the texture.

SizeY

description: The height of the texture.


description: Get the initial streaming state (after texture is first loaded)

code: virtual [FStreamableRenderResourceState](API\Runtime\Engine\Streaming\FStreamableRenderResourceState) GetResourcePostInitState ( const [UTexture](API\Runtime\Engine\Engine\UTexture) * Owner, bool bAllowStreaming )


code: UTextureAllMipDataProviderFactory ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description:
Retrieve initial texel data for mips, starting from FirstMipToLoad, up to the last mip in the texture. This function will only return mips that are currently loaded in Bulk Data. THIS FUNCTION WILL FAIL if you include in the requested range a bulk data mip that is NOT currently loaded. Also note that only inline mips are loaded initially, and that ALL mip data buffers are discarded (either returned or freed). So... in short, this function should only ever be called once.
true if the requested mip data has been successfully returned.

code: virtual bool GetInitialMipData ( int32 FirstMipToLoad, [TArrayView](API\Runtime\Core\Containers\TArrayView)< void * > OutMipData, [TArrayView](API\Runtime\Core\Containers\TArrayView)< int64 > OutMipSize, FStringView DebugContext )


className: UTextureAllMipDataProviderFactory

description: UTextureAllMipDataProviderFactorydefines an interface to create instances ofFTextureMipDataProvider. Derived classes fromUTextureAllMipDataProviderFactorycan be attached toUTexture2Dto define a new source for all of the mip data (instead of the default disk file or ddc mips). Use cases include custom texture compression.

code: class UTextureAllMipDataProviderFactory : public [UTextureMipDataProviderFactory](API\Runtime\Engine\Engine\UTextureMipDataProviderFactory)


description:
Calculates the size of this texture in bytes if it had MipCount miplevels streamed in.
Size of MipCount mips in bytes

code: uint32 CalcTextureMemorySize ( int32 MipCount ) const


description:
Calculates the size of this texture if it had MipCount miplevels streamed in.
Total size of all specified mips, in bytes

code: virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum ) const


description: Creates and initializes a new TextureCube with the requested settings

code: static [UTextureCube](API\Runtime\Engine\Engine\UTextureCube) * CreateTransient ( int32 InSizeX, int32 InSizeY, EPixelFormat InFormat, const [FName](API\Runtime\Core\UObject\FName) InName )


description: 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

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


code: virtual [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * > * GetCookedPlatformData()


description: Return a one line description of an object for viewing in the thumbnail view of the generic browser


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


description: Return maximum dimension for this texture type.

code: virtual uint32 GetMaximumDimension() const


description: Get mip data starting with the specified mip index.

code: void GetMipData ( int32 FirstMipToLoad, void ** OutMipData )


code: EPixelFormat GetPixelFormat() const


description: Get the derived data for this texture on this platform.


description: Get the const derived data for this texture on this platform.

code: const [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * GetPlatformData() const


description: Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


description: Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data.

code: virtual [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) ** GetRunningPlatformData()


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


description: Returns true if the current texture is a default placeholder because compilation is still ongoing.

code: virtual bool IsDefaultTexture() const


code: virtual bool NeedsLoadForTargetPlatform ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform ) const


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Set the derived data for this texture on this platform.

code: void SetPlatformData ( [FTexturePlatformData](API\Runtime\Engine\Engine\FTexturePlatformData) * PlatformData )


description: Creates a new resource for the texture, and updates any cached references to the resource.

code: virtual void UpdateResource()


code: UTextureCube ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Destructor


className: UTextureCube

code: class UTextureCube : public [UTexture](API\Runtime\Engine\Engine\UTexture)

CookedPlatformData

type: TMap<FString, ...

PrivatePlatformData

description: The derived data for this texture on this platform.


description:
Calculates the size of this texture in bytes if it had MipCount mip-levels streamed in.
Size of MipCount mips in bytes

code: uint32 CalcTextureMemorySize ( int32 MipCount ) const


description:
Calculates the size of this texture if it had MipCount mip levels streamed in.
Total size of all specified mips, in bytes

code: virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum ) const


code: bool CheckArrayTexturesCompatibility()


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()