Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Materials > UMaterialExpressionFontSampleParameter

Light Theme

Dark Theme

UMaterialExpressionFontSampleParameter

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialExpression

UMaterialExpressionFontSample

UMaterialExpressionFontSampleParameter

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Materials/MaterialExpressionFontSampleParameter.h
Include	#include "Materials/MaterialExpressionFontSampleParameter.h"

Syntax

class UMaterialExpressionFontSampleParameter : public UMaterialExpressionFontSample

Variables

	Name	Description
FGuid	ExpressionGUID	GUID that should be unique within the material, this is used for parameter renaming.
FName	Group	The name of the parameter Group to display in MaterialInstance Editor. Default is None group
FName	ParameterName	Name to be referenced when we want to find and set thsi parameter
int32	SortPriority	Controls where the this parameter is displayed in a material instance parameter list.

Constructors

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

Functions

		Name	Description
	void	SetDefaultFont()	Sets the default Font if none is set
	bool	SetParameterValue ( FName InParameterName, UFont* InFontValue, int32 InFontPage, EMaterialExpressionSetParameterValu... )

Overridden from UMaterialExpression

	Name	Description
bool	CanRenameNode()	Can this node be renamed?
int32	Compile ( FMaterialCompiler* Compiler, int32 OutputIndex )	Create the new shader code chunk needed for the Abs expression
void	GetCaption ( TArray< FString >& OutCaptions )	Returns the text to display on the material expression (in the material editor).
FString	GetEditableName()	Returns the current 'name' of the node (typically a parameter name).
FGuid &	GetParameterExpressionId()	Callback to access derived classes' parameter expression id.
FName	GetParameterName()
bool	GetParameterValue ( FMaterialParameterMetadata& OutMet... )
bool	HasAParameterName()	Parameter Name functions, this is requires as multiple class have ParameterName but are not UMaterialExpressionParameter due to class hierarchy.
bool	MatchesSearchQuery ( const TCHAR* SearchQuery )	MatchesSearchQuery: Check this expression to see if it matches the search query
void	SetEditableName ( const FString& NewName )	Sets the current 'name' of the node (typically a parameter name) Only valid to call on a node that previously returned CanRenameNode() = true.
void	SetParameterName ( const FName& Name )
bool	SetParameterValue ( const FName& Name, const FMaterialParameterMetadata& ..., EMaterialExpressionSetParameterValu... )
void	ValidateParameterName ( const bool bAllowDuplicateName )

Deprecated Functions

		Name	Description
	void	GetAllParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds, const FMaterialParameterInfo& InBa... )	Use GetAllParameterInfoOfType or GetAllParametersOfType
	bool	IsNamedParameter ( const FHashedMaterialParameterInfo ..., UFont*& OutFontValue, int32& OutFontPage )	Use GetParameterValue and/or GetParameterName