FCanvasItem

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "CanvasItem.h"

Syntax

class FCanvasItem

Variables

Name Description

Public variable

FBatchedElement...

 

BatchedElementParameters

Used for batch rendering.

Public variable

bool

 

bFreezeTime

Public variable

ESimpleElementB...

 

BlendMode

Blend mode.

Protected variable

FLinearColor

 

Color

Color of the item.

Public variable

FVector2D

 

Position

The position to draw the item.

Public variable

uint32

 

StereoDepth

Stereo projection depth in game units. Default value 0 draws at canvas property StereoDepth.

Constructors

Name Description

Public function

FCanvasItem

(
    const FVector2D& InPosition
)

Basic render item.

Destructors

Name Description

Public function Virtual

~FCanvasItem()

Functions

Name Description

Public function

void

 

Draw

(
    FCanvas* InCanvas
)

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas,
    const FVector2D& InPosition
)

Draw this item (this will affect the items position for future draw calls that do no specify a position)

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas,
    float X,
    float Y
)

Draw this item (this will affect the items position for future draw calls that do no specify a position)

Public function Virtual

void

 

SetColor

(
    const FLinearColor& InColor
)

Set the Color of the item.

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