FDisplacementMap

API > API/Runtime > API/Runtime/GeometryCore

   
Name FDisplacementMap
Type class
Header File /Engine/Source/Runtime/GeometryCore/Public/Image/DisplacementMap.h
Include Path #include "Image/DisplacementMap.h"

Syntax

class FDisplacementMap

Constructors

Name Remarks Include Path Unreal Specifiers
  Image/DisplacementMap.h  

GEOMETRYCORE_API FDisplacementMap ( TArray64< uint8 >&& InSourceData,
ETextureSourceFormat InSourceFormat,
const int32 InSizeX,
const int32 InSizeY,
float InMagnitude,
float InCenter,
TextureAddress InAddressX,
TextureAddress InAddressY
)

 Claims ownership of raw input source-data. Image/DisplacementMap.h  

GEOMETRYCORE_API FDisplacementMap ( TArrayView64< const uint8 > InSourceDataView,
ETextureSourceFormat InSourceFormat,
const int32 InSizeX,
const int32 InSizeY,
float InMagnitude,
float InCenter,
TextureAddress InAddressX,
TextureAddress InAddressY
)

 Reference input data through view. Image/DisplacementMap.h  
  Image/DisplacementMap.h  
  Image/DisplacementMap.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDisplacementMap()

   Image/DisplacementMap.h  

Constants

Name Type Remarks Include Path
MAX_NUM_MIP_LEVELS size_t   Image/DisplacementMap.h
MAX_RESOLUTION int32   Image/DisplacementMap.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AddressX TextureAddress   Image/DisplacementMap.h  
AddressY TextureAddress   Image/DisplacementMap.h  
BytesPerPixel int32   Image/DisplacementMap.h  
Center float   Image/DisplacementMap.h  
Magnitude float   Image/DisplacementMap.h  
MipData TArray< FVector2f >   Image/DisplacementMap.h  
MipDataFiltered TArray< float >   Image/DisplacementMap.h  
NumLevels uint32   Image/DisplacementMap.h  
SizeX int32   Image/DisplacementMap.h  
SizeY int32   Image/DisplacementMap.h  
SourceData TArrayView64< const uint8 >   Image/DisplacementMap.h  
SourceFormat ETextureSourceFormat   Image/DisplacementMap.h  
Storage TArray64< uint8 >   Image/DisplacementMap.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 GetSizeX()

   Image/DisplacementMap.h  

int32 GetSizeY()

   Image/DisplacementMap.h  

FVector2f Load ( int32 x,
int32 y,
uint32 Level
) const

   Image/DisplacementMap.h  

float Load ( int32 x,
int32 y
) const

   Image/DisplacementMap.h  

float LoadFiltered ( int32 x,
int32 y,
uint32 Level
) const

   Image/DisplacementMap.h  

float Sample ( FVector2f UV
) const

 Bilinear filtered. Image/DisplacementMap.h  

FVector2f Sample ( FVector2f MinUV,
FVector2f MaxUV
) const

 Bounds over UV-rectangle (approximate, but conservative) Image/DisplacementMap.h  

FVector2f Sample ( int32 x,
int32 y,
uint32 Level
) const

   Image/DisplacementMap.h  

float Sample ( int32 x,
int32 y
) const

   Image/DisplacementMap.h  

float SampleEWA ( FVector2f UV,
FVector2f Axis0,
FVector2f Axis1
) const

 Filtered with elliptic weighted averaging Image/DisplacementMap.h  

FVector2f SampleHierarchical ( FVector2f MinUV,
FVector2f MaxUV,
uint32 MaxRefinements
) const

 Bounds over UV-rectangle (hierarchical traversal, increased refinements lead to tighter bounds, but significantly more expensive for large numbers of refinements) Image/DisplacementMap.h  

FVector2f WarpSample ( const FVector2f& UV
) const

 Hierarchical sample warping for perfect importance sampling according to probability density represented by image (not required to be normalized). Image/DisplacementMap.h  

Public Virtual

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetBytesPerPixel ( const ETextureSourceFormat SourceFormat
)

 Returns, iff SourceFormat is not supported Image/DisplacementMap.h  

static int32 GetMaxResolution()

   Image/DisplacementMap.h  

static bool IsSupportedSourceFormat ( const ETextureSourceFormat SourceFormat
)

   Image/DisplacementMap.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Image/DisplacementMap.h  
  Image/DisplacementMap.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page