FImageDimensions

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

Windows
MacOS
Linux

References

Module

GeometricObjects

Header

/Engine/Plugins/Experimental/GeometryProcessing/Source/GeometricObjects/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

Protected variable

int32

 

Height

Protected variable

int32

 

Width

Constructors

Name Description

Public function

FImageDimensions

(
    int32 WidthIn,
    int32 HeightIn
)

Functions

Name Description

Public function Const

void

 

Clamp

(
    int32& X,
    int32& Y
)

Clamp input coordinates to valid range of image coordinates

Public function Const

void

 

Clamp

(
    FVector2i& Coords
)

Clamp input coordinates to valid range of image coordinates

Public function Const

FVector2i

 

GetCoords

(
    int64 LinearIndex
)

Public function Const

int32

 

GetHeight()

Public function Const

int64

 

GetIndex

(
    int32 X,
    int32 Y
)

Public function Const

int64

 

GetIndex

(
    const FVector2i& Coords
)

Public function Const

int64

 

GetIndexMirrored

(
    const FVector2i& Coords,
    bool bFlipX,
    bool bFlipY
)

Public function Const

FVector2d

 

GetTexelSize()

Public function Const

FVector2d

 

GetTexelUV

(
    int64 LinearIndex
)

Public function Const

FVector2d

 

GetTexelUV

(
    const FVector2i& Coords
)

Public function Const

int32

 

GetWidth()

Public function Const

bool

 

IsSquare()

Public function Const

bool

 

IsValidCoords

(
    const FVector2i& Coords
)

Public function Const

int64

 

Num()

Public function Const

FVector2i

 

PixelToCoords

(
    const FVector2d& PixelPosition
)

Public function

void

 

SetDimensions

(
    int32 WidthIn,
    int32 HeightIn
)

Public function Const

FVector2i

 

UVToCoords

(
    const FVector2d& UVPosition
)

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FImageDimensions& Other
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss