UMaterialExpressionTextureSample

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Materials/MaterialExpressionTextureSample.h

Include

#include "Materials/MaterialExpressionTextureSample.h"

Syntax

class UMaterialExpressionTextureSample : public UMaterialExpressionTextureBase

Variables

Name Description

Public variable

uint8 : 1

 

AutomaticViewMipBias

Whether the texture should be sampled with per view mip biasing for sharper output with Temporal AA.

Public variable

FExpressionInpu ...

 

AutomaticViewMipBiasValue

Protected variable

uint8 : 1

 

bShowTextureInputPin

Inherited parameter expressions can hide unused input pin.

Public variable

uint8

 

ConstCoordinate

Only used if Coordinates is not hooked up

Public variable

int32

 

ConstMipValue

Only used if MipValue is not hooked up

Public variable

FExpressionInpu ...

 

Coordinates

Public variable

FExpressionInpu ...

 

CoordinatesDX

Enabled only if MipValueMode == TMVM_Derivative

Public variable

FExpressionInpu ...

 

CoordinatesDY

Enabled only if MipValueMode == TMVM_Derivative

Public variable

FExpressionInpu ...

 

MipValue

Meaning depends on MipValueMode, a single unit is one mip level

Public variable

TEnumAsByte < en...

 

MipValueMode

Defines how the MipValue property is applied to the texture lookup

Public variable

TEnumAsByte < en...

 

SamplerSource

Controls where the sampler for this texture lookup will come from.

Public variable

FExpressionInpu ...

 

TextureObject

Texture object input which overrides Texture if specified.

Constructors

Name Description

Public function

UMaterialExpressionTextureSample

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

int32

 

CompileMipValue0

(
    FMaterialCompiler * Compiler
)

Public function

int32

 

CompileMipValue1

(
    FMaterialCompiler * Compiler
)

Public function

void

 

UpdateTextureResource

(
    UTexture * InTexture
)

Overridden from UMaterialExpression

Name Description

Public function 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

Public function Virtual

int32

 

Compile

(
    FMaterialCompiler * Compiler,
    int32 OutputIndex
)

Create the new shader code chunk needed for the Abs expression

Public function Virtual Const

void

 

GetCaption

(
    TArray < FString >& OutCaptions
)

Returns the text to display on the material expression (in the material editor).

Public function Virtual

void

 

GetConnectorToolTip

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

Get a tooltip for the specified connector.

Public function Virtual

FExpressionI ...

 

GetInput

(
    int32 InputIndex
)

Public function Virtual Const

FName

 

GetInputName

(
    int32 InputIndex
)

Public function Virtual

const TArray ...

 

GetInputs()

Public function Virtual

uint32

 

GetInputType

(
    int32 InputIndex
)

Public function Virtual

int32

 

GetLabelPadding()

Returns the amount of padding to use for the label.

Public function Virtual Const

int32

 

GetWidth()

Get the width required by this expression (in the material editor).

Public function Virtual

bool

 

MatchesSearchQuery

(
    const TCHAR * SearchQuery
)

MatchesSearchQuery: Check this expression to see if it matches the search query

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

CanEditChange

(
    const FProperty * InProperty
)

Called by the editor to query whether a property of this object is allowed to be modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback