FImageDimensions | Unreal Engine 5.6 Documentation

FImageDimensions provides various functions for working with size/indices/coordinates of a 2D image, as well as standard UV spaces


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

Syntax

class FImageDimensions

Name	Remarks	Include Path	Unreal Specifiers
FImageDimensions ( int32 WidthIn, int32 HeightIn )		Image/ImageDimensions.h

Name	Remarks	Include Path
void Clamp ( int32& X, int32& Y ) const	Clamp input coordinates to valid range of image coordinates	Image/ImageDimensions.h
void Clamp ( FVector2i& Coords ) const	Clamp input coordinates to valid range of image coordinates	Image/ImageDimensions.h
FVector2i GetCoords ( int64 LinearIndex ) const		Image/ImageDimensions.h
int32 GetHeight()		Image/ImageDimensions.h
int64 GetIndex ( int32 X, int32 Y ) const		Image/ImageDimensions.h
int64 GetIndex ( const FVector2i& Coords ) const		Image/ImageDimensions.h
int64 GetIndexMirrored ( const FVector2i& Coords, bool bFlipX, bool bFlipY ) const		Image/ImageDimensions.h
FVector2d GetTexelDistance ( const FVector2d& P, const FVector2d Q ) const		Image/ImageDimensions.h
FVector2d GetTexelSize()		Image/ImageDimensions.h
FVector2d GetTexelUV ( int64 LinearIndex ) const		Image/ImageDimensions.h
FVector2d GetTexelUV ( const FVector2i& Coords ) const		Image/ImageDimensions.h
int32 GetWidth()		Image/ImageDimensions.h
bool IsSquare()		Image/ImageDimensions.h
bool IsValidCoords ( const FVector2i& Coords ) const		Image/ImageDimensions.h
int64 Num()		Image/ImageDimensions.h
FVector2i PixelToCoords ( const FVector2d& PixelPosition ) const		Image/ImageDimensions.h
void SetDimensions ( int32 WidthIn, int32 HeightIn )	Set the dimensions of this image.	Image/ImageDimensions.h
FVector2i UVToCoords ( const FVector2d& UVPosition ) const		Image/ImageDimensions.h

Name	Remarks	Include Path	Unreal Specifiers
bool operator!= ( const FImageDimensions& Other ) const		Image/ImageDimensions.h
bool operator== ( const FImageDimensions& Other ) const		Image/ImageDimensions.h