1. Epic GamesDeveloper
  3. TImageBuilder

TImageBuilder

[TImageBuilder](API\Runtime\GeometryCore\Image\TImageBuilder) is used to create and populate a 2D image with a templated "pixel" type.

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/Image

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/Image/ImageBuilder.h
Include #include "Image/ImageBuilder.h"

Syntax

template<typename PixelType>  
class TImageBuilder

Remarks

TImageBuilder is used to create and populate a 2D image with a templated "pixel" type.

Variables

  Type Name Description
Protected variable FImageDimensions Dimensions  
Protected variable TDenseGrid2< PixelType > Image  

Functions

  Type Name Description
Public function Const PixelType

BilinearSample ( const FVector2d& PixelCoords,
const PixelType& InvalidValue
)

 Sample the image value at floating-point pixel coords with Bilinear interpolation The pixel coords are expected to be in the [0,Width]x[0,Height] image pixel rectangle.
Public function Const PixelType

BilinearSampleUV ( const FVector2d& UVCoords,
const PixelType& InvalidValue
)

 Sample the image value at floating-point UV coords with Bilinear interpolation.
Public function void

Clear ( const PixelType& ClearValue
)

 Clear all Pixels in the current Mip to the clear/default color for the texture build type
Public function Const bool

ContainsPixel ( int32 X,
int32 Y
)

  
Public function Const bool

ContainsPixel ( const FVector2i& ImageCoords
)

  
Public function Const void

Convert ( TFunctionRef< OtherType(const PixelType&)> ConvertFunc,
TImageBuilder< OtherType >& ConvertedImageOut
)

 Convert to a different data type of same Dimensions using ConvertFunc
Public function void

CopyPixel ( int64 FromLinearIndex,
int64 ToLinearIndex
)

 Copy Pixel value from one linear index to another
Public function Const TImageBuilder< PixelType >

FastDownsample ( int32 SubSteps,
const PixelType& ZeroValue,
TFunctionRef< PixelType(PixelType, int)> AverageFunc
)

 Very basic downsampling technqiue that just averages NxN pixel blocks. Multi-threaded.
Public function Const const FImageDimensions &  
Public function TArrayView64< PixelType >  
Public function Const TConstArrayView64< PixelType >  
Public function PixelType &

GetPixel ( const FVector2i& ImageCoords
)

 Get the Pixel at the given X/Y coordinates
Public function PixelType &

GetPixel ( int64 LinearIndex
)

 Get the Pixel at the given linear index
Public function Const const PixelType &

GetPixel ( const FVector2i& ImageCoords
)

 Get the Pixel at the given X/Y coordinates
Public function Const const PixelType &

GetPixel ( int64 LinearIndex
)

 Get the Pixel at the given linear index
Public function PixelType &

GetPixel ( int32 X,
int32 Y
)

 Get the Pixel at the given X/Y coordinates
Public function Const const PixelType &

GetPixel ( int32 X,
int32 Y
)

 Get the Pixel at the given X/Y coordinates
Protected function Static FVector2d

GetTiledUV ( const FVector2d& UVCoords
)

  
Public function Const bool  
Public function Const PixelType

NearestSampleUV ( const FVector2d& UVCoords
)

 Sample the image value at floating-point UV coords with Nearest sampling.
Public function void

SetDimensions ( FImageDimensions DimensionsIn
)

  
Public function void

SetPixel ( int64 LinearIndex,
const PixelType& NewValue
)

 Set the Pixel at the given linear index to the given PixelType
Public function void

SetPixel ( const FVector2i& ImageCoords,
const PixelType& NewValue
)

 Set the Pixel at the given X/Y coordinates to the given PixelType
Public function void

SetPixel ( int32 X,
int32 Y,
const PixelType& NewValue
)

 Set the Pixel at the given X/Y coordinates to the given PixelType

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page