UPCGTexture2DSingleBaseData

Base class for a 2D texture or render target.

API > API/Plugins > API/Plugins/PCG

Base class for a 2D texture or render target.

   
Name UPCGTexture2DSingleBaseData
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Data/PCGTextureData.h
Include Path #include "Data/PCGTextureData.h"

Syntax

UCLASS (MinimalAPI, Abstract)  
class UPCGTexture2DSingleBaseData : public UPCGTexture2DBaseData

Inheritance Hierarchy

Derived Classes

Typedefs

Name Type Remarks Include Path
TypeInfo FPCGDataTypeInfoTexture2DSingleBase   Data/PCGTextureData.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bUseAdvancedTiling bool Whether to tile the source or to stretch it to fit target area. Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
bUseDensitySourceChannel bool   Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(InlineEditConditionToggle)
bUseTileBounds bool   Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditionCondition="bUseAdvancedTiling")
CenterOffset FVector2D   Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditCondition="bUseAdvancedTiling")
ColorChannel EPCGTextureColorChannel   Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(DisplayName="Density Source Channel", EditCondition="bUseDensitySourceChannel")
DensityFunction EPCGTextureDensityFunction   Data/PCGTextureData.h
  • BlueprintGetter=GetDensityFunctionEquivalent
  • BlueprintSetter=SetDensityFunctionEquivalent
  • Category=SpatialData
  • Meta=(DeprecatedProperty, DeprecatedMessage="Density function on GetTextureData is deprecated in favor of bUseDensitySourceChannel.")
Rotation float Rotation to apply when sampling texture. Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(UIMin=360, ClampMin=360, UIMax=360, ClampMax=360, Units=deg, EditCondition="bUseAdvancedTiling")
TexelSize float The size of one texel in cm, used when calling ToPointData. Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(UIMin="1.0", ClampMin="1.0")
TileBounds FBox2D   Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditCondition="bUseAdvancedTiling && bUseTileBounds")
Tiling FVector2D   Data/PCGTextureData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Tiling"
  • Meta=(EditCondition="bUseAdvancedTiling")

Functions

Public

Name Remarks Include Path Unreal Specifiers

EPixelFormat GetTextureFormat()

   Data/PCGTextureData.h  

bool IsReadbackComplete()

 Returns true if the readback process has concluded (success, failure, or not needed). Data/PCGTextureData.h  
Trigger async readback if needed. Returns true if CPU data is available now. Data/PCGTextureData.h  

bool SamplePointLocal ( const FVector2D& LocalPosition,
FVector4& OutColor,
float& OutDensity
) const

 Sample using a local space 'UV' position. Data/PCGTextureData.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual UTexture * GetTexture()

   Data/PCGTextureData.h  

virtual EPCGTextureResourceType GetTextureResourceType()

   Data/PCGTextureData.h  

virtual FTextureRHIRef GetTextureRHI()

   Data/PCGTextureData.h  

virtual FIntPoint GetTextureSize()

 Deprecated section. Data/PCGTextureData.h  

virtual int GetTextureSlice()

   Data/PCGTextureData.h  

virtual bool IsValid()

   Data/PCGTextureData.h  

Overridden from UPCGTexture2DBaseData

Name Remarks Include Path Unreal Specifiers

virtual FIntPoint GetResolution()

   Data/PCGTextureData.h  

Overridden from UPCGSpatialDataWithPointCache

Name Remarks Include Path Unreal Specifiers

virtual const UPCGPointArrayData * CreatePointArrayData ( FPCGContext* Context,
const FBox& InBounds
) const

   Data/PCGTextureData.h  

virtual const UPCGPointData * CreatePointData ( FPCGContext* Context
) const

   Data/PCGTextureData.h  

Overridden from UPCGSpatialData

Name Remarks Include Path Unreal Specifiers

virtual bool SamplePoint ( const FTransform& Transform,
const FBox& Bounds,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata
) const

 Sample rotation, scale and other attributes from this data at the query position. Data/PCGTextureData.h  

Overridden from UPCGData

Name Remarks Include Path Unreal Specifiers

virtual EPCGDataType GetDataType()

 @todo_pcg To be deprecated when we switch to the new type Data/PCGTextureData.h  

virtual const FPCGDataTypeBaseId & GetDataTypeId()

   Data/PCGTextureData.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Data/PCGTextureData.h  

virtual void PostLoad()

   Data/PCGTextureData.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CopyBaseTextureData ( UPCGTexture2DSingleBaseData* NewTextureData
) const

   Data/PCGTextureData.h  

const UPCGBasePointData * CreateBasePointData ( FPCGContext* Context,
TSubclassOf< UPCGBasePointData > PointDataClass
) const

   Data/PCGTextureData.h  

EPCGTextureDensityFunction GetDensityFunctionEquivalent()

   Data/PCGTextureData.h
  • BlueprintGetter
  • Meta=(BlueprintInternalUseOnly="true")

void SetDensityFunctionEquivalent ( EPCGTextureDensityFunction DensityFunction
)

   Data/PCGTextureData.h
  • BlueprintSetter
  • Meta=(BlueprintInternalUseOnly="true")

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual bool RequestCPUReadback ()

   Data/PCGTextureData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page