|
@@ -8,142 +8,178 @@
|
|
|
|
|
|
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
|
|
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper"></a><a name="Topic140"></a><div class="CTopic TClass LCSharp first">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper"></a><a name="Topic116"></a><div class="CTopic TClass LCSharp first">
|
|
<div class="CTitle"><span class="Qualifier">Apos.​Gui.</span>​GuiHelper</div>
|
|
<div class="CTitle"><span class="Qualifier">Apos.​Gui.</span>​GuiHelper</div>
|
|
- <div class="NDClassPrototype" id="NDClassPrototype140"><div class="CPEntry TClass Current"><div class="CPModifiers"><span class="SHKeyword">public static</span></div><div class="CPName"><span class="Qualifier">Apos.​Gui.</span>​GuiHelper</div></div></div>
|
|
|
|
- <div class="CBody"><p>Goal: Unorganized helper functions for AposGui.</p></div>
|
|
|
|
|
|
+ <div class="NDClassPrototype" id="NDClassPrototype116"><div class="CPEntry TClass Current"><div class="CPModifiers"><span class="SHKeyword">public static</span></div><div class="CPName"><span class="Qualifier">Apos.​Gui.</span>​GuiHelper</div></div></div>
|
|
|
|
+ <div class="CBody"><p>Unorganized helper functions for Apos.Gui.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<a name="Apos.Gui.GuiHelper.Public_Variables"></a><a name="Topic109"></a><div class="CTopic TGroup LCSharp">
|
|
<a name="Apos.Gui.GuiHelper.Public_Variables"></a><a name="Topic109"></a><div class="CTopic TGroup LCSharp">
|
|
<div class="CTitle">Public Variables</div>
|
|
<div class="CTitle">Public Variables</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.Scale"></a><a name="Topic142"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.Scale"></a><a name="Topic117"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">Scale</div>
|
|
<div class="CTitle">Scale</div>
|
|
- <div id="NDPrototype142" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">float</span> Scale { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
|
|
+ <div id="NDPrototype117" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">float</span> Scale { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
+ <div class="CBody"><p>The scale of the UI. Defaults to 1f.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.Font"></a><a name="Topic143"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.Font"></a><a name="Topic118"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">Font</div>
|
|
<div class="CTitle">Font</div>
|
|
- <div id="NDPrototype143" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> DynamicSpriteFont Font { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
|
|
+ <div id="NDPrototype118" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> DynamicSpriteFont Font { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
+ <div class="CBody"><p>The font used by components that display text.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.FontSize"></a><a name="Topic144"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.FontSize"></a><a name="Topic119"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">FontSize</div>
|
|
<div class="CTitle">FontSize</div>
|
|
- <div id="NDPrototype144" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">float</span> FontSize { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
|
|
+ <div id="NDPrototype119" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">float</span> FontSize { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
+ <div class="CBody"><p>Size for the font. Defaults to 30.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.Window"></a><a name="Topic145"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.Window"></a><a name="Topic120"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">Window</div>
|
|
<div class="CTitle">Window</div>
|
|
- <div id="NDPrototype145" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> GameWindow Window { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
|
|
+ <div id="NDPrototype120" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> GameWindow Window { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
+ <div class="CBody"><p>Your game's window. Used by responsive components.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.WindowWidth"></a><a name="Topic146"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.WindowWidth"></a><a name="Topic121"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">WindowWidth</div>
|
|
<div class="CTitle">WindowWidth</div>
|
|
- <div id="NDPrototype146" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> WindowWidth { <span class="SHKeyword">get</span> }</div>
|
|
|
|
|
|
+ <div id="NDPrototype121" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> WindowWidth { <span class="SHKeyword">get</span> }</div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Returns</div><p>The window's width in UI scale.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.WindowHeight"></a><a name="Topic147"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.WindowHeight"></a><a name="Topic122"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">WindowHeight</div>
|
|
<div class="CTitle">WindowHeight</div>
|
|
- <div id="NDPrototype147" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> WindowHeight { <span class="SHKeyword">get</span> }</div>
|
|
|
|
|
|
+ <div id="NDPrototype122" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> WindowHeight { <span class="SHKeyword">get</span> }</div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Returns</div><p>The window's height in UI scale.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.GuiSampler"></a><a name="Topic149"></a><div class="CTopic TVariable LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.GuiSampler"></a><a name="Topic123"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">GuiSampler</div>
|
|
<div class="CTitle">GuiSampler</div>
|
|
- <div id="NDPrototype149" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> SamplerState GuiSampler</div>
|
|
|
|
|
|
+ <div id="NDPrototype123" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> SamplerState GuiSampler { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
+ <div class="CBody"><p>Defaults to LinearClamp.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.NextLoopActions"></a><a name="Topic150"></a><div class="CTopic TVariable LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.NextLoopActions"></a><a name="Topic124"></a><div class="CTopic TProperty LCSharp">
|
|
<div class="CTitle">NextLoopActions</div>
|
|
<div class="CTitle">NextLoopActions</div>
|
|
- <div id="NDPrototype150" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> List<Action> NextLoopActions</div>
|
|
|
|
|
|
+ <div id="NDPrototype124" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> List<Action> NextLoopActions { <span class="SHKeyword">get</span>; <span class="SHKeyword">set</span> }</div>
|
|
|
|
+ <div class="CBody"><p>This is a list of actions that will be executed at the start of a game loop. This is useful for queueing actions that will be done in the next loop cycle. This is required when doing something that will mess up layouts before the draw function.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.Public_Functions"></a><a name="Topic111"></a><div class="CTopic TGroup LCSharp">
|
|
|
|
- <div class="CTitle">Public Functions</div>
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.UIMatrix"></a><a name="Topic125"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
+ <div class="CTitle">UIMatrix</div>
|
|
|
|
+ <div id="NDPrototype125" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> Matrix UIMatrix { <span class="SHKeyword">get</span> }</div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Returns</div><p>A matrix representing UI coordinate system.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.GetUIMatrix"></a><a name="Topic152"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
- <div class="CTitle">GetUIMatrix</div>
|
|
|
|
- <div id="NDPrototype152" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> Matrix GetUIMatrix()</div>
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.ScrollWheelDelta"></a><a name="Topic126"></a><div class="CTopic TProperty LCSharp">
|
|
|
|
+ <div class="CTitle">ScrollWheelDelta</div>
|
|
|
|
+ <div id="NDPrototype126" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> ScrollWheelDelta { <span class="SHKeyword">get</span> }</div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Returns</div><p>The scroll wheel delta since the last update.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.ScrollWheelDelta"></a><a name="Topic153"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
- <div class="CTitle">ScrollWheelDelta</div>
|
|
|
|
- <div id="NDPrototype153" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> ScrollWheelDelta()</div>
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.Public_Functions"></a><a name="Topic111"></a><div class="CTopic TGroup LCSharp">
|
|
|
|
+ <div class="CTitle">Public Functions</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.MouseToUI"></a><a name="Topic154"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.MouseToUI"></a><a name="Topic127"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">MouseToUI</div>
|
|
<div class="CTitle">MouseToUI</div>
|
|
- <div id="NDPrototype154" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> Point MouseToUI()</div>
|
|
|
|
|
|
+ <div id="NDPrototype127" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> Point MouseToUI()</div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Returns</div><p>The mouse in the UI coordinate system.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.ScreenToUI"></a><a name="Topic155"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.ScreenToUI"></a><a name="Topic128"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">ScreenToUI</div>
|
|
<div class="CTitle">ScreenToUI</div>
|
|
- <div id="NDPrototype155" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> Point ScreenToUI(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Point </td><td class="PName last">p</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype128" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> Point ScreenToUI(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Point </td><td class="PName last">p</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Parameter</div><table class="CDefinitionList"><tr><td class="CDLEntry">p<div class="CDLParameterType">Point</div></td><td class="CDLDefinition"><p>A point in the screen coordinate system.</p></td></tr></table><div class="CHeading">Returns</div><p>The point converted into it's equivalent UI coordinate.</p></div>
|
|
|
|
+</div>
|
|
|
|
+
|
|
|
|
+<a name="Apos.Gui.GuiHelper.ScreenToUI(2)"></a><a name="Topic129"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
+ <div class="CTitle">ScreenToUI</div>
|
|
|
|
+ <div id="NDPrototype129" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> ScreenToUI(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">int</span> </td><td class="PName last">n</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Parameter</div><table class="CDefinitionList"><tr><td class="CDLEntry">n<div class="CDLParameterType"><span class="SHKeyword">int</span></div></td><td class="CDLDefinition"><p>A number on the screen's X or Y axis.</p></td></tr></table><div class="CHeading">Returns</div><p>The number converted into it's equivalent UI coordinate on the X or Y axis.</p></div>
|
|
|
|
+</div>
|
|
|
|
+
|
|
|
|
+<a name="Apos.Gui.GuiHelper.UIToScreen"></a><a name="Topic130"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
+ <div class="CTitle">UIToScreen</div>
|
|
|
|
+ <div id="NDPrototype130" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> Point UIToScreen(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Point </td><td class="PName last">p</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Parameter</div><table class="CDefinitionList"><tr><td class="CDLEntry">p<div class="CDLParameterType">Point</div></td><td class="CDLDefinition"><p>A point in the UI coordinate system.</p></td></tr></table><div class="CHeading">Returns</div><p>The point converted into it's equivalent screen coordinate.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.UIToScreen"></a><a name="Topic156"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.UIToScreen(2)"></a><a name="Topic131"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">UIToScreen</div>
|
|
<div class="CTitle">UIToScreen</div>
|
|
- <div id="NDPrototype156" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> Point UIToScreen(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Point </td><td class="PName last">p</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype131" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">int</span> UIToScreen(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">int</span> </td><td class="PName last">n</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Parameter</div><table class="CDefinitionList"><tr><td class="CDLEntry">n<div class="CDLParameterType"><span class="SHKeyword">int</span></div></td><td class="CDLDefinition"><p>A number on the UI's X or Y axis.</p></td></tr></table><div class="CHeading">Returns</div><p>The number converted into it's equivalent screen coordinate on the X or Y axis.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.Begin"></a><a name="Topic157"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.Begin"></a><a name="Topic132"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">Begin</div>
|
|
<div class="CTitle">Begin</div>
|
|
- <div id="NDPrototype157" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> Begin(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype132" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> Begin(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><p>Calls begin on the spritebatch with the UI rasterizer state, transform matrix and sampler state.</p><div class="CHeading">Parameter</div><table class="CDefinitionList"><tr><td class="CDLEntry">s<div class="CDLParameterType">SpriteBatch</div></td><td class="CDLDefinition"><p>A spritebatch that is waiting for begin to be called on it.</p></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.End"></a><a name="Topic158"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.End"></a><a name="Topic133"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">End</div>
|
|
<div class="CTitle">End</div>
|
|
- <div id="NDPrototype158" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> End(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype133" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> End(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><p>Calls end on the spritebatch.</p><div class="CHeading">Parameter</div><table class="CDefinitionList"><tr><td class="CDLEntry">s<div class="CDLParameterType">SpriteBatch</div></td><td class="CDLDefinition"><p>A spritebatch that is waiting for end to be called on it.</p></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.SetScissor"></a><a name="Topic159"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.SetScissor"></a><a name="Topic134"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">SetScissor</div>
|
|
<div class="CTitle">SetScissor</div>
|
|
- <div id="NDPrototype159" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> SetScissor(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first">Rectangle </td><td class="PName last">r</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype134" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> SetScissor(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first">Rectangle </td><td class="PName last">r</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><p>Uses a rectangle to limit the area that the spritebatch is allowed to draw to. The rectangle is converted into screen coordinates.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">s<div class="CDLParameterType">SpriteBatch</div></td><td class="CDLDefinition"><p>A spritebatch that is being tracked by the UI.</p></td></tr><tr><td class="CDLEntry">r<div class="CDLParameterType">Rectangle</div></td><td class="CDLDefinition"><p>The rectangle to use for the spritebatch scissor in UI coordinates.</p></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.ResetScissor"></a><a name="Topic160"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.ResetScissor"></a><a name="Topic135"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">ResetScissor</div>
|
|
<div class="CTitle">ResetScissor</div>
|
|
- <div id="NDPrototype160" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> ResetScissor(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first">Rectangle </td><td class="PName last">r</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype135" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> ResetScissor(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first">Rectangle </td><td class="PName last">r</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><p>Uses a rectangle to limit the area that the spritebatch is allowed to draw to.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">s<div class="CDLParameterType">SpriteBatch</div></td><td class="CDLDefinition"><p>A spritebatch that is being tracked by the UI.</p></td></tr><tr><td class="CDLEntry">r<div class="CDLParameterType">Rectangle</div></td><td class="CDLDefinition"><p>The rectangle to use for the spritebatch scissor in screen coordinates.</p></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.UpdateSetup"></a><a name="Topic161"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.UpdateSetup"></a><a name="Topic136"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">UpdateSetup</div>
|
|
<div class="CTitle">UpdateSetup</div>
|
|
- <div id="NDPrototype161" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> UpdateSetup()</div>
|
|
|
|
|
|
+ <div id="NDPrototype136" class="NDPrototype NoParameterForm"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> UpdateSetup()</div>
|
|
|
|
+ <div class="CBody"><p>This should be called at the start of the game's update loop.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.DrawGui"></a><a name="Topic162"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.DrawGui"></a><a name="Topic137"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">DrawGui</div>
|
|
<div class="CTitle">DrawGui</div>
|
|
- <div id="NDPrototype162" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> DrawGui(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first"><a href="../index.html#File:Component.cs:Apos.Gui.Component" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,231);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Component</a> </td><td class="PName last">c</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype137" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> DrawGui(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first"><a href="../index.html#File:Component.cs:Apos.Gui.Component" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,140);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Component</a> </td><td class="PName last">c</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><p>This should be used on a UI root component. This function tracks the spritebatch to call being and end correctly.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">s<div class="CDLParameterType">SpriteBatch</div></td><td class="CDLDefinition"><p>A spritebatch that is waiting for begin to be called on it.</p></td></tr><tr><td class="CDLEntry">c<div class="CDLParameterType"><a href="../index.html#File:Component.cs:Apos.Gui.Component" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,140);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Component</a></div></td><td class="CDLDefinition"><p>A root component to draw.</p></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.DrawString"></a><a name="Topic163"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.DrawString"></a><a name="Topic138"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">DrawString</div>
|
|
<div class="CTitle">DrawString</div>
|
|
- <div id="NDPrototype163" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> DrawString(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first"><span class="SHKeyword">string</span> </td><td class="PName last">t,</td></tr><tr><td class="PType first">Vector2 </td><td class="PName last">p,</td></tr><tr><td class="PType first">Color </td><td class="PName last">c</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype138" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> <span class="SHKeyword">void</span> DrawString(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">SpriteBatch </td><td class="PName last">s,</td></tr><tr><td class="PType first"><span class="SHKeyword">string</span> </td><td class="PName last">t,</td></tr><tr><td class="PType first">Vector2 </td><td class="PName last">p,</td></tr><tr><td class="PType first">Color </td><td class="PName last">c</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><p>Draws a string using the Font, FontSize and UI scale.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">s<div class="CDLParameterType">SpriteBatch</div></td><td class="CDLDefinition"><p>A spritebatch that is being tracked by the UI.</p></td></tr><tr><td class="CDLEntry">t<div class="CDLParameterType"><span class="SHKeyword">string</span></div></td><td class="CDLDefinition"><p>The string to draw.</p></td></tr><tr><td class="CDLEntry">p<div class="CDLParameterType">Vector2</div></td><td class="CDLDefinition"><p>The position for the string.</p></td></tr><tr><td class="CDLEntry">c<div class="CDLParameterType">Color</div></td><td class="CDLDefinition"><p>The color for the string.</p></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper.MeasureString"></a><a name="Topic164"></a><div class="CTopic TFunction LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper.MeasureString"></a><a name="Topic139"></a><div class="CTopic TFunction LCSharp">
|
|
<div class="CTitle">MeasureString</div>
|
|
<div class="CTitle">MeasureString</div>
|
|
- <div id="NDPrototype164" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> Vector2 MeasureString(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">string</span> </td><td class="PName last">text</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
|
|
+ <div id="NDPrototype139" class="NDPrototype WideForm CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">public static</span> Vector2 MeasureString(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">string</span> </td><td class="PName last">t</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div>
|
|
|
|
+ <div class="CBody"><div class="CHeading">Parameter</div><table class="CDefinitionList"><tr><td class="CDLEntry">t<div class="CDLParameterType"><span class="SHKeyword">string</span></div></td><td class="CDLDefinition"><p>The string to measure.</p></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<a name="Apos.Gui.GuiHelper.Private_Variables"></a><a name="Topic115"></a><div class="CTopic TGroup LCSharp">
|
|
<a name="Apos.Gui.GuiHelper.Private_Variables"></a><a name="Topic115"></a><div class="CTopic TGroup LCSharp">
|
|
<div class="CTitle">Private Variables</div>
|
|
<div class="CTitle">Private Variables</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper._scale"></a><a name="Topic166"></a><div class="CTopic TVariable LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper._scale"></a><a name="Topic141"></a><div class="CTopic TVariable LCSharp">
|
|
<div class="CTitle">_scale</div>
|
|
<div class="CTitle">_scale</div>
|
|
- <div id="NDPrototype166" class="NDPrototype NoParameterForm"><span class="SHKeyword">private static</span> <span class="SHKeyword">float</span> _scale</div>
|
|
|
|
|
|
+ <div id="NDPrototype141" class="NDPrototype NoParameterForm"><span class="SHKeyword">private static</span> <span class="SHKeyword">float</span> _scale</div>
|
|
|
|
+ <div class="CBody"><p>The scale field behind the Scale property.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper._rasterState"></a><a name="Topic167"></a><div class="CTopic TVariable LCSharp">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper._rasterState"></a><a name="Topic169"></a><div class="CTopic TVariable LCSharp">
|
|
<div class="CTitle">_rasterState</div>
|
|
<div class="CTitle">_rasterState</div>
|
|
- <div id="NDPrototype167" class="NDPrototype NoParameterForm"><span class="SHKeyword">private static</span> RasterizerState _rasterState</div>
|
|
|
|
|
|
+ <div id="NDPrototype169" class="NDPrototype NoParameterForm"><span class="SHKeyword">private static</span> RasterizerState _rasterState</div>
|
|
|
|
+ <div class="CBody"><p>A rasterizer state that enables the scissor test for the spritebatch.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
-<a name="Apos.Gui.GuiHelper._beginCalled"></a><a name="Topic168"></a><div class="CTopic TVariable LCSharp last">
|
|
|
|
|
|
+<a name="Apos.Gui.GuiHelper._beginCalled"></a><a name="Topic171"></a><div class="CTopic TVariable LCSharp last">
|
|
<div class="CTitle">_beginCalled</div>
|
|
<div class="CTitle">_beginCalled</div>
|
|
- <div id="NDPrototype168" class="NDPrototype NoParameterForm"><span class="SHKeyword">private static</span> <span class="SHKeyword">bool</span> _beginCalled</div>
|
|
|
|
|
|
+ <div id="NDPrototype171" class="NDPrototype NoParameterForm"><span class="SHKeyword">private static</span> <span class="SHKeyword">bool</span> _beginCalled</div>
|
|
|
|
+ <div class="CBody"><p>Tracks whether begin has been called on the spritebatch.</p></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</body></html>
|
|
</body></html>
|