PAPER2FAlphaBitmap

Windows
MacOS
Linux

References

Module

Paper2D

Header

/Engine/Plugins/2D/Paper2D/Source/Paper2D/Public/AlphaBitmap.h

Include

#include "AlphaBitmap.h"

Syntax

struct PAPER2FAlphaBitmap

Variables

Name Description

Public variable

uint8

 

DefaultValue

Public variable

int32

 

Height

Public variable

TArray< uint8 >

 

RawData

Public variable

int32

 

Width

Functions

Name Description

Public function Const

void

 

AnalyzeImage

(
    int32 StartX,
    int32 StartY,
    int32 InWidth,
    int32 InHeight,
    bool& bOutHasZeros,
    bool& bOutHasIntermediateValues
)

Checks the image to determine if it is suitable for opaque, masked or translucent rendering.

Public function

void

 

ClearToDefaultValue()

Public function

void

 

DrawRectOutline

(
    int StartX,
    int StartY,
    int InWidth,
    int InHeight
)

Sets pixels to 1 marking the rectangle outline.

Public function

void

 

ExtractFromTexture

(
    UTexture* SourceTexture
)

Public function

 

FAlphaBitmap

(
    UTexture* SourceTexture,
    uint8 InDefaultValue
)

Public function

 

FAlphaBitmap

(
    int InWidth,
    int InHeight,
    int InDefaultValue
)

Create an empty bitmap.

Public function

void

 

FillRect

(
    int StartX,
    int StartY,
    int InWidth,
    int InHeight
)

Public function Const

bool

 

FoundClosestValidPoint

(
    int StartX,
    int StartY,
    const int MaxAllowedSearchDistance,
    FIntPoint& OutHitPoint
)

Wind through the bitmap from StartX, StartY to find the closest hit point.

Public function Const

uint8

 

GetPixel

(
    int X,
    int Y
)

Public function Const

void

 

GetTightBounds

(
    FIntPoint& OutOrigin,
    FIntPoint& OutDimension
)

Returns the tight bounding box around pixels that are not 0.

Public function Const

bool

 

IsColumnEmpty

(
    int X,
    int Y0,
    int Y1
)

Public function Const

bool

 

IsColumnEqual

(
    int X,
    int Y0,
    int Y1,
    int Target
)

Public function

bool

 

IsRegionEmpty

(
    int32 X0,
    int32 Y0,
    int32 X1,
    int32 Y1
)

Is the rectangle empty (X0..X1, Y0..Y1 inclusive)

Public function Const

bool

 

IsRegionEqual

(
    int32 X0,
    int32 Y0,
    int32 X1,
    int32 Y1,
    int32 Target
)

Is the rectangle empty (X0..X1, Y0..Y1 inclusive)

Public function Const

bool

 

IsRowEmpty

(
    int X0,
    int X1,
    int Y
)

Public function Const

bool

 

IsRowEqual

(
    int X0,
    int X1,
    int Y,
    int Target
)

Public function Const

bool

 

IsValid()

Public function

void

 

SetPixel

(
    int X,
    int Y,
    uint8 Value
)

Public function

void

 

ThresholdImage

(
    int32 AlphaThreshold
)

Public function

void

 

ThresholdImageBothWays

(
    int32 LowAlphaThreshold,
    int32 HighAlphaThreshold
)

Flushes values smaller or equal to LowAlphaThreshold to 0, and values greater or equal to HighAlphaThreshold to 255.

Public function Const

void

 

TightenBounds

(
    FIntPoint& InOutOrigin,
    FIntPoint& InOutDimension
)

Returns the tight bounding box around pixels that are not 0.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss