UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCanvasTileItem Class Reference

#include <CanvasItem.h>

+ Inheritance diagram for FCanvasTileItem:

Public Member Functions

ENGINE_API FCanvasTileItem (const FVector2D &InPosition, const FTexture *InTexture, const FLinearColor &InColor)
 
ENGINE_API FCanvasTileItem (const FVector2D &InPosition, const FTexture *InTexture, const FVector2D &InSize, const FLinearColor &InColor)
 
ENGINE_API FCanvasTileItem (const FVector2D &InPosition, const FVector2D &InSize, const FLinearColor &InColor)
 
ENGINE_API FCanvasTileItem (const FVector2D &InPosition, const FTexture *InTexture, const FVector2D &InUV0, const FVector2D &InUV1, const FLinearColor &InColor)
 
ENGINE_API FCanvasTileItem (const FVector2D &InPosition, const FTexture *InTexture, const FVector2D &InSize, const FVector2D &InUV0, const FVector2D &InUV1, const FLinearColor &InColor)
 
ENGINE_API FCanvasTileItem (const FVector2D &InPosition, const FMaterialRenderProxy *InMaterialRenderProxy, const FVector2D &InSize)
 
ENGINE_API FCanvasTileItem (const FVector2D &InPosition, const FMaterialRenderProxy *InMaterialRenderProxy, const FVector2D &InSize, const FVector2D &InUV0, const FVector2D &InUV1)
 
virtual ENGINE_API void Draw (FCanvas *InCanvas) override
 
virtual void Draw (FCanvas *InCanvas)=0
 
virtual void Draw (FCanvas *InCanvas, const FVector2D &InPosition)
 
virtual void Draw (FCanvas *InCanvas, float X, float Y)
 
- Public Member Functions inherited from FCanvasItem
 FCanvasItem (const FVector2D &InPosition)
 
virtual ~FCanvasItem ()
 
virtual void SetColor (const FLinearColor &InColor)
 

Public Attributes

FVector2D Size
 
float Z
 
FVector2D UV0
 
FVector2D UV1
 
const FTextureTexture
 
const FMaterialRenderProxyMaterialRenderProxy
 
FRotator Rotation
 
FVector2D PivotPoint
 
- Public Attributes inherited from FCanvasItem
FVector2D Position
 
uint32 StereoDepth
 
ESimpleElementBlendMode BlendMode
 
bool bFreezeTime
 
FBatchedElementParametersBatchedElementParameters
 

Additional Inherited Members

- Protected Attributes inherited from FCanvasItem
FLinearColor Color
 

Constructor & Destructor Documentation

◆ FCanvasTileItem() [1/7]

FCanvasTileItem::FCanvasTileItem ( const FVector2D InPosition,
const FTexture InTexture,
const FLinearColor InColor 
)

Tile item using size from texture.

Parameters
InPositionDraw position
InTextureThe texture

◆ FCanvasTileItem() [2/7]

FCanvasTileItem::FCanvasTileItem ( const FVector2D InPosition,
const FTexture InTexture,
const FVector2D InSize,
const FLinearColor InColor 
)

Tile item with texture using given size.

Parameters
InPositionDraw position
InTextureThe texture
InSizeThe size to render

◆ FCanvasTileItem() [3/7]

FCanvasTileItem::FCanvasTileItem ( const FVector2D InPosition,
const FVector2D InSize,
const FLinearColor InColor 
)

Tile item which uses the default white texture using given size.

Parameters
InPositionDraw position
InSizeThe size to render

◆ FCanvasTileItem() [4/7]

FCanvasTileItem::FCanvasTileItem ( const FVector2D InPosition,
const FTexture InTexture,
const FVector2D InUV0,
const FVector2D InUV1,
const FLinearColor InColor 
)

Tile item with texture using size from texture specific UVs.

Parameters
InPositionDraw position
InTextureThe texture
InUV0UV coordinates (Normalized Top/Left)
InUV1UV coordinates (Normalized Bottom/Right)

◆ FCanvasTileItem() [5/7]

FCanvasTileItem::FCanvasTileItem ( const FVector2D InPosition,
const FTexture InTexture,
const FVector2D InSize,
const FVector2D InUV0,
const FVector2D InUV1,
const FLinearColor InColor 
)

Tile item with texture using given size and specific UVs.

Parameters
InPositionDraw position
InTextureThe texture
InSizeThe size to render
InUV0UV coordinates (Normalized Top/Left)
InUV1UV coordinates (Normalized Bottom/Right)

◆ FCanvasTileItem() [6/7]

FCanvasTileItem::FCanvasTileItem ( const FVector2D InPosition,
const FMaterialRenderProxy InMaterialRenderProxy,
const FVector2D InSize 
)

Tile item with FMaterialRenderProxy using given size.

Parameters
InPositionDraw position
InMaterialRenderProxyMaterial proxy for rendering
InSizeThe size to render

◆ FCanvasTileItem() [7/7]

FCanvasTileItem::FCanvasTileItem ( const FVector2D InPosition,
const FMaterialRenderProxy InMaterialRenderProxy,
const FVector2D InSize,
const FVector2D InUV0,
const FVector2D InUV1 
)

Tile item with FMaterialRenderProxy using given size and UVs.

Parameters
InPositionDraw position
InMaterialRenderProxyMaterial proxy for rendering
InSizeThe size to render
InUV0UV coordinates (Normalized Top/Left)
InUV1UV coordinates (Normalized Bottom/Right)

Member Function Documentation

◆ Draw() [1/4]

void FCanvasTileItem::Draw ( FCanvas InCanvas)
overridevirtual

Draw the item at the given coordinates.

Parameters
InPositionDraw position.

Implements FCanvasItem.

◆ Draw() [2/4]

virtual void FCanvasItem::Draw ( FCanvas InCanvas)
virtual

Implements FCanvasItem.

◆ Draw() [3/4]

virtual void FCanvasItem::Draw ( FCanvas InCanvas,
const FVector2D InPosition 
)
inlinevirtual

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

Parameters
InCanvasCanvas on which to draw
InPositionDraw position - this will not preserve the items position

Reimplemented from FCanvasItem.

◆ Draw() [4/4]

virtual void FCanvasItem::Draw ( FCanvas InCanvas,
float  X,
float  Y 
)
inlinevirtual

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

Parameters
InCanvasCanvas on which to draw
XX Draw position
YY Draw position

Reimplemented from FCanvasItem.

Member Data Documentation

◆ MaterialRenderProxy

const FMaterialRenderProxy* FCanvasTileItem::MaterialRenderProxy

◆ PivotPoint

FVector2D FCanvasTileItem::PivotPoint

◆ Rotation

FRotator FCanvasTileItem::Rotation

◆ Size

FVector2D FCanvasTileItem::Size

◆ Texture

const FTexture* FCanvasTileItem::Texture

◆ UV0

FVector2D FCanvasTileItem::UV0

◆ UV1

FVector2D FCanvasTileItem::UV1

◆ Z

float FCanvasTileItem::Z

The documentation for this class was generated from the following files: