1. Epic GamesDeveloper
  3. FMaterialUtilities

FMaterialUtilities

Material utilities

Unreal Engine C++ API Reference > Developer > MaterialUtilities

Inheritance Hierarchy

References

   
Module MaterialUtilities
Header /Engine/Source/Developer/MaterialUtilities/Public/MaterialUtilities.h
Include #include "MaterialUtilities.h"

Syntax

class FMaterialUtilities : public IModuleInterface

Remarks

Material utilities

Functions

  Type Name Description
Public function Static void

AnalyzeMaterial ( UMaterialInterface* InMaterial,
const TArray< EMaterialProperty >& Properties,
int32& OutNumTexCoords,
bool& OutRequiresVertexData
)

  
Public function Static void

AnalyzeMaterial ( UMaterialInterface* InMaterial,
const FMaterialProxySettings& InMaterialSettings,
int32& OutNumTexCoords,
bool& OutRequiresVertexData
)

 Analyzes given material to determine how many texture coordinates and whether or not vertex colors are used within the material Graph
Public function Static float

ComputeRequiredTexelDensityFromDrawDistance ( const float InDrawDistance,
float InWorldSpaceRadius
)

 Compute the required texel density needed to properly represent an object/objects covering the provided world space radius
Public function Static float

ComputeRequiredTexelDensityFromScreenSize ( const float InScreenSize,
float InWorldSpaceRadius
)

 Compute the required texel density needed to properly represent an object/objects covering the provided world space radius
Public function Static UMaterialInstanceConstant *

CreateFlattenMaterialInstance ( UPackage* InOuter,
const FMaterialProxySettings& InMaterialProxySettings,
UMaterialInterface* InBaseMaterial,
const FFlattenMaterial& FlattenMaterial,
const FString& AssetBasePath,
const FString& AssetBaseName,
TArray< UObject* >& OutAssetsToSync,
FMaterialUpdateContext* MaterialUpdateContext
)

 Creates a flatten material instance and the required texture assets
Public function Static FFlattenMaterial Creates a FFlattenMaterial instance with the given MaterialProxySettings data
Public function Static UMaterialInstanceConstant *

CreateInstancedMaterial ( UMaterialInterface* BaseMaterial,
UPackage* InOuter,
const FString& BaseName,
EObjectFlags Flags
)

 Creates an instanced material based of BaseMaterial
Public function Static UMaterial *

CreateMaterial ( const FFlattenMaterial& InFlattenMaterial,
UPackage* InOuter,
const FString& BaseName,
EObjectFlags Flags,
const FMaterialProxySettings& MaterialProxySettings,
TArray< UObject* >& OutGeneratedAssets,
const TextureGroup& InTextureGroup
)

 Creates UMaterial object from a flatten material
Public function Static UMaterialInterface *

CreateProxyMaterialAndTextures ( const FString& PackageName,
const FString& AssetName,
const FBakeOutput& BakeOutput,
const FMeshData& MeshData,
const FMaterialData& MaterialData,
UMaterialOptions* Options
)

 Creates a proxy material and the required texture assets
Public function Static UMaterialInterface *

CreateProxyMaterialAndTextures ( UPackage* OuterPackage,
const FString& AssetName,
const FBakeOutput& BakeOutput,
const FMeshData& MeshData,
const FMaterialData& MaterialData,
UMaterialOptions* Options
)

 Creates a proxy material and the required texture assets
Public function Static UTexture2D *

CreateTexture ( UPackage* Outer,
const FString& AssetLongName,
FIntPoint Size,
const TArray< FColor >& Samples,
const FCreateTexture2DParameters& CreateParams,
EObjectFlags Flags
)

 Generates a texture from an array of samples
Public function Static UTexture2D *

CreateTexture ( UPackage* Outer,
const FString& AssetLongName,
FIntPoint Size,
const TArray< FColor >& Samples,
TextureCompressionSettings CompressionSettings,
TextureGroup LODGroup,
EObjectFlags Flags,
bool bSRGB,
const FGuid& SourceGuidHash
)

 Generates a texture from an array of samples
Public function Static void

DetermineMaterialImportance ( const TArray< UMaterialInterface* >& InMaterials,
TArray< float >& OutImportance
)

 Calculates an importance value for the given set of materials according to the texture sampler usage
Public function Static bool

