Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FImageDimensions

[FImageDimensions](API\Runtime\GeometryCore\Image\FImageDimensions) provides various functions for working with size/indices/coordinates of a 2D image, as well as standard UV spaces

Choose your operating system:

Windows

macOS

Linux

References

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

Syntax

class FImageDimensions

Remarks

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

Variables

		Name	Description
	int32	Height
	int32	Width

Constructors

	Name	Description
	FImageDimensions ( int32 WidthIn, int32 HeightIn )

Functions

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

Operators

		Name	Description
	bool	operator!= ( const FImageDimensions& Other )
	bool	operator== ( const FImageDimensions& Other )