Mostly Harmless

UE3:Canvas (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UDK Object >> Canvas

Contents
Package: 
Engine
This class in other games:
RTNP, U1, U2, U2XMP, UE2Runtime, UT, UT2003, UT2004, UT3
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

Canvas: A drawing canvas.

[edit] Properties

[edit] bCenter

Type: bool

Whether to center the text.

[edit] bNoSmooth

Type: bool

Don't bilinear filter.

[edit] Canvas

Type: pointer{FCanvas}

Modifiers: native, const


[edit] ClipX

Type: float


[edit] ClipY

Type: float

Bottom right clipping region.

[edit] ColorModulate

Type: Object.Plane


Default value:

Member Value
W 1.0
X 1.0
Y 1.0
Z 1.0

[edit] CurX

Type: float


[edit] CurY

Type: float

Current position for drawing.

[edit] CurYL

Type: float

Largest Y size since DrawText.

[edit] DefaultTexture

Type: Texture2D


Default value: Texture2D'EngineResources.WhiteSquareTexture'

[edit] DrawColor

Type: Object.Color

Color for drawing.

Default value:

Member Value
A 255
B 127
G 127
R 127

[edit] Font

Type: Font

Font for DrawText.

Default value: Font'EngineFonts.SmallFont'

[edit] OrgX

Type: float


[edit] OrgY

Type: float

Origin for drawing.

[edit] SceneView

Type: pointer{FSceneView}

Modifiers: native, const


[edit] SizeX

Type: int

Modifiers: const


[edit] SizeY

Type: int

Modifiers: const


[edit] Structs

[edit] CanvasIcon

Modifiers: native

Holds texture information with UV coordinates as well.

Texture Texture 
Source texture
float U 
UV coords
float V 
UV coords
float UL 
UV coords
float VL 
UV coords

[edit] DepthFieldGlowInfo

Modifiers: native

info for glow when using depth field rendering

bool bEnableGlow 
whether to turn on the outline glow (depth field fonts only)
Object.LinearColor GlowColor 
base color to use for the glow
Object.Vector2D GlowOuterRadius 
if bEnableGlow, outline glow outer radius (0 to 1, 0.5 is edge of character silhouette)

glow influence will be 0 at GlowOuterRadius.X and 1 at GlowOuterRadius.Y

Object.Vector2D GlowInnerRadius 
if bEnableGlow, outline glow inner radius (0 to 1, 0.5 is edge of character silhouette)

glow influence will be 1 at GlowInnerRadius.X and 0 at GlowInnerRadius.Y

[edit] FontRenderInfo

Modifiers: native

information used in font rendering

bool bClipText 
whether to clip text
bool bEnableShadow 
whether to turn on shadowing
DepthFieldGlowInfo GlowInfo 
depth field glow parameters (only usable if font was imported with a depth field)

[edit] Functions

[edit] Static functions

[edit] CreateFontRenderInfo

static final function FontRenderInfo CreateFontRenderInfo (optional bool bClipText, optional bool bEnableShadow, optional Object.LinearColor GlowColor, optional Object.Vector2D GlowOuterRadius, optional Object.Vector2D GlowInnerRadius)

constructor for FontRenderInfo

[edit] Native functions

[edit] DeProject

native noexport final function DeProject (Object.Vector2D ScreenPos, out Object.Vector WorldOrigin, out Object.Vector WorldDirection)

transforms 2D screen coordinates into a 3D world-space origin and direction

Parameters:

  • ScreenPos - screen coordinates in pixels
  • WorldOrigin - out) - world-space origin vector
  • WorldDirection - out) - world-space direction vector

[edit] Draw2DLine

native noexport final function Draw2DLine (float X1, float Y1, float X2, float Y2, Object.Color LineColor)


[edit] DrawColorizedTile

native noexport final function DrawColorizedTile (Texture Tex, float XL, float YL, float U, float V, float UL, float VL, Object.LinearColor LColor)


[edit] DrawMaterialTile

native noexport final function DrawMaterialTile (MaterialInterface Mat, float XL, float YL, optional float U, optional float V, optional float UL, optional float VL)

Draws the emissive channel of a material to an axis-aligned quad at CurX,CurY.

