UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Attributes | List of all members
UE::Geometry::FImageDimensions Class Reference

#include <ImageDimensions.h>

Public Member Functions

 FImageDimensions (int32 WidthIn=0, int32 HeightIn=0)
 
void SetDimensions (int32 WidthIn, int32 HeightIn)
 
int32 GetWidth () const
 
int32 GetHeight () const
 
int64 Num () const
 
bool IsSquare () const
 
bool IsValidCoords (const FVector2i &Coords) const
 
void Clamp (int32 &X, int32 &Y) const
 
void Clamp (FVector2i &Coords) const
 
int64 GetIndex (int32 X, int32 Y) const
 
int64 GetIndex (const FVector2i &Coords) const
 
int64 GetIndexMirrored (const FVector2i &Coords, bool bFlipX, bool bFlipY) const
 
FVector2i GetCoords (int64 LinearIndex) const
 
FVector2d GetTexelSize () const
 
FVector2d GetTexelUV (const FVector2i &Coords) const
 
FVector2d GetTexelUV (int64 LinearIndex) const
 
FVector2d GetTexelDistance (const FVector2d &P, const FVector2d Q) const
 
FVector2i PixelToCoords (const FVector2d &PixelPosition) const
 
FVector2i UVToCoords (const FVector2d &UVPosition) const
 
bool operator== (const FImageDimensions &Other) const
 
bool operator!= (const FImageDimensions &Other) const
 

Protected Attributes

int32 Width = 0
 
int32 Height = 0
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FImageDimensions()

UE::Geometry::FImageDimensions::FImageDimensions ( int32  WidthIn = 0,
int32  HeightIn = 0 
)
inline

Member Function Documentation

◆ Clamp() [1/2]

void UE::Geometry::FImageDimensions::Clamp ( FVector2i &  Coords) const
inline

Clamp input coordinates to valid range of image coordinates

◆ Clamp() [2/2]

void UE::Geometry::FImageDimensions::Clamp ( int32 &  X,
int32 &  Y 
) const
inline

Clamp input coordinates to valid range of image coordinates

◆ GetCoords()

FVector2i UE::Geometry::FImageDimensions::GetCoords ( int64  LinearIndex) const
inline
Returns
2D image coordinates from linear index

◆ GetHeight()

int32 UE::Geometry::FImageDimensions::GetHeight ( ) const
inline
Returns
height of image

◆ GetIndex() [1/2]

int64 UE::Geometry::FImageDimensions::GetIndex ( const FVector2i &  Coords) const
inline
Returns
linear index into image from 2D coordinates

◆ GetIndex() [2/2]

int64 UE::Geometry::FImageDimensions::GetIndex ( int32  X,
int32  Y 
) const
inline
Returns
linear index into image from 2D coordinates

◆ GetIndexMirrored()

int64 UE::Geometry::FImageDimensions::GetIndexMirrored ( const FVector2i &  Coords,
bool  bFlipX,
bool  bFlipY 
) const
inline
Returns
linear index into image from 2D coordinates, optionally flipped around X and Y axes

◆ GetTexelDistance()

FVector2d UE::Geometry::FImageDimensions::GetTexelDistance ( const FVector2d &  P,
const FVector2d  Q 
) const
inline
Returns
The distance, measured in texels, between points P and Q which should be given in the default UV-space [0..1]^2

◆ GetTexelSize()

FVector2d UE::Geometry::FImageDimensions::GetTexelSize ( ) const
inline
Returns
Real-valued dimensions of a pixel/texel in the image, relative to default UV space [0..1]^2

◆ GetTexelUV() [1/2]

FVector2d UE::Geometry::FImageDimensions::GetTexelUV ( const FVector2i &  Coords) const
inline
Returns
Real-valued position of given texel center in default UV-space [0..1]^2

◆ GetTexelUV() [2/2]

FVector2d UE::Geometry::FImageDimensions::GetTexelUV ( int64  LinearIndex) const
inline
Returns
Real-valued position of given texel center in default UV-space [0..1]^2

◆ GetWidth()

int32 UE::Geometry::FImageDimensions::GetWidth ( ) const
inline
Returns
width of image

◆ IsSquare()

bool UE::Geometry::FImageDimensions::IsSquare ( ) const
inline
Returns
true if image is square

◆ IsValidCoords()

bool UE::Geometry::FImageDimensions::IsValidCoords ( const FVector2i &  Coords) const
inline
Returns
true if coordinates are valid, ie in-bounds of image dimensions

◆ Num()

int64 UE::Geometry::FImageDimensions::Num ( ) const
inline
Returns
number of elements in image

◆ operator!=()

bool UE::Geometry::FImageDimensions::operator!= ( const FImageDimensions &  Other) const
inline

◆ operator==()

bool UE::Geometry::FImageDimensions::operator== ( const FImageDimensions &  Other) const
inline

◆ PixelToCoords()

FVector2i UE::Geometry::FImageDimensions::PixelToCoords ( const FVector2d &  PixelPosition) const
inline
Returns
integer XY coordinates for real-valued XY coordinates (ie texel that contains value, if texel origin is in bottom-left

◆ SetDimensions()

void UE::Geometry::FImageDimensions::SetDimensions ( int32  WidthIn,
int32  HeightIn 
)
inline

Set the dimensions of this image.

◆ UVToCoords()

FVector2i UE::Geometry::FImageDimensions::UVToCoords ( const FVector2d &  UVPosition) const
inline
Returns
integer XY coordinates for UV coordinates, assuming default UV space [0..1]^2

Member Data Documentation

◆ Height

int32 UE::Geometry::FImageDimensions::Height = 0
protected

◆ Width

int32 UE::Geometry::FImageDimensions::Width = 0
protected
The documentation for this class was generated from the following file: