Cogito, ergo sum

UE2:Canvas (UT2004)

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

This class represents the drawing canvas on the screen after the world has been rendered. You cannot create objects of this class. Instead, certain engine events, such as Hud.PostRender() or InteractionMaster.Process_PostRender, pass a Canvas object as a parameter that is passed on to any other drawing functions called from those events.

If you have the choice and it doesn't make your code much more complex, try grouping draw calls with the same material and render style. Switching between different materials or styles can cost some performance, which is why the HudBase class splits up the main rendering into several stages with fixed render styles.

Properties

bCenter

Type: bool

Whether to center the text drawn with DrawText().

bForceAlpha

Type: bool

Force all text and texture drawing to use ForcedAlpha as draw color alpha value.

bNoSmooth

Type: bool

(not used)

bRenderLevel

Type: bool

Whether to render the world. This property is reset every tick. The last chance to turn off level rendering is during the various PreRender() calls of Interactions and GUIComponents. Usually you don't have any reason to turn of world rendering, unless you are going to cover the entire screen and don't want to waste performance rendering something that wouldn't be seen anyway.

Default value: True

ClipX

Type: float

Width of clipping region.

ClipY

Type: float

Height of clipping region.

ColorModulate

Type: Object.Plane

DrawColor is multiplied by this before drawing textures, text or screen actors.

Default value:

Member Value
W 1.0
X 1.0
Y 1.0
Z 1.0

CurX

Type: float

Current X position for drawing.

CurY

Type: float

Current Y position for drawing.

CurYL

Type: float

Largest width of recently drawn text, unless DrawText() is called with the CR parameter being True.

DrawColor

Type: Object.Color

Color for drawing.

Default value:

Member Value
A 255
B 127
G 127
R 127

Font

Type: Font

Font for text drawing.

Default value: DefaultFont

FontScaleX

Type: float

Width scale for text drawing. Note that scaling isn't exact, so you should determine text size with StrLen() or TextSize() after setting scale if you need precise values.

Default value: 1.0

FontScaleY

Type: float

Height scale for text drawing. Note that scaling isn't exact, so you should determine text size with StrLen() or TextSize() after setting scale if you need precise values.

Default value: 1.0

ForcedAlpha

Type: float

Forced alpha value if bForceAlpha is set. This replaces the value of DrawColor.A * ColorModulate.W for texture and text drawing.

MedFont

Type: Font

A default medium-sized font.

MedFontName

Type: string

Modifiers: localized

Name of a default medium-sized font.

Default value: "UT2003Fonts.FontMono800x600"

OrgX

Type: float

Left start of the clipping region and origin for drawing.

OrgY

Type: float

Top start of the clipping region and origin for drawing.

pCanvasUtil

Type: pointer

Modifiers: const

(internal stuff, disregard)

Default value: 0

SizeX

Type: int

Modifiers: const

Width of the entire drawing area.

SizeY

Type: int

Modifiers: const

Height of the entire drawing area.

SmallFont

Type: Font

A default small font.

SmallFontName

Type: string

Modifiers: localized

Name of a default small font.

Default value: "UT2003Fonts.FontMono"

SpaceX

Type: float

Additional horizontal spacing after text characters and drawn textures.

SpaceY

Type: float

Additional vertical spacing below text lines.

Style

Type: byte

Drawing style for text and Textures. 0 means don't draw. Note that other styles do not affect drawing non-Texture materials. You will have to use a FinalBlend in those cases. The values correspond to the Actor.ERenderStyle enum constants.

Default value: 1 (STY_Normal)

TinyFont

Type: Font

A default tiny font.

TinyFontName

Type: string

Modifiers: localized

Name of a default tiny font.

Default value: "UT2003Fonts.FontMono"

Viewport

Type: Viewport

Modifiers: const

Viewport (Player) that owns the canvas. You can access the local PlayerController via Viewport.Actor.

Z

Type: float

(not used)

Default value: 1.0

Functions

Static native functions

WrapText

static native final function WrapText (out string Text, out string Line, float dx, Font F, float FontScaleX)


Other static functions

MakeColor

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


Native functions

Clear

native final function Clear (optional bool ClearRGB, optional bool ClearZ)


DrawActor

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


DrawActorClipped

native final function DrawActorClipped (Actor A, bool WireFrame, float Left, float Top, float Width, float Height, 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)


DrawScreenActor

native final function DrawScreenActor (Actor A, optional float FOV, optional bool WireFrame, optional bool ClearZ)


DrawText

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


DrawTextClipped

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


DrawTextJustified

native final function DrawTextJustified (coerce string String, byte Justification, float x1, float y1, float x2, float y2)


DrawTile

native(466) final function DrawTile (Material Mat, float XL, float YL, float U, float V, float UL, float VL)


DrawTileClipped

native(468) final function DrawTileClipped (Material Mat, float XL, float YL, float U, float V, float UL, float VL)


DrawTileJustified

native final function DrawTileJustified (Material Mat, byte Justification, float XL, float YL)


DrawTilePartialStretched

native final function DrawTilePartialStretched (Material Mat, float XL, float YL)


DrawTileScaled

native final function DrawTileScaled (Material Mat, float XScale, float YScale)


DrawTileStretched

native final function DrawTileStretched (Material Mat, float XL, float YL)


GetCameraLocation

native final function GetCameraLocation (out Object.Vector CameraLocation, out Object.Rotator CameraRotation)


SetScreenLight

native final function SetScreenLight (int index, Object.Vector Position, Object.Color lightcolor, float radius)


SetScreenProjector

native final function SetScreenProjector (int index, Object.Vector Position, Object.Color color, float radius, Texture tex)


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)


WorldToScreen

native final function Object.Vector WorldToScreen (Object.Vector WorldLoc)


WrapStringToArray

native final function WrapStringToArray (string Text, out array<stringOutArray, float dx, optional string EOL)


Events

Reset

event Reset ()


Other instance functions

DrawBox

final simulated function DrawBox (Canvas canvas, float width, float height)


DrawBracket

final simulated function DrawBracket (float width, float height, float bracket_size)


DrawHorizontal

final function DrawHorizontal (float Y, float width)


DrawIcon

final function DrawIcon (Texture Tex, float Scale)


DrawLine

final function DrawLine (int direction, float size)


DrawPattern

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


DrawRect

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


DrawScreenText

simulated function DrawScreenText (string Text, float X, float Y, Object.EDrawPivot Pivot)


DrawVertical

final function DrawVertical (float X, float height)


SetClip

final function SetClip (float X, float Y)


SetDrawColor

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


SetOrigin

final function SetOrigin (float X, float Y)


SetPos

final function SetPos (float X, float Y)