Cogito, ergo sum

UE2:Canvas (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
U2XMP Object >> Canvas
Package: 
Engine
This class in other games:
RTNP, U1, UT, UE2Runtime, U2, UT2003, UT2004, UDK, UT3

Canvas: A drawing canvas. This is a built-in Unreal class and it shouldn't be modified.

Notes. To determine size of a drawable object, set Style to STY_None, remember CurX, draw the thing, then inspect CurX and CurYL.

Properties

bCenter

Type: bool

Whether to center the text.

bNoSmooth

Type: bool

Don't bilinear filter.

ClipX

Type: float


ClipY

Type: float

Bottom right clipping region.

CurX

Type: float


CurY

Type: float

Current position for drawing.

CurYL

Type: float

Largest Y size since DrawText.

DebugFont

Type: Font


Default value: Font'Engine.DebugFont'

DrawColor

Type: Object.Color

Color for drawing.

Default value:

Member Value
A 255
B 127
G 127
R 127

Font

Type: Font

Font for DrawText.

MedFont

Type: Font

Medium system font.

Default value: Font'Engine.MediumFont'

OrgX

Type: float


OrgY

Type: float

Origin for drawing.

SizeX

Type: int

Modifiers: const


SizeY

Type: int

Modifiers: const


SmallFont

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

SpaceX

Type: float


SpaceY

Type: float

Spacing for after Draw*.

Style

Type: byte

Drawing style STY_None means don't draw.

Default value: 1

Viewport

Type: Viewport

Modifiers: const


Z

Type: float

Z location. 1=no screenflash, 2=yes screenflash.

Default value: 1.0

Functions

Static functions

MakeColor

static final function Object.Color MakeColor (byte R, byte G, byte B, optional byte A)


Native functions

DeProject

native final function Object.Vector DeProject (Object.Vector V)


DrawActor

native(467) final function DrawActor (Actor A, bool WireFrame, optional bool ClearZ, optional float DisplayFOV)


DrawPortal

native(480) final function DrawPortal (int X, int Y, int Width, int Height, Actor CamActor, Object.Vector CamLocation, Object.Rotator CamRotation, optional int FOV, optional bool ClearZ)


DrawRectangle

native final function DrawRectangle (int X, int Y, int Width, int Height, optional Object.Color C)


DrawText

native(465) final function DrawText (coerce string Text, optional bool CR)


DrawTextClipped

native(469) final function DrawTextClipped (coerce string Text, optional bool bCheckHotKey)


DrawTile

native(466) final function DrawTile (Texture Tex, float XL, float YL, float U, float V, float UL, float VL)


DrawTileClipped

native(468) final function DrawTileClipped (Texture Tex, float XL, float YL, float U, float V, float UL, float VL)


GetDrawBounds

native final function GetDrawBounds (out int X, out int Y, out int Width, out int Height)


Project

native final function Object.Vector Project (Object.Vector V)


SetDrawBounds

native final function SetDrawBounds (int X, int Y, int Width, int Height)


StrLen

native(464) final function StrLen (coerce string String, out float XL, out float YL)


TextSize

native(470) final function TextSize (coerce string String, out float XL, out float YL)


Events

Reset

event Reset ()


Other instance functions

DrawIcon

final function DrawIcon (Texture Tex, float Scale)


DrawPattern

final function DrawPattern (Texture Tex, float XL, float YL, float Scale)


DrawRect

final function DrawRect (Texture Tex, float RectX, float RectY)


SetClip

final function SetClip (float X, float Y)


SetDrawColor

final function SetDrawColor (byte R, byte G, byte B, optional byte A)


SetFont

function SetFont (Font NewFont, optional bool bForce)


SetOrigin

final function SetOrigin (float X, float Y)


SetPos

final function SetPos (float X, float Y)