LGUI2:LS1:lgui2canvas

From Lavish Software Wiki
Jump to navigation Jump to search
Object Type Vitals
lgui2canvas
Defined By LavishGUI 2
Inherits lgui2element
Reduces To lgui2canvas
Variable Object Type none
Uses Sub-Types no
C/C++ Type void *

A lgui2canvas object provides access to a canvas element, and inherits from lgui2element.


Members

  • lgui2brush Brush[name]: Retrieves one of the Canvas's Brushes, by name
  • lgui2fontstyle Font[name]: Retrieves one of the Canvas's Fonts, by name


Methods

  • SetFont[name,json]: Sets the Canvas's font for the given name to a specified Font definition
  • SetBrush[name,json]: Sets the Canvas's brush for the given name to a specified Brush definition
  • Reset: Removes the "initialize" array and resets the Brush and Font stacks, but does not automatically clear the canvas or remove Brush and Font definitions.
  • ClearCanvas: Clears the Canvas, setting all pixels to transparent #00000000
  • ClearCanvas[#aarrggbb]: Clears the Canvas to the specified color
  • InitializeCanvas: Initializes the Canvas by Batching its "initialize" array, if it has not been auto-initialized since last allocated. (This call should not usually be needed)
  • InitializeCanvas[TRUE]: Initializes the Canvas by Batching its "initialize" array, even if it has already been auto-initialized. This may be useful after a ClearCanvas
  • PushFont[name]: Pushes one of the Canvas's defined Fonts onto the stack by name
  • PopFont: Pops a Font off the stack
  • PopFont[name]: Pops a Font off the stack, if and only if it is the specified font
  • PushBrush[name]: Pushes one of the Canvas's defined Brushes onto the stack by name
  • PopBrush: Pops a Brush off the stack
  • PopBrush[name]: Pops a Brush off the stack, if and only if it is the specified brush
  • DrawRect[json]: Performs one "drawRect" Canvas Operation
  • DrawCircle[json]: Performs one "drawCircle" Canvas Operation
  • DrawArc[json]: Performs one "drawArc" Canvas Operation
  • DrawText[json]: Performs one "drawText" Canvas Operation
  • DrawPrimitives[json]: Performs one "drawPrimitives" Canvas Operation (rendering any number of vertices)
  • Batch[jsonarray]: Performs an array of Canvas Operations


Examples

LavishGUI 2 Element Types

LavishGUI 2 LavishScript Object Types

Core API (see Using LavishGUI 2 from LavishScript)
lgui2 - lgui2animateargs - lgui2animationtype - lgui2elementref - lgui2eventargs - lgui2eventhandler - lgui2elementtype - lgui2itemviewgeneratorargs - lgui2inputbinding - lgui2layer - lgui2skin - lgui2trigger
Enums
elgui2animationframestate - elgui2dpad - elgui2edge - elgui2fontflags - elgui2horizontalalignment - elgui2imageorientation - elgui2progresstext - elgui2scrollbar - elgui2sizetocontent - elgui2verticalignment - elgui2visibility
Element Components
lgui2animation - lgui2brush - lgui2fontstyle - lgui2margins - lgui2item - lgui2radialitem - lgui2radialgaugeneedle
Element Base Types
lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
Elements