Drawable2D.xml 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. <Type Name="Drawable2D" FullName="Urho.Urho2D.Drawable2D">
  2. <TypeSignature Language="C#" Value="public class Drawable2D : Urho.Drawable" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Drawable2D extends Urho.Drawable" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Drawable</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Base class for 2D visible components.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public Drawable2D (IntPtr handle);" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters>
  27. <Parameter Name="handle" Type="System.IntPtr" />
  28. </Parameters>
  29. <Docs>
  30. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  31. <summary>Constructs a new instance of Urho.Urho2D.Drawable2D, given a raw pointer to an unmanaged object</summary>
  32. <remarks>
  33. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  34. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  35. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  36. </remarks>
  37. </Docs>
  38. </Member>
  39. <Member MemberName=".ctor">
  40. <MemberSignature Language="C#" Value="protected Drawable2D (Urho.UrhoObjectFlag emptyFlag);" />
  41. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  48. </Parameters>
  49. <Docs>
  50. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  51. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  52. <remarks>
  53. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  54. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  55. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  56. </remarks>
  57. </Docs>
  58. </Member>
  59. <Member MemberName="Layer">
  60. <MemberSignature Language="C#" Value="public int Layer { get; set; }" />
  61. <MemberSignature Language="ILAsm" Value=".property instance int32 Layer" />
  62. <MemberType>Property</MemberType>
  63. <AssemblyInfo>
  64. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  65. </AssemblyInfo>
  66. <ReturnValue>
  67. <ReturnType>System.Int32</ReturnType>
  68. </ReturnValue>
  69. <Docs>
  70. <summary>
  71. Return layer.
  72. Or
  73. Set layer.
  74. </summary>
  75. <value>To be added.</value>
  76. <remarks>To be added.</remarks>
  77. </Docs>
  78. </Member>
  79. <Member MemberName="OnSetEnabled">
  80. <MemberSignature Language="C#" Value="public override void OnSetEnabled ();" />
  81. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnSetEnabled() cil managed" />
  82. <MemberType>Method</MemberType>
  83. <AssemblyInfo>
  84. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  85. </AssemblyInfo>
  86. <ReturnValue>
  87. <ReturnType>System.Void</ReturnType>
  88. </ReturnValue>
  89. <Parameters />
  90. <Docs>
  91. <summary>
  92. Handle enabled/disabled state change.
  93. </summary>
  94. <remarks>To be added.</remarks>
  95. </Docs>
  96. </Member>
  97. <Member MemberName="OrderInLayer">
  98. <MemberSignature Language="C#" Value="public int OrderInLayer { get; set; }" />
  99. <MemberSignature Language="ILAsm" Value=".property instance int32 OrderInLayer" />
  100. <MemberType>Property</MemberType>
  101. <AssemblyInfo>
  102. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  103. </AssemblyInfo>
  104. <ReturnValue>
  105. <ReturnType>System.Int32</ReturnType>
  106. </ReturnValue>
  107. <Docs>
  108. <summary>
  109. Return order in layer.
  110. Or
  111. Set order in layer.
  112. </summary>
  113. <value>To be added.</value>
  114. <remarks>To be added.</remarks>
  115. </Docs>
  116. </Member>
  117. <Member MemberName="RegisterObject">
  118. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  119. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  120. <MemberType>Method</MemberType>
  121. <AssemblyInfo>
  122. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  123. </AssemblyInfo>
  124. <ReturnValue>
  125. <ReturnType>System.Void</ReturnType>
  126. </ReturnValue>
  127. <Parameters>
  128. <Parameter Name="context" Type="Urho.Context" />
  129. </Parameters>
  130. <Docs>
  131. <param name="context">To be added.</param>
  132. <summary>
  133. Register object factory. Drawable must be registered first.
  134. </summary>
  135. <remarks>To be added.</remarks>
  136. </Docs>
  137. </Member>
  138. <Member MemberName="Type">
  139. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  140. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  141. <MemberType>Property</MemberType>
  142. <AssemblyInfo>
  143. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  144. </AssemblyInfo>
  145. <ReturnValue>
  146. <ReturnType>Urho.StringHash</ReturnType>
  147. </ReturnValue>
  148. <Docs>
  149. <summary>Urho's type system type.</summary>
  150. <value>StringHash representing the type for this C# type.</value>
  151. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  152. </Docs>
  153. </Member>
  154. <Member MemberName="TypeName">
  155. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  156. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  157. <MemberType>Property</MemberType>
  158. <AssemblyInfo>
  159. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  160. </AssemblyInfo>
  161. <ReturnValue>
  162. <ReturnType>System.String</ReturnType>
  163. </ReturnValue>
  164. <Docs>
  165. <summary>Urho's low-level type name.</summary>
  166. <value>Stringified low-level type name.</value>
  167. <remarks></remarks>
  168. </Docs>
  169. </Member>
  170. <Member MemberName="TypeNameStatic">
  171. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  172. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  173. <MemberType>Property</MemberType>
  174. <AssemblyInfo>
  175. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  176. </AssemblyInfo>
  177. <ReturnValue>
  178. <ReturnType>System.String</ReturnType>
  179. </ReturnValue>
  180. <Docs>
  181. <summary>Urho's low-level type name, accessible as a static method.</summary>
  182. <value>Stringified low-level type name.</value>
  183. <remarks></remarks>
  184. </Docs>
  185. </Member>
  186. <Member MemberName="TypeStatic">
  187. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  188. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  189. <MemberType>Property</MemberType>
  190. <AssemblyInfo>
  191. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  192. </AssemblyInfo>
  193. <ReturnValue>
  194. <ReturnType>Urho.StringHash</ReturnType>
  195. </ReturnValue>
  196. <Docs>
  197. <summary>Urho's low-level type, accessible as a static method.</summary>
  198. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  199. <remarks></remarks>
  200. </Docs>
  201. </Member>
  202. </Members>
  203. </Type>