MaterialExpressionTextureSample.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "MaterialExpressionIO.h"
#include "Materials/MaterialParameters.h"
#include "Materials/MaterialExpressionTextureBase.h"
#include "MaterialExpressionTextureSample.generated.h"
 
struct FPropertyChangedEvent;
enum ETextureMipValueMode : int;
enum ESamplerSourceMode : int;
 
UENUM()
enum ETextureGatherMode : int
{
    TGM_None UMETA(DisplayName = "None"),
    TGM_Red UMETA(DisplayName = "Red"),
    TGM_Green UMETA(DisplayName = "Green"),
    TGM_Blue UMETA(DisplayName = "Blue"),
    TGM_Alpha UMETA(DisplayName = "Alpha"),
 
    TGM_MAX,
};
 
UCLASS(collapsecategories, hidecategories=Object, MinimalAPI)
class UMaterialExpressionTextureSample : public UMaterialExpressionTextureBase
{
    GENERATED_UCLASS_BODY()
 
    UPROPERTY(meta = (RequiredInput = "false", ToolTip = "Defaults to 'ConstCoordinate' if not specified"))
    FExpressionInput Coordinates;
 
    UPROPERTY(meta = (RequiredInput = "false", ToolTip = "Defaults to 'Texture' if not specified"))
    FExpressionInput TextureObject;
 
    UPROPERTY(meta = (RequiredInput = "false", ToolTip = "Defaults to 'AutomaticViewMipBias' if not specified"))
    FExpressionInput MipValue;
    
    UPROPERTY(meta = (RequiredInput = "true", ToolTip = "Coordinates derivative over the X axis"))
    FExpressionInput CoordinatesDX;
    
    UPROPERTY(meta = (RequiredInput = "true", ToolTip = "Coordinates derivative over the Y axis"))
    FExpressionInput CoordinatesDY;
 
    UPROPERTY(meta = (RequiredInput = "false", ToolTip = "Ignored if not specified"))
    FExpressionInput AutomaticViewMipBiasValue;
 
    UPROPERTY(EditAnywhere, Category=MaterialExpressionTextureSample, meta=(DisplayName = "MipValueMode", ShowAsInputPin = "Advanced"))
    TEnumAsByte<ETextureMipValueMode> MipValueMode;
 
    UPROPERTY(EditAnywhere, Category=MaterialExpressionTextureSample, Meta = (ShowAsInputPin = "Advanced"))
    TEnumAsByte<ESamplerSourceMode> SamplerSource;
 
    UPROPERTY(EditAnywhere, Category = MaterialExpressionTextureSample)
    TEnumAsByte<ETextureGatherMode> GatherMode;
 
    UPROPERTY(EditAnywhere, Category = MaterialExpressionTextureSample)
    uint8 AutomaticViewMipBias : 1;
 
    UPROPERTY(EditAnywhere, Category = ParameterCustomization, meta=(EditorOnlyLocalization))
    FParameterChannelNames ChannelNames;
 
protected:
    // Inherited parameter expressions can hide unused input pin
    uint8 bShowTextureInputPin : 1;
 
#if WITH_EDITOR
#endif
 
public:
 
    UPROPERTY(EditAnywhere, Category = MaterialExpressionTextureSample, meta = (OverridingInputProperty = "Coordinates"))
    uint8 ConstCoordinate;
 
    UPROPERTY(EditAnywhere, Category = MaterialExpressionTextureSample)
    int32 ConstMipValue;
 
    //~ Begin UObject Interface
#if WITH_EDITOR
    ENGINE_API virtual bool CanEditChange(const FProperty* InProperty) const override;
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    ENGINE_API virtual void PostLoad() override;
 
    ENGINE_API void ApplyChannelNames();
    FParameterChannelNames GetTextureChannelNames() const
    {
        return ChannelNames;
    }
#endif // WITH_EDITOR
    //~ End UObject Interface
 
    //~ Begin UMaterialExpression Interface
#if WITH_EDITOR
    ENGINE_API virtual void Build(MIR::FEmitter& Emitter) override;
    ENGINE_API virtual TArrayView<FExpressionInput*> GetInputsView() override;
    ENGINE_API virtual FExpressionInput* GetInput(int32 InputIndex) override;
    ENGINE_API virtual FName GetInputName(int32 InputIndex) const override;
    ENGINE_API virtual int32 GetWidth() const override;
    ENGINE_API virtual void GetConnectorToolTip(int32 InputIndex, int32 OutputIndex, TArray<FString>& OutToolTip) override;
    virtual int32 GetLabelPadding() override { return 8; }
    ENGINE_API virtual int32 Compile(class FMaterialCompiler* Compiler, int32 OutputIndex) override;
    ENGINE_API virtual void GetCaption(TArray<FString>& OutCaptions) const override;
    ENGINE_API virtual EMaterialValueType GetInputValueType(int32 InputIndex) override;
    virtual bool CanIgnoreOutputIndex() { return true; }
    #endif // WITH_EDITOR
    //~ End UMaterialExpression Interface
 
    ENGINE_API void UpdateTextureResource(class UTexture* InTexture);
    
#if WITH_EDITOR
    ENGINE_API int32 CompileMipValue0(class FMaterialCompiler* Compiler);
    ENGINE_API int32 CompileMipValue1(class FMaterialCompiler* Compiler);
#endif // WITH_EDITOR
};