NoveltyML reference > Objects > Canvas

<Canvas>
Inherits from <Object>.

Like Groups, Canvas objects are containers. Any children of this object will be rendered to an offscreen texture.

Attribute Description Type
canvas-size [Required] Texture size ("width, height") Vector2
mirror Flip image horizontally Boolean
flip Flip image vertically Boolean

Remarks: canvas-size will determine the size of the generated texture. If not set, the value size will be used instead. 2048x2048 is the max size.
Note: Generating textures larger than the game's current canvas size may result in minor graphical glitches.


Inherited from <Object>

Attribute Description Type
name [Required] Unique name for this object String
position Position ("x,y") Vector2
pivot Pivot point ("x,y") Vector2
rotation Rotation in radians Float
scale Scale multiplier Float
size Size ("width, height") Vector2
visible Visibility Boolean
rgb Color ("red, green, blue") Vector3
opacity Opacity Float
blending Blending mode Integer
auto-size Automatic sizing based on parent's size ("width%, height%") Vector2
auto-position Automatic position based on parent's size ("x%, y%") Vector2
pixelated Disable linear interpolation of texture Boolean

Remarks: auto-position and auto-size overrides position and size respectively.

Child tags Description Count
<Behaviour> Object behaviours 0 or more
<Meta> Meta information
1
<Object> Other objects 0 or more


NoveltyML sample
<Canvas name="My canvas" size="640,480" >
	<Image name="My image" texture="My texture" />
	<Border name="My border" texture="My texture" />
</Canvas>
		


Back to top