FontFace.xml 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <Type Name="FontFace" FullName="Urho.Gui.FontFace">
  2. <TypeSignature Language="C#" Value="public class FontFace : Urho.RefCounted" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FontFace extends Urho.RefCounted" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.RefCounted</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Font face description.
  14. </summary>
  15. <remarks>To be added.</remarks>
  16. </Docs>
  17. <Members>
  18. <Member MemberName=".ctor">
  19. <MemberSignature Language="C#" Value="public FontFace (IntPtr handle);" />
  20. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  21. <MemberType>Constructor</MemberType>
  22. <AssemblyInfo>
  23. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  24. </AssemblyInfo>
  25. <Parameters>
  26. <Parameter Name="handle" Type="System.IntPtr" />
  27. </Parameters>
  28. <Docs>
  29. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  30. <summary>Constructs a new instance of Urho.Gui.FontFace, given a raw pointer to an unmanaged object</summary>
  31. <remarks>
  32. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  33. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  34. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  35. </remarks>
  36. </Docs>
  37. </Member>
  38. <Member MemberName=".ctor">
  39. <MemberSignature Language="C#" Value="protected FontFace (Urho.UrhoObjectFlag emptyFlag);" />
  40. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  41. <MemberType>Constructor</MemberType>
  42. <AssemblyInfo>
  43. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  44. </AssemblyInfo>
  45. <Parameters>
  46. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  47. </Parameters>
  48. <Docs>
  49. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  50. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  51. <remarks>
  52. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  53. <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>
  54. <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>
  55. </remarks>
  56. </Docs>
  57. </Member>
  58. <Member MemberName="DataLost">
  59. <MemberSignature Language="C#" Value="public bool DataLost { get; }" />
  60. <MemberSignature Language="ILAsm" Value=".property instance bool DataLost" />
  61. <MemberType>Property</MemberType>
  62. <AssemblyInfo>
  63. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  64. </AssemblyInfo>
  65. <ReturnValue>
  66. <ReturnType>System.Boolean</ReturnType>
  67. </ReturnValue>
  68. <Docs>
  69. <summary>True if any of the textures has dataloss.</summary>
  70. <value>To be added.</value>
  71. <remarks>To be added.</remarks>
  72. </Docs>
  73. </Member>
  74. <Member MemberName="GetGlyph">
  75. <MemberSignature Language="C#" Value="public virtual Urho.FontGlyph* GetGlyph (uint c);" />
  76. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Urho.FontGlyph* GetGlyph(unsigned int32 c) cil managed" />
  77. <MemberType>Method</MemberType>
  78. <AssemblyInfo>
  79. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  80. </AssemblyInfo>
  81. <ReturnValue>
  82. <ReturnType>Urho.FontGlyph*</ReturnType>
  83. </ReturnValue>
  84. <Parameters>
  85. <Parameter Name="c" Type="System.UInt32" />
  86. </Parameters>
  87. <Docs>
  88. <param name="c">To be added.</param>
  89. <summary>
  90. Return pointer to the glyph structure corresponding to a character. Return null if glyph not found.
  91. </summary>
  92. <returns>To be added.</returns>
  93. <remarks>To be added.</remarks>
  94. </Docs>
  95. </Member>
  96. <Member MemberName="GetKerning">
  97. <MemberSignature Language="C#" Value="public short GetKerning (uint c, uint d);" />
  98. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int16 GetKerning(unsigned int32 c, unsigned int32 d) cil managed" />
  99. <MemberType>Method</MemberType>
  100. <AssemblyInfo>
  101. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  102. </AssemblyInfo>
  103. <ReturnValue>
  104. <ReturnType>System.Int16</ReturnType>
  105. </ReturnValue>
  106. <Parameters>
  107. <Parameter Name="c" Type="System.UInt32" />
  108. <Parameter Name="d" Type="System.UInt32" />
  109. </Parameters>
  110. <Docs>
  111. <param name="c">To be added.</param>
  112. <param name="d">To be added.</param>
  113. <summary>
  114. Return the kerning for a character and the next character.
  115. </summary>
  116. <returns>To be added.</returns>
  117. <remarks>To be added.</remarks>
  118. </Docs>
  119. </Member>
  120. <Member MemberName="HasMutableGlyphs">
  121. <MemberSignature Language="C#" Value="public virtual bool HasMutableGlyphs ();" />
  122. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool HasMutableGlyphs() cil managed" />
  123. <MemberType>Method</MemberType>
  124. <AssemblyInfo>
  125. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  126. </AssemblyInfo>
  127. <ReturnValue>
  128. <ReturnType>System.Boolean</ReturnType>
  129. </ReturnValue>
  130. <Parameters />
  131. <Docs>
  132. <summary>
  133. Return if font face uses mutable glyphs.
  134. </summary>
  135. <returns>To be added.</returns>
  136. <remarks>To be added.</remarks>
  137. </Docs>
  138. </Member>
  139. <Member MemberName="Load">
  140. <MemberSignature Language="C#" Value="public virtual bool Load (byte* fontData, uint fontDataSize, int pointSize);" />
  141. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Load(unsigned int8* fontData, unsigned int32 fontDataSize, int32 pointSize) cil managed" />
  142. <MemberType>Method</MemberType>
  143. <AssemblyInfo>
  144. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  145. </AssemblyInfo>
  146. <ReturnValue>
  147. <ReturnType>System.Boolean</ReturnType>
  148. </ReturnValue>
  149. <Parameters>
  150. <Parameter Name="fontData" Type="System.Byte*" />
  151. <Parameter Name="fontDataSize" Type="System.UInt32" />
  152. <Parameter Name="pointSize" Type="System.Int32" />
  153. </Parameters>
  154. <Docs>
  155. <param name="fontData">To be added.</param>
  156. <param name="fontDataSize">To be added.</param>
  157. <param name="pointSize">To be added.</param>
  158. <summary>
  159. Load font face.
  160. </summary>
  161. <returns>To be added.</returns>
  162. <remarks>To be added.</remarks>
  163. </Docs>
  164. </Member>
  165. <Member MemberName="PointSize">
  166. <MemberSignature Language="C#" Value="public int PointSize { get; }" />
  167. <MemberSignature Language="ILAsm" Value=".property instance int32 PointSize" />
  168. <MemberType>Property</MemberType>
  169. <AssemblyInfo>
  170. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  171. </AssemblyInfo>
  172. <ReturnValue>
  173. <ReturnType>System.Int32</ReturnType>
  174. </ReturnValue>
  175. <Docs>
  176. <summary>
  177. Return point size.
  178. </summary>
  179. <value>To be added.</value>
  180. <remarks>To be added.</remarks>
  181. </Docs>
  182. </Member>
  183. <Member MemberName="RowHeight">
  184. <MemberSignature Language="C#" Value="public int RowHeight { get; }" />
  185. <MemberSignature Language="ILAsm" Value=".property instance int32 RowHeight" />
  186. <MemberType>Property</MemberType>
  187. <AssemblyInfo>
  188. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  189. </AssemblyInfo>
  190. <ReturnValue>
  191. <ReturnType>System.Int32</ReturnType>
  192. </ReturnValue>
  193. <Docs>
  194. <summary>
  195. Return row height.
  196. </summary>
  197. <value>To be added.</value>
  198. <remarks>To be added.</remarks>
  199. </Docs>
  200. </Member>
  201. <Member MemberName="Textures">
  202. <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList&lt;Urho.Urho2D.Texture2D&gt; Textures { get; }" />
  203. <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1&lt;class Urho.Urho2D.Texture2D&gt; Textures" />
  204. <MemberType>Property</MemberType>
  205. <AssemblyInfo>
  206. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  207. </AssemblyInfo>
  208. <ReturnValue>
  209. <ReturnType>System.Collections.Generic.IReadOnlyList&lt;Urho.Urho2D.Texture2D&gt;</ReturnType>
  210. </ReturnValue>
  211. <Docs>
  212. <summary>
  213. Return textures.
  214. </summary>
  215. <value>To be added.</value>
  216. <remarks>To be added.</remarks>
  217. </Docs>
  218. </Member>
  219. </Members>
  220. </Type>