FCanvasBorderItem

Resizable 3x3 border item.

Windows
MacOS
Linux

Inheritance Hierarchy

FCanvasItem

FCanvasBorderItem

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/CanvasItem.h

Include

#include "CanvasItem.h"

Syntax

class FCanvasBorderItem : public FCanvasItem

Remarks

Resizable 3x3 border item.

Variables

Name Description

Public variable

FVector2D

 

BackgroundScale

Scale of the border

Public variable

const FTexture ...

 

BackgroundTexture

Background tiling texture.

Public variable

const FTexture ...

 

BorderBottomTexture

Border bottom tiling texture.

Public variable

const FTexture ...

 

BorderLeftTexture

Border left tiling texture.

Public variable

const FTexture ...

 

BorderRightTexture

Border right tiling texture.

Public variable

FVector2D

 

BorderScale

Scale of the border

Public variable

const FTexture ...

 

BorderTexture

Corners texture.

Public variable

const FTexture ...

 

BorderTopTexture

Border top tiling texture.

Public variable

FVector2D

 

BorderUV0

Border UV Coordinates 0 (Left/Top).

Public variable

FVector2D

 

BorderUV1

Border UV Coordinates 1 (Right/Bottom).

Public variable

FVector2D

 

CornerSize

Frame corner size in percent of frame texture (should be < 0.5f)

Public variable

FVector2D

 

PivotPoint

Pivot point.

Public variable

FRotator

 

Rotation

Rotation.

Public variable

FVector2D

 

Size

Size of the border.

Public variable

float

 

Z

Used to calculate depth.

Constructors

Name Description

Public function

FCanvasBorderItem

(
    const FVector2D& InPosition,
    const FTexture* InBorderTextur...,
    const FTexture* InBackgroundTe...,
    const FTexture* InBorderLeftTe...,
    const FTexture* InBorderRightT...,
    const FTexture* InBorderTopTex...,
    const FTexture* InBorderBottom...,
    const FVector2D& InSize,
    const FLinearColor& InColor
)

3x3 grid border with tiled frame and tiled interior.

Overridden from FCanvasItem

Name Description

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas
)

Draw the item at the given coordinates.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback