Canvas¶

Class in Engine · Engine.Canvas · native, transient

Object › Canvas

Using it from Lua

h7.find_all("Canvas")            -- live instances
h7.find_class("Engine.Canvas")   -- the class
h7.hook("Engine.Canvas.CreateFontRenderInfo", fn)

Enums¶

ECanvasBlendMode

BLEND_CANVAS_Opaque = 0, BLEND_CANVAS_Masked = 1, BLEND_CANVAS_Translucent = 2, BLEND_CANVAS_Additive = 3, BLEND_CANVAS_Modulate = 4, BLEND_CANVAS_ModulateAndAdd = 5, BLEND_CANVAS_SoftMasked = 6, BLEND_CANVAS_AlphaComposite = 7, BLEND_CANVAS_DitheredTranslucent = 8, BLEND_CANVAS_AlphaOnly = 9

Structs¶

CanvasIcon

Field	Type
`Texture`	`Texture`
`U`	`float`
`V`	`float`
`UL`	`float`
`VL`	`float`

CanvasUVTri

Field	Type
`V0_Pos`	`vector2d`
`V0_UV`	`vector2d`
`V1_Pos`	`vector2d`
`V1_UV`	`vector2d`
`V2_Pos`	`vector2d`
`V2_UV`	`vector2d`

DepthFieldGlowInfo

Field	Type
`bEnableGlow`	`bool`
`GlowColor`	`LinearColor`
`GlowOuterRadius`	`vector2d`
`GlowInnerRadius`	`vector2d`

FontRenderInfo

Field	Type
`bClipText`	`bool`
`bEnableShadow`	`bool`
`GlowInfo`	`DepthFieldGlowInfo`

MobileDistanceFieldParams

Field	Type
`Gamma`	`float`
`AlphaRefVal`	`float`
`SmoothWidth`	`float`
`EnableShadow`	`BOOL`
`ShadowDirection`	`vector2d`
`ShadowColor`	`LinearColor`
`ShadowSmoothWidth`	`float`
`GlowInfo`	`DepthFieldGlowInfo`
`BlendMode`	`INT`

TextSizingParameters

Field	Type
`DrawX`	`float`
`DrawY`	`float`
`DrawXL`	`float`
`DrawYL`	`float`
`Scaling`	`Vector2D`
`DrawFont`	`Font`
`SpacingAdjust`	`Vector2D`
`ViewportHeight`	`float`

WrappedStringElement

Field	Type
`Value`	`string`
`LineExtent`	`Vector2D`

Properties¶

Name	Type	Notes
`bCenter`	`bool`
`bNoSmooth`	`bool`
`Canvas`	`pointer`	const, native
`ClipX`	`float`
`ClipY`	`float`
`ColorModulate`	`Plane`
`CurX`	`float`	const
`CurY`	`float`	const
`CurYL`	`float`
`CurZ`	`float`	const
`DefaultTexture`	`Texture2D`
`DepthSortKey`	`int`
`DrawColor`	`color`
`Font`	`font`
`OrgX`	`float`
`OrgY`	`float`
`SceneView`	`pointer`	const, native
`SizeX`	`int`	const
`SizeY`	`int`	const

Functions¶

