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 > UMaterialExpressionTextureSampleParameter

Light Theme

Dark Theme

UMaterialExpressionTextureSampleParameter

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialExpression

UMaterialExpressionTextureBase

UMaterialExpressionTextureSample

UMaterialExpressionTextureSampleParameter

UMaterialExpressionTextureObjectParameter

UMaterialExpressionTextureSampleParameter2D

	PAPER2UMaterialExpressionSpriteTextureSampler
	UMaterialExpressionAntialiasedTextureMask
	UMaterialExpressionTextureSampleParameterSubUV

UMaterialExpressionTextureSampleParameter2DArray

UMaterialExpressionTextureSampleParameterCube

UMaterialExpressionTextureSampleParameterVolume

References

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

Syntax

class UMaterialExpressionTextureSampleParameter : public UMaterialExpressionTextureSample

Variables

	Name	Description
FParameterChann...	ChannelNames
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
int32	SortPriority	Controls where the this parameter is displayed in a material instance parameter list.

Constructors

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

Functions

	Name	Description
void	ApplyChannelNames()
void	GetAllParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds, const FMaterialParameterInfo& InBa... )
FParameterCh...	GetTextureChannelNames()
bool	IsNamedParameter ( const FHashedMaterialParameterInfo ..., UTexture*& OutValue )	Return whether this is the named parameter, and fill in its value
void	SetDefaultTexture()	Sets the default texture if none is set
bool	SetParameterValue ( FName InParameterName, UTexture* InValue )
bool	TextureIsValid ( UTexture* InTexture, FString& OutMessage )	Return true if the texture is a movie texture

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	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 )
void	SetValueToMatchingExpression ( UMaterialExpression* OtherExpr... )
void	ValidateParameterName ( const bool bAllowDuplicateName )

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

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

Take our survey

Dismiss