| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| dragengine:modules:dragonscript:xmlguitheme:canvascreator [2018/02/28 16:07] – [Canvas Creators] dragonlord | dragengine:modules:dragonscript:xmlguitheme:canvascreator [2018/02/28 16:08] – [Default] dragonlord |
|---|
| Canvas creators are always based directly or indirectly on a type. This type is the //Canvas Creator Prototype// and defines what instance of //CanvasCreator// is used in the scripts. The choice of prototype affects the appearance of the canvas creator and the configuration possibilities. | Canvas creators are always based directly or indirectly on a type. This type is the //Canvas Creator Prototype// and defines what instance of //CanvasCreator// is used in the scripts. The choice of prototype affects the appearance of the canvas creator and the configuration possibilities. |
| |
| The following prototypes are provided by default by the [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/interfaceDragengine_1_1Gui_1_1CanvasCreators_1_1CanvasCreators.html|CanvasCreators]] script class: | The following prototypes are provided by default by the [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1CanvasCreators_1_1CanvasCreators.html|CanvasCreators]] script class: |
| ^ Name ^ Script Class ^ Description ^ | ^ Name ^ Script Class ^ Description ^ |
| | [[#default|Default]] | [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1CanvasCreators_1_1DefaultCanvasCreator.html|DefaultCanvasCreator]] | Empty canvas creator | | | [[#default|Default]] | [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1CanvasCreators_1_1DefaultCanvasCreator.html|DefaultCanvasCreator]] | Empty canvas creator | |
| | [[#imageborder|ImageBorder]] | [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1CanvasCreators_1_1ImageBorderCanvasCreator.html|ImageBorderCanvasCreator]] | Up to 9 images creating size adapting border | | | [[#imageborder|ImageBorder]] | [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1CanvasCreators_1_1ImageBorderCanvasCreator.html|ImageBorderCanvasCreator]] | Up to 9 images creating size adapting border | |
| |
| You can use custom prototypes by adding them to [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/interfaceDragengine_1_1Gui_1_1CanvasCreators_1_1CanvasCreators.html|CanvasCreators]] instance before loading gui themes. This is useful if you created custom canvas creator subclasses requiring custom parameters. | You can use custom prototypes by adding them to [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1CanvasCreators_1_1CanvasCreators.html|CanvasCreators]] instance before loading gui themes. This is useful if you created custom canvas creator subclasses requiring custom parameters. |
| |
| This example defines a canvas creator based on the //Image// prototype displaying //canvasImage.png// stretched across entire canvas size. | This example defines a canvas creator based on the //Image// prototype displaying //canvasImage.png// stretched across entire canvas size. |
| |
| ===== Default ===== | ===== Default ===== |
| The most basic canvas creator creating no canvas creator at all (empty canvas creator). Creates an instance of the [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/interfaceDragengine_1_1Gui_1_1CanvasCreators_1_1DefaultCanvasCreator.html|DefaultCanvasCreator]] script class. This is useful to set an empty canvas creator. As such it has no parameters at all. | The most basic canvas creator creating no canvas creator at all (empty canvas creator). Creates an instance of the [[https://dragengine.rptd.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1CanvasCreators_1_1DefaultCanvasCreator.html|DefaultCanvasCreator]] script class. This is useful to set an empty canvas creator. As such it has no parameters at all. |
| |
| |
