1. Epic GamesDeveloper
  3. UMaterialExpressionTextureSample

UMaterialExpressionTextureSample

API > API/Runtime > API/Runtime/Engine

   
Name UMaterialExpressionTextureSample
Type class
Header File /Engine/Source/Runtime/Engine/Public/Materials/MaterialExpressionTextureSample.h
Include Path #include "Materials/MaterialExpressionTextureSample.h"

Syntax

UCLASS (CollapseCategories, HideCategories=Object, MinimalAPI)  
class UMaterialExpressionTextureSample : public UMaterialExpressionTextureBase

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterialExpressionTextureSample ( const FObjectInitializer& ObjectInitializer
)

   Materials/MaterialExpressionTextureSample.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AutomaticViewMipBias uint8 Whether the texture should be sampled with per view mip biasing for sharper output with Temporal AA. Materials/MaterialExpressionTextureSample.h
  • EditAnywhere
  • Category=MaterialExpressionTextureSample
AutomaticViewMipBiasValue FExpressionInput   Materials/MaterialExpressionTextureSample.h
  • Meta=(RequiredInput="false", ToolTip="Ignored if not specified")
ChannelNames FParameterChannelNames   Materials/MaterialExpressionTextureSample.h
  • EditAnywhere
  • Category=ParameterCustomization
ConstCoordinate uint8 Only used if Coordinates is not hooked up Materials/MaterialExpressionTextureSample.h
  • EditAnywhere
  • Category=MaterialExpressionTextureSample
  • Meta=(OverridingInputProperty="Coordinates")
ConstMipValue int32 Only used if MipValue is not hooked up Materials/MaterialExpressionTextureSample.h
  • EditAnywhere
  • Category=MaterialExpressionTextureSample
Coordinates FExpressionInput   Materials/MaterialExpressionTextureSample.h
  • Meta=(RequiredInput="false", ToolTip="Defaults to 'ConstCoordinate' if not specified")
CoordinatesDX FExpressionInput Enabled only if MipValueMode == TMVM_Derivative Materials/MaterialExpressionTextureSample.h
  • Meta=(RequiredInput="true", ToolTip="Coordinates derivative over the X axis")
CoordinatesDY FExpressionInput Enabled only if MipValueMode == TMVM_Derivative Materials/MaterialExpressionTextureSample.h
  • Meta=(RequiredInput="true", ToolTip="Coordinates derivative over the Y axis")
GatherMode TEnumAsByte< ETextureGatherMode > Whether to do a Gather of the given component from 4 neighboring texels (xyzw in counter clockwise order starting with the sample to the lower left). Materials/MaterialExpressionTextureSample.h
  • EditAnywhere
  • Category=MaterialExpressionTextureSample
MipValue FExpressionInput Meaning depends on MipValueMode, a single unit is one mip level Materials/MaterialExpressionTextureSample.h
  • Meta=(RequiredInput="false", ToolTip="Defaults to 'AutomaticViewMipBias' if not specified")
MipValueMode TEnumAsByte< ETextureMipValueMode > Defines how the MipValue property is applied to the texture lookup Materials/MaterialExpressionTextureSample.h
  • EditAnywhere
  • Category=MaterialExpressionTextureSample
  • Meta=(DisplayName="MipValueMode", ShowAsInputPin="Advanced")
SamplerSource TEnumAsByte< ESamplerSourceMode > Controls where the sampler for this texture lookup will come from. Materials/MaterialExpressionTextureSample.h
  • EditAnywhere
  • Category=MaterialExpressionTextureSample
  • Meta=(ShowAsInputPin="Advanced")
TextureObject FExpressionInput Texture object input which overrides Texture if specified. Materials/MaterialExpressionTextureSample.h
  • Meta=(RequiredInput="false", ToolTip="Defaults to 'Texture' if not specified")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyChannelNames()

   Materials/MaterialExpressionTextureSample.h  

int32 CompileMipValue0 ( FMaterialCompiler* Compiler
)

   Materials/MaterialExpressionTextureSample.h  

int32 CompileMipValue1 ( FMaterialCompiler* Compiler
)

   Materials/MaterialExpressionTextureSample.h  

FParameterChannelNames GetTextureChannelNames()

   Materials/MaterialExpressionTextureSample.h  

void UpdateTextureResource ( UTexture* InTexture
)

   Materials/MaterialExpressionTextureSample.h  

Overridden from UMaterialExpression

Name Remarks Include Path Unreal Specifiers

virtual void Build ( MIR::FEmitter& Emitter
)

 Builds this expression's material IR. Materials/MaterialExpressionTextureSample.h  

virtual bool CanIgnoreOutputIndex()

 If true, discards the output index when caching this expression which allows more cases to re-use the output instead of adding a separate instruction Materials/MaterialExpressionTextureSample.h  

virtual int32 Compile ( FMaterialCompiler* Compiler,
int32 OutputIndex
)

 Create the new shader code chunk needed for the Abs expression Materials/MaterialExpressionTextureSample.h  

virtual void GetCaption ( TArray< FString >& OutCaptions
) const

 Returns the text to display on the material expression (in the material editor). Materials/MaterialExpressionTextureSample.h  

virtual void GetConnectorToolTip ( int32 InputIndex,
int32 OutputIndex,
TArray< FString >& OutToolTip
)

 Get a tooltip for the specified connector. Materials/MaterialExpressionTextureSample.h  

virtual FExpressionInput * GetInput ( int32 InputIndex
)

 Returns the input at index InputIndex if valid, nullptr otherwise. Materials/MaterialExpressionTextureSample.h  

virtual FName GetInputName ( int32 InputIndex
) const

   Materials/MaterialExpressionTextureSample.h  

virtual TArrayView< FExpressionInput * > GetInputsView()

   Materials/MaterialExpressionTextureSample.h  

virtual EMaterialValueType GetInputValueType ( int32 InputIndex
)

   Materials/MaterialExpressionTextureSample.h  

virtual int32 GetLabelPadding()

 Returns the amount of padding to use for the label. Materials/MaterialExpressionTextureSample.h  

virtual int32 GetWidth()

 Get the width required by this expression (in the material editor). Materials/MaterialExpressionTextureSample.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Materials/MaterialExpressionTextureSample.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Materials/MaterialExpressionTextureSample.h  

virtual void PostLoad()

   Materials/MaterialExpressionTextureSample.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page