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 > Plugins > Paper2D > PAPER2UMaterialExpressionSpriteTextureSampler

Light Theme

Dark Theme

PAPER2UMaterialExpressionSpriteTextureSampler

This is a texture sampler 2D with a special automatically defined parameter name. The texture specified here will be replaced by the SourceTexture or an AdditionalSourceTextures entry of a Paper2D sprite if this material is used on a sprite.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialExpression

UMaterialExpressionTextureBase

UMaterialExpressionTextureSample

UMaterialExpressionTextureSampleParameter

UMaterialExpressionTextureSampleParameter2D

PAPER2UMaterialExpressionSpriteTextureSampler

References

Module	Paper2D
Header	/Engine/Plugins/2D/Paper2D/Source/Paper2D/Public/MaterialExpressionSpriteTextureSampler.h
Include	#include "MaterialExpressionSpriteTextureSampler.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(
HideCategories=(MaterialExpressionTextureSampleParameter, MaterialExpressionSpriteTextureSampler))
class PAPER2UMaterialExpressionSpriteTextureSampler : public UMaterialExpressionTextureSampleParameter2D

Remarks

This is a texture sampler 2D with a special automatically defined parameter name. The texture specified here will be replaced by the SourceTexture or an AdditionalSourceTextures entry of a Paper2D sprite if this material is used on a sprite.

Variables

	Name	Description
int32	AdditionalSlotIndex	This is the slot index into the AdditionalSourceTextures array.
bool	bSampleAdditionalTextures	Is this a sampler for the default SourceTexture or the AdditionalSourceTextures list?
FText	SlotDisplayName	Friendly label for the texture slot, displayed in the Sprite Editor if not empty.

Constructors

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

Overridden from UMaterialExpression

	Name	Description
bool	CanRenameNode()	Can this node be renamed?
void	GetCaption ( TArray< FString >& OutCaptions )	Returns the text to display on the material expression (in the material editor).
void	GetExpressionToolTip ( TArray< FString >& OutToolTip )	Get a tooltip for the expression itself.
FText	GetKeywords()	Returns the keywords that should be used when searching for this expression

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