Name	Declaration
`CreateFontRenderInfo`	`static final function FontRenderInfo CreateFontRenderInfo(optional bool bClipText, optional bool bEnableShadow, optional LinearColor GlowColor, optional vector2D GlowOuterRadius, optional vector2D GlowInnerRadius)`
`DeProject`	`final native function DeProject(vector2D ScreenPos, out vector WorldOrigin, out vector WorldDirection)`
`DisableFullBatchOptimization`	`final native function DisableFullBatchOptimization()`
`Draw2DLine`	`final native function Draw2DLine(float X1, float Y1, float X2, float Y2, color LineColor)`
`DrawBlendedTile`	`final native function DrawBlendedTile(Texture Tex, float XL, float YL, float U, float V, float UL, float VL, ECanvasBlendMode Blend)`
`DrawBox`	`final simulated function DrawBox(float width, float height)`
`DrawDebugGraph`	`function DrawDebugGraph(coerce string Title, float ValueX, float ValueY, float UL_X, float UL_Y, float W, float H, vector2d RangeX, vector2d RangeY)`
`DrawIcon`	`final native function DrawIcon(CanvasIcon Icon, float X, float Y, optional float Scale)`
`DrawMaterialTile`	`final native function DrawMaterialTile(MaterialInterface Mat, float XL, float YL, optional float U, optional float V, optional float UL, optional float VL, optional bool bClipTile)`
`DrawRect`	`final function DrawRect(float RectX, float RectY, optional Texture Tex = DefaultTexture)`
`DrawRotatedMaterialTile`	`final native function DrawRotatedMaterialTile(MaterialInterface Mat, rotator Rotation, float XL, float YL, optional float U = 0.f, optional float V = 0.f, optional float UL = 0.f, optional float VL = 0.f, optional float AnchorX = 0.5f, optional float AnchorY = 0.5f)`
`DrawRotatedTile`	`final native function DrawRotatedTile(Texture Tex, rotator Rotation, float XL, float YL, float U, float V, float UL, float VL, optional float AnchorX = 0.5f, optional float AnchorY = 0.5f)`
`DrawScaledIcon`	`final function DrawScaledIcon(CanvasIcon Icon, float X, float Y, Vector Scale)`
`DrawText`	`final native function DrawText(coerce string Text, optional bool CR = true, optional float XScale = 1.0, optional float YScale = 1.0, optional const out FontRenderInfo RenderInfo)`
`DrawTexture`	`final function DrawTexture(Texture Tex, float Scale)`
`DrawTextureDoubleLine`	`final native function DrawTextureDoubleLine(vector StartPoint, vector EndPoint, float Perc, float Spacing, float Width, color LineColor, color AltLineColor, Texture Tex, float U, float V, float UL, float VL)`
`DrawTextureLine`	`final native function DrawTextureLine(vector StartPoint, vector EndPoint, float Perc, float Width, color LineColor, Texture LineTexture, float U, float V, float UL, float VL)`
`DrawTile`	`final native function DrawTile(Texture Tex, float XL, float YL, float U, float V, float UL, float VL, optional LinearColor LColor, optional bool ClipTile, optional EBlendMode Blend)`
`DrawTileStretched`	`final native function DrawTileStretched(Texture Tex, float XL, float YL, float U, float V, float UL, float VL, optional LinearColor LColor, optional bool bStretchHorizontally, optional bool bStretchVertically, optional float ScalingFactor)`
`DrawTimer`	`final native function DrawTimer(Texture Tex, float StartTime, float TotalTime, float XL, float YL, float U, float V, float UL, float VL, optional LinearColor LColor, optional EBlendMode Blend)`
`DrawTris`	`final native function DrawTris(Texture Tex, array<CanvasUVTri> Triangles, Color InColor)`
`EnableFullBatchOptimization`	`final native function EnableFullBatchOptimization()`
`Flush`	`final native function Flush()`
`GetDefaultCanvasFont`	`event Font GetDefaultCanvasFont()`
`MakeIcon`	`final function CanvasIcon MakeIcon(Texture Texture, optional float U, optional float V, optional float UL, optional float VL)`
`PopDepthSortKey`	`final native function PopDepthSortKey()`
`PopMaskRegion`	`final native function PopMaskRegion()`
`PopTransform`	`final native function PopTransform()`
`PreOptimizeDrawTiles`	`final native function PreOptimizeDrawTiles(INT Num, Texture Tex, optional EBlendMode Blend)`
`Project`	`final native function vector Project(vector location)`
`PushDepthSortKey`	`final native function PushDepthSortKey(int Key)`
`PushMaskRegion`	`final native function PushMaskRegion(float X, float Y, float XL, float YL)`
`PushTranslationMatrix`	`final native function PushTranslationMatrix(vector TranslationVector)`
`Reset`	`native function Reset(optional bool bKeepOrigin)`
`SetClip`	`final native function SetClip(float X, float Y)`
`SetDrawColor`	`final native function SetDrawColor(byte R, byte G, byte B, optional byte A = 255)`
`SetDrawColorStruct`	`final function SetDrawColorStruct(color C)`
`SetOrigin`	`final native function SetOrigin(float X, float Y)`
`SetPos`	`final native function SetPos(float PosX, float PosY, float PosZ = 0.0)`
`StrLen`	`final native function StrLen(coerce string String, out float XL, out float YL)`
`TextSize`	`final native function TextSize(coerce string String, out float XL, out float YL, optional float XScale = 1.0, optional float YScale = 1.0)`
`TopDepthSortKey`	`final native function int TopDepthSortKey()`

Default values¶

DrawColor=(R=127,G=127,B=127,A=255)
ColorModulate=(X=1,Y=1,Z=1,W=1)
DefaultTexture="EngineResources.WhiteSquareTexture"

Inherited¶

From	Members
Object	13 properties, 308 functions