TImageBuilder | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/GeometryCore

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


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

Syntax

template<typename PixelType>  
class TImageBuilder

Functions

Public

Name	Remarks	Include Path
PixelType BilinearSample ( const FVector2d& PixelCoords, const PixelType& InvalidValue ) const	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.	Image/ImageBuilder.h
PixelType BilinearSampleUV ( const FVector2d& UVCoords, const PixelType& InvalidValue ) const	Sample the image value at floating-point UV coords with Bilinear interpolation.	Image/ImageBuilder.h
void Clear ( const PixelType& ClearValue )	Clear all Pixels in the current Mip to the clear/default color for the texture build type	Image/ImageBuilder.h
bool ContainsPixel ( int32 X, int32 Y ) const		Image/ImageBuilder.h
bool ContainsPixel ( const FVector2i& ImageCoords ) const		Image/ImageBuilder.h
void Convert ( TFunctionRef< OtherType(const PixelType&)> ConvertFunc, TImageBuilder< OtherType >& ConvertedImageOut ) const	Convert to a different data type of same Dimensions using ConvertFunc	Image/ImageBuilder.h
void CopyPixel ( int64 FromLinearIndex, int64 ToLinearIndex )	Copy Pixel value from one linear index to another	Image/ImageBuilder.h
TImageBuilder< PixelType > FastDownsample ( int32 SubSteps, const PixelType& ZeroValue, TFunctionRef< PixelType(PixelType, int)> AverageFunc ) const	Very basic downsampling technqiue that just averages NxN pixel blocks. Multi-threaded.	Image/ImageBuilder.h
const FImageDimensions & GetDimensions()		Image/ImageBuilder.h
TArrayView64< PixelType > GetImageBuffer ()		Image/ImageBuilder.h
TConstArrayView64< PixelType > GetImageBuffer ()		Image/ImageBuilder.h
PixelType & GetPixel ( const FVector2i& ImageCoords )	Get the Pixel at the given X/Y coordinates	Image/ImageBuilder.h
PixelType & GetPixel ( int64 LinearIndex )	Get the Pixel at the given linear index	Image/ImageBuilder.h
const PixelType & GetPixel ( const FVector2i& ImageCoords ) const	Get the Pixel at the given X/Y coordinates	Image/ImageBuilder.h
const PixelType & GetPixel ( int64 LinearIndex ) const	Get the Pixel at the given linear index	Image/ImageBuilder.h
PixelType & GetPixel ( int32 X, int32 Y )	Get the Pixel at the given X/Y coordinates	Image/ImageBuilder.h
const PixelType & GetPixel ( int32 X, int32 Y ) const	Get the Pixel at the given X/Y coordinates	Image/ImageBuilder.h
bool IsConstantValue()		Image/ImageBuilder.h
PixelType NearestSampleUV ( const FVector2d& UVCoords ) const	Sample the image value at floating-point UV coords with Nearest sampling.	Image/ImageBuilder.h
void SetDimensions ( FImageDimensions DimensionsIn )		Image/ImageBuilder.h
void SetPixel ( int64 LinearIndex, const PixelType& NewValue )	Set the Pixel at the given linear index to the given PixelType	Image/ImageBuilder.h
void SetPixel ( const FVector2i& ImageCoords, const PixelType& NewValue )	Set the Pixel at the given X/Y coordinates to the given PixelType	Image/ImageBuilder.h
void SetPixel ( int32 X, int32 Y, const PixelType& NewValue )	Set the Pixel at the given X/Y coordinates to the given PixelType	Image/ImageBuilder.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FVector2d GetTiledUV ( const FVector2d& UVCoords )		Image/ImageBuilder.h

Navigation

Syntax

Functions

Public

Static