Parameters:

  • Mat - The material which contains the emissive expression to render.
  • XL - The width of the quad in pixels.
  • YL - The height of the quad in pixels.
  • U - The U coordinate of the quad's upper left corner, in normalized coordinates.
  • V - The V coordinate of the quad's upper left corner, in normalized coordinates.
  • UL - The range of U coordinates which is mapped to the quad.
  • VL - The range of V coordinates which is mapped to the quad.

[edit] DrawMaterialTileClipped

native noexport final function DrawMaterialTileClipped (MaterialInterface Mat, float XL, float YL, optional float U, optional float V, optional float UL, optional float VL)


[edit] DrawRotatedMaterialTile

native final function DrawRotatedMaterialTile (MaterialInterface Mat, Object.Rotator Rotation, float XL, float YL, optional float U, optional float V, optional float UL, optional float VL, optional float AnchorX, optional float AnchorY)


[edit] DrawRotatedTile

native final function DrawRotatedTile (Texture Tex, Object.Rotator Rotation, float XL, float YL, float U, float V, float UL, float VL, optional float AnchorX, optional float AnchorY)


[edit] DrawText

native noexport final function DrawText (coerce string Text, optional bool CR, optional float XScale, optional float YScale, optional const out FontRenderInfo RenderInfo)


[edit] DrawTextureDoubleLine

native final function DrawTextureDoubleLine (Object.Vector StartPoint, Object.Vector EndPoint, float Perc, float Spacing, float Width, Object.Color LineColor, Object.Color AltLineColor, Texture Tex, float U, float V, float UL, float VL)


[edit] DrawTextureLine

native final function DrawTextureLine (Object.Vector StartPoint, Object.Vector EndPoint, float Perc, float Width, Object.Color LineColor, Texture LineTexture, float U, float V, float UL, float VL)


[edit] DrawTile

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


[edit] DrawTileClipped

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


[edit] DrawTileStretched

native noexport final function DrawTileStretched (Texture Tex, float XL, float YL, float U, float V, float UL, float VL, Object.LinearColor LColor, optional bool bStretchHorizontally, optional bool bStretchVertically, optional float ScalingFactor)


[edit] PopTransform

native noexport final function PopTransform ()

Pops the topmost matrix from the canvas transform stack.

[edit] Project

native noexport final function Object.Vector Project (Object.Vector location)

Convert a 3D vector to a 2D screen coords.

[edit] PushTranslationMatrix

native noexport final function PushTranslationMatrix (Object.Vector TranslationVector)

Pushes a translation matrix onto the canvas.

Parameters:

  • TranslationVector - Translation vector to use to create the translation matrix.

[edit] SetDrawColor

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


[edit] SetPos

native final function SetPos (float PosX, float PosY)


[edit] StrLen

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


[edit] TextSize

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


[edit] Events

[edit] Reset

event Reset (optional bool bKeepOrigin)


[edit] Other instance functions

[edit] DrawBox

final simulated function DrawBox (float width, float height)


[edit] DrawIcon

final function DrawIcon (CanvasIcon Icon, float X, float Y, optional float Scale)

Draw a CanvasIcon at the desired canvas position.

[edit] DrawIconSection

final function DrawIconSection (CanvasIcon Icon, float X, float Y, float UStartPct, float VStartPct, float UEndPct, float VEndPct, optional float Scale)

Draw a subsection of a CanvasIcon at the desired canvas position.

[edit] DrawRect

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


[edit] DrawTextCentered

final function DrawTextCentered (coerce string Text, optional bool CR, optional float XScale, optional float YScale, optional const FontRenderInfo RenderInfo)


[edit] DrawTextRA

final function DrawTextRA (coerce string Text, optional bool CR)

Draws text right aligned from the current position.

[edit] DrawTexture

final function DrawTexture (Texture Tex, float Scale)


[edit] MakeIcon

final function CanvasIcon MakeIcon (Texture Texture, optional float U, optional float V, optional float UL, optional float VL)

Fake CanvasIcon constructor.

[edit] SetClip

final function SetClip (float X, float Y)


[edit] SetOrigin

final function SetOrigin (float X, float Y)


Retrieved from "http://wiki.beyondunreal.com/UE3:Canvas_(UDK)"