1. Epic GamesDeveloper
  3. UPCGTextureSamplerSettings

UPCGTextureSamplerSettings

API > API/Plugins > API/Plugins/PCG

   
Name UPCGTextureSamplerSettings
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGTextureSampler.h
Include Path #include "Elements/PCGTextureSampler.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGTextureSamplerSettings : public UPCGSettings

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bForceEditorOnlyCPUSampling bool Even if the texture is not set to CPU-available, it can still be accessed from CPU memory under certain conditions (sRGB disabled, no mipmaps, and non-compressed format). Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings"
  • Meta=(DisplayName="Force Editor Only CPU Sampling")
bSkipReadbackToCPU bool Skip CPU readback during initialization of the texture data. Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
bSynchronousLoad bool By default, texture loading is asynchronous, can force it synchronous if needed. Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Debug"
bUseAbsoluteTransform bool   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
bUseAdvancedTiling bool Whether to tile the source or to stretch it to fit target area. Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
bUseDensitySourceChannel bool   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=SpatialData
  • Meta=(InlineEditConditionToggle, PCG_Overridable, PCG_OverrideAliases="DensityFunction")
bUseTileBounds bool   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditionCondition="bUseAdvancedTiling", PCG_Overridable)
CenterOffset FVector2D   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditCondition="bUseAdvancedTiling", PCG_Overridable)
ColorChannel EPCGTextureColorChannel   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="bUseDensitySourceChannel", DisplayName="Density Source Channel", PCG_Overridable)
DensityFunction PRAGMA_DISABLE_DEPRECATION_WARNINGS EPCGTextureDensityFunction   Elements/PCGTextureSampler.h
  • BlueprintGetter=GetDensityFunctionEquivalent
  • BlueprintSetter=SetDensityFunctionEquivalent
  • Category=SpatialData
  • Meta=(DeprecatedProperty, DeprecatedMessage="Density function on GetTextureData is deprecated in favor of bUseDensitySourceChannel.")
Filter EPCGTextureFilter Method used to determine the value for a sample based on the value of nearby texels. Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
Rotation float Rotation to apply when sampling texture. Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(UIMin=360, ClampMin=360, UIMax=360, ClampMax=360, Units=deg, EditCondition="bUseAdvancedTiling", PCG_Overridable)
TexelSize float The size of one texel in cm, used when calling ToPointData. Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(UIMin="1.0", ClampMin="1.0", PCG_Overridable)
TextureArrayIndex int Index of texture array slice. Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition=bDisplayTextureArrayIndex, EditConditionHides, HideEditConditionToggle, ClampMin='0', PCG_Overridable)
TileBoundsMax FVector2D   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditCondition="bUseAdvancedTiling && bUseTileBounds", PCG_Overridable)
TileBoundsMin FVector2D   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditCondition="bUseAdvancedTiling && bUseTileBounds", PCG_Overridable)
Tiling FVector2D   Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditCondition="bUseAdvancedTiling", PCG_Overridable)
Transform FTransform Surface transform Elements/PCGTextureSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSoftObjectPtr< UTexture > GetTexture()

   Elements/PCGTextureSampler.h  

void SetTexture ( TSoftObjectPtr< UTexture > InTexture
)

   Elements/PCGTextureSampler.h  

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual bool CanDynamicallyTrackKeys()

 Derived classes must implement this to communicate that they might have dynamic dependencies. Elements/PCGTextureSampler.h  

virtual FName GetDefaultNodeName()

   Elements/PCGTextureSampler.h  

virtual FText GetDefaultNodeTitle()

   Elements/PCGTextureSampler.h  

virtual FText GetNodeTooltipText()

   Elements/PCGTextureSampler.h  

virtual void GetStaticTrackedKeys ( FPCGSelectionKeyToSettingsMap& OutKeysToSettings,
TArray< TObjectPtr< const UPCGGraph > >& OutVisitedGraphs
) const

 Derived classes must implement this to communicate dependencies that are known statically. Elements/PCGTextureSampler.h  

virtual EPCGSettingsType GetType()

   Elements/PCGTextureSampler.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Elements/PCGTextureSampler.h  

virtual void PostLoad()

   Elements/PCGTextureSampler.h  

Protected

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS EPCGTextureDensityFunction GetDensityFunctionEquivalent()

   Elements/PCGTextureSampler.h
  • BlueprintGetter
  • Meta=(BlueprintInternalUseOnly="true")

void SetDensityFunctionEquivalent ( EPCGTextureDensityFunction DensityFunction
)

   Elements/PCGTextureSampler.h
  • BlueprintSetter
  • Meta=(BlueprintInternalUseOnly="true")

void UpdateDisplayTextureArrayIndex()

   Elements/PCGTextureSampler.h  

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FPCGElementPtr CreateElement()

   Elements/PCGTextureSampler.h  

virtual TArray< FPCGPinProperties > InputPinProperties()

 Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. Elements/PCGTextureSampler.h  

virtual TArray< FPCGPinProperties > OutputPinProperties()

   Elements/PCGTextureSampler.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page