ExportBaseColor ( ULandscapeComponent* LandscapeComponent,
int32 TextureSize,
TArray< FColor >& OutSamples
)

 Creates bakes textures for a ULandscapeComponent
Public function Static bool

ExportLandscapeMaterial ( const ALandscapeProxy* InLandscape,
const TSet< FPrimitiveComponentId >& HiddenPrimitives,
FFlattenMaterial& OutFlattenMaterial
)

 Flattens specified landscape material
Public function Static bool

ExportLandscapeMaterial ( const ALandscapeProxy* InLandscape,
FFlattenMaterial& OutFlattenMaterial
)

 Flattens specified landscape material
Public function Static bool Get the material texcoord scales applied on each textures
Public function Static FIntPoint

FindMaxTextureSize ( UMaterialInterface* InMaterialInterface,
FIntPoint MinimumSize
)

 End IModuleInterface implementation Iterate through all textures used by the material and return the maximum texture resolution used
Public function Static void

GeneratedBinnedTextureSquares ( const FVector2D DestinationSize,
TArray< float >& InTexureWeights,
TArray< FBox2D >& OutGeneratedBoxes
)

 Generates a set of texture boxes according to the given weights and final atlas texture size
Public function Static FString Get the name of the Texture parameter associated with a given flatten material property
Public function Static int32

GetTextureSizeFromTargetTexelDensity ( const UE::Geometry::FDynamicMesh3& Mesh,
float TargetTexelDensity
)

 Compute the required texture size to achieve a target texel density for the given mesh.
Public function Static int32

GetTextureSizeFromTargetTexelDensity ( const FMeshDescription& InMesh,
float InTargetTexelDensity
)

 Compute the required texture size to achieve a target texel density for the given mesh.
Public function Static int32

GetTextureSizeFromTargetTexelDensity ( double InMesh3DArea,
double InMeshUVArea,
double InTargetTexelDensity
)

 Compute the required texture size to achieve a target texel density, given the world to UV space ratio.
Public function Static bool

IsValidFlattenMaterial ( const UMaterialInterface* InBaseMaterial
)

 Validate that the provided material has all the required parameters needed to be considered a flattening material
Public function Static void

OptimizeFlattenMaterial ( FFlattenMaterial& InFlattenMaterial
)

 Tries to optimize the flatten material's data by picking out constant values for the various properties
Public function Static void

OptimizeSampleArray ( TArray< FColor >& InSamples,
FIntPoint& InSampleSize
)

 Tries to optimize the sample array (will set to const value if all samples are equal)
Public function Static void

RemapUniqueMaterialIndices ( const TArray< struct FSectionInfo >& InSections,
const TArray< struct FRawMeshExt >& InMeshData,
const TMap< FIntPoint, TArray< int32 > >& InMaterialMap,
const FMaterialProxySettings& InMaterialProxySettings,
const bool bBakeVertexData,
const bool bMergeMaterials,
TArray< bool >& OutMeshShouldBakeVertexData,
TMap< FIntPoint, TArray< int32 > >& OutMaterialMap,
TArray< struct FSectionInfo >& OutSections
)

 Remaps material indices where possible to reduce the number of materials required for creating a proxy material
Public function Static void

ResizeFlattenMaterial ( FFlattenMaterial& InFlattenMaterial,
const FMeshProxySettings& InMeshProxySettings
)

 Resizes flatten material's data if applicable by comparing it with the original settings

Overridden from IModuleInterface

  Type Name Description
Public function Virtual void Called before the module is unloaded, right before the module object is destroyed.
Public function Virtual void Begin IModuleInterface implementation

Classes

  Type Name Description
Public class FExportErrorManager Contains errors generated when exporting material texcoord scales.  

Constants

Name Description
CurrentlyRendering Flag to indicate whether or not a texture is currently being rendered out
RenderTargetPool Pool of available render targets, cached for re-using on consecutive property rendering

Deprecated Functions

  Type Name Description
Public function Static bool

SupportsExport ( EBlendMode InBlendMode,
EMaterialProperty InMaterialProperty
)

 Use SupportsExport(bool bIsOpaque, ...) function instead
Public function Static bool

SupportsExport ( bool bIsOpaque,
EMaterialProperty InMaterialProperty
)

 Use SupportsExport(bool bIsOpaque, ...) function instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page