Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UCanvas::K2_DrawBorder

Draws a 3x3 grid border with tiled frame and tiled interior on the Canvas.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/Canvas.h
Include	#include "Engine/Canvas.h"
Source	/Engine/Source/Runtime/Engine/Private/UserInterface/Canvas.cpp

Syntax

void K2_DrawBorder
(
    UTexture * BorderTexture,
    UTexture * BackgroundTexture,
    UTexture * LeftBorderTexture,
    UTexture * RightBorderTexture,
    UTexture * TopBorderTexture,
    UTexture * BottomBorderTexture,
    FVector2D ScreenPosition,
    FVector2D ScreenSize,
    FVector2D CoordinatePosition,
    FVector2D CoordinateSize,
    FLinearColor RenderColor,
    FVector2D BorderScale,
    FVector2D BackgroundScale,
    float Rotation,
    FVector2D PivotPoint,
    FVector2D CornerSize
)

Remarks

Draws a 3x3 grid border with tiled frame and tiled interior on the Canvas.

Parameters

Parameter	Description
BorderTexture	Texture to use for border.
BackgroundTexture	Texture to use for border background.
LeftBorderTexture	Texture to use for the tiling left border.
RightBorderTexture	Texture to use for the tiling right border.
TopBorderTexture	Texture to use for the tiling top border.
BottomBorderTexture	Texture to use for the tiling bottom border.
ScreenPosition	Screen space position to render the texture.
ScreenSize	Screen space size to render the texture.
CoordinatePosition	Normalized UV starting coordinate to use when rendering the border texture.
CoordinateSize	Normalized UV size coordinate to use when rendering the border texture.
RenderColor	Color to tint the border.
BorderScale	Scale of the border.
BackgroundScale	Scale of the background.
Rotation	Rotation, in degrees, to render the texture.
PivotPoint	Normalized pivot point to use when rotating the texture.
CornerSize	Frame corner size in percent of frame texture (should be < 0.5f).

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

Take our survey

Dismiss