FImageAdapter

[FImageAdapter](API\Runtime\GeometryCore\Image\FImageAdapter) is a wrapper around different types of [TImageBuilder](API\Runtime\GeometryCore\Image\TImageBuilder) that provides a standard interface, which allows functions that don't need to know about the specific image type to operate on "any" image.

Choose your operating system:

Windows

macOS

Linux

References

Module

GeometryCore

Header

/Engine/Source/Runtime/GeometryCore/Public/Image/ImageBuilder.h

Include

#include "Image/ImageBuilder.h"

Syntax

class FImageAdapter

Remarks

FImageAdapter is a wrapper around different types of TImageBuilder that provides a standard interface, which allows functions that don't need to know about the specific image type to operate on "any" image. For example to allow code that works on a 4-channel image to operate on a single-channel image (in which case the Adapter will expand/collapse the channels automatically).

Variables

Name Description

Protected variable

TImageBuilder< ...

 

Image1f

Protected variable

TImageBuilder< ...

 

Image3f

Protected variable

TImageBuilder< ...

 

Image4f

Protected variable

EImageType

 

ImageType

Constructors

Name Description

Public function

FImageAdapter

(
    TImageBuilder< float >* Image
)

Public function

FImageAdapter

(
    TImageBuilder< FVector3f >* Im...
)

Public function

FImageAdapter

(
    TImageBuilder< FVector4f >* Im...
)

Functions

Name Description

Public function Const

FImageDimens...

 

GetDimensions()

Public function Const

FVector4f

 

GetPixel

(
    int64 LinearIndex
)

Public function Const

FVector4f

 

GetPixel

(
    const FVector2i& PixelCoords
)

Public function

void

 

SetDimensions

(
    FImageDimensions Dimensions
)

Public function

void

 

SetPixel

(
    const FVector2i& PixelCoords,
    const FVector4f& FloatPixel
)

Public function

void

 

SetPixel

(
    const FVector2i& PixelCoords,
    const FLinearColor& FloatPixel
)

Enums

Name

Description

Public enum

EImageType