Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Materials
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMaterialExpression
- UMaterialExpressionTextureBase
- UMaterialExpressionTextureSample
- UMaterialExpressionParticleSubUV
- UMaterialExpressionTextureSampleParameter
- UMaterialExpressionTextureObjectParameter
- UMaterialExpressionTextureSampleParameter2D
- UMaterialExpressionAntialiasedTextureMask
- UMaterialExpressionMaterialXTextureSampleParameterBlur
- UMaterialExpressionTextureSampleParameterSubUV
- UMaterialExpressionTextureSampleParameter2DArray
- UMaterialExpressionTextureSampleParameterCube
- UMaterialExpressionTextureSampleParameterCubeArray
- UMaterialExpressionTextureSampleParameterVolume
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/Materials/MaterialExpressionTextureSample.h |
| Include | #include "Materials/MaterialExpressionTextureSample.h" |
Syntax
UCLASS (CollapseCategories, HideCategories=Object, MinimalAPI)
class UMaterialExpressionTextureSample : public UMaterialExpressionTextureBase
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint8: 1 | AutomaticViewMipBias | Whether the texture should be sampled with per view mip biasing for sharper output with Temporal AA. | |
| FExpressionInput | AutomaticViewMipBiasValue | ||
| uint8: 1 | bShowTextureInputPin | Inherited parameter expressions can hide unused input pin. | |
| uint8 | ConstCoordinate | Only used if Coordinates is not hooked up | |
| int32 | ConstMipValue | Only used if MipValue is not hooked up | |
| FExpressionInput | Coordinates | ||
| FExpressionInput | CoordinatesDX | Enabled only if MipValueMode == TMVM_Derivative | |
| FExpressionInput | CoordinatesDY | Enabled only if MipValueMode == TMVM_Derivative | |
| FExpressionInput | MipValue | Meaning depends on MipValueMode, a single unit is one mip level | |
| TEnumAsByte< ETextureMipValueMode > | MipValueMode | Defines how the MipValue property is applied to the texture lookup | |
| TEnumAsByte< ESamplerSourceMode > | SamplerSource | Controls where the sampler for this texture lookup will come from. | |
| FExpressionInput | TextureObject | Texture object input which overrides Texture if specified. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UMaterialExpressionTextureSample
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| int32 | CompileMipValue0
(
FMaterialCompiler* Compiler |
||
| int32 | CompileMipValue1
(
FMaterialCompiler* Compiler |
||
| bool | GenerateHLSLExpressionBase
(
FMaterialHLSLGenerator& Generator, |
||
| void | UpdateTextureResource
(
UTexture* InTexture |
Overridden from UMaterialExpression
| Type | Name | Description | |
|---|---|---|---|
| void | Build
(
UE::MIR::FEmitter& Emitter |
Builds this expression's material IR. | |
| bool | 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 | ||
| int32 | Compile
(
FMaterialCompiler* Compiler, |
Create the new shader code chunk needed for the Abs expression | |
| bool | GenerateHLSLExpression
(
FMaterialHLSLGenerator& Generator, |
||
| void | GetCaption
(
TArray< FString >& OutCaptions |
Returns the text to display on the material expression (in the material editor). | |
| void | GetConnectorToolTip
(
int32 InputIndex, |
Get a tooltip for the specified connector. | |
| FExpressionInput * | Returns the input at index InputIndex if valid, nullptr otherwise. | ||
| FName | GetInputName
(
int32 InputIndex |
||
| TArrayView< FExpressionInput * > | |||
| uint32 | GetInputType
(
int32 InputIndex |
||
| int32 | Returns the amount of padding to use for the label. | ||
| int32 | GetWidth () |
Get the width required by this expression (in the material editor). |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| bool | CanEditChange
(
const FProperty* InProperty |
Called by the editor to query whether a property of this object is allowed to be modified. | |
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |