FontFace.xml 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. <Type Name="FontFace" FullName="Urho.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>
  14. %Font face description.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public FontFace (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 FontFace, 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="public FontFace (Urho.UrhoObjectFlag emptyFlag);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig 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="GetGlyph">
  60. <MemberSignature Language="C#" Value="public virtual Urho.FontGlyph* GetGlyph (uint c);" />
  61. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Urho.FontGlyph* GetGlyph(unsigned int32 c) cil managed" />
  62. <MemberType>Method</MemberType>
  63. <AssemblyInfo>
  64. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  65. </AssemblyInfo>
  66. <ReturnValue>
  67. <ReturnType>Urho.FontGlyph*</ReturnType>
  68. </ReturnValue>
  69. <Parameters>
  70. <Parameter Name="c" Type="System.UInt32" />
  71. </Parameters>
  72. <Docs>
  73. <param name="c">To be added.</param>
  74. <summary>
  75. Return pointer to the glyph structure corresponding to a character. Return null if glyph not found.
  76. </summary>
  77. <returns>To be added.</returns>
  78. <remarks>To be added.</remarks>
  79. </Docs>
  80. </Member>
  81. <Member MemberName="GetKerning">
  82. <MemberSignature Language="C#" Value="public short GetKerning (uint c, uint d);" />
  83. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int16 GetKerning(unsigned int32 c, unsigned int32 d) cil managed" />
  84. <MemberType>Method</MemberType>
  85. <AssemblyInfo>
  86. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  87. </AssemblyInfo>
  88. <ReturnValue>
  89. <ReturnType>System.Int16</ReturnType>
  90. </ReturnValue>
  91. <Parameters>
  92. <Parameter Name="c" Type="System.UInt32" />
  93. <Parameter Name="d" Type="System.UInt32" />
  94. </Parameters>
  95. <Docs>
  96. <param name="c">To be added.</param>
  97. <param name="d">To be added.</param>
  98. <summary>
  99. Return the kerning for a character and the next character.
  100. </summary>
  101. <returns>To be added.</returns>
  102. <remarks>To be added.</remarks>
  103. </Docs>
  104. </Member>
  105. <Member MemberName="HasMutableGlyphs">
  106. <MemberSignature Language="C#" Value="public virtual bool HasMutableGlyphs ();" />
  107. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool HasMutableGlyphs() cil managed" />
  108. <MemberType>Method</MemberType>
  109. <AssemblyInfo>
  110. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  111. </AssemblyInfo>
  112. <ReturnValue>
  113. <ReturnType>System.Boolean</ReturnType>
  114. </ReturnValue>
  115. <Parameters />
  116. <Docs>
  117. <summary>
  118. Return if font face uses mutable glyphs.
  119. </summary>
  120. <returns>To be added.</returns>
  121. <remarks>To be added.</remarks>
  122. </Docs>
  123. </Member>
  124. <Member MemberName="IsDataLost">
  125. <MemberSignature Language="C#" Value="public bool IsDataLost ();" />
  126. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsDataLost() cil managed" />
  127. <MemberType>Method</MemberType>
  128. <AssemblyInfo>
  129. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  130. </AssemblyInfo>
  131. <ReturnValue>
  132. <ReturnType>System.Boolean</ReturnType>
  133. </ReturnValue>
  134. <Parameters />
  135. <Docs>
  136. <summary>
  137. Return true when one of the texture has a data loss.
  138. </summary>
  139. <returns>To be added.</returns>
  140. <remarks>To be added.</remarks>
  141. </Docs>
  142. </Member>
  143. <Member MemberName="Load">
  144. <MemberSignature Language="C#" Value="public virtual bool Load (byte* fontData, uint fontDataSize, int pointSize);" />
  145. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Load(unsigned int8* fontData, unsigned int32 fontDataSize, int32 pointSize) cil managed" />
  146. <MemberType>Method</MemberType>
  147. <AssemblyInfo>
  148. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  149. </AssemblyInfo>
  150. <ReturnValue>
  151. <ReturnType>System.Boolean</ReturnType>
  152. </ReturnValue>
  153. <Parameters>
  154. <Parameter Name="fontData" Type="System.Byte*" />
  155. <Parameter Name="fontDataSize" Type="System.UInt32" />
  156. <Parameter Name="pointSize" Type="System.Int32" />
  157. </Parameters>
  158. <Docs>
  159. <param name="fontData">To be added.</param>
  160. <param name="fontDataSize">To be added.</param>
  161. <param name="pointSize">To be added.</param>
  162. <summary>
  163. Load font face.
  164. </summary>
  165. <returns>To be added.</returns>
  166. <remarks>To be added.</remarks>
  167. </Docs>
  168. </Member>
  169. <Member MemberName="PointSize">
  170. <MemberSignature Language="C#" Value="public int PointSize { get; }" />
  171. <MemberSignature Language="ILAsm" Value=".property instance int32 PointSize" />
  172. <MemberType>Property</MemberType>
  173. <AssemblyInfo>
  174. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  175. </AssemblyInfo>
  176. <ReturnValue>
  177. <ReturnType>System.Int32</ReturnType>
  178. </ReturnValue>
  179. <Docs>
  180. <summary>
  181. Return point size.
  182. </summary>
  183. <value>To be added.</value>
  184. <remarks>To be added.</remarks>
  185. </Docs>
  186. </Member>
  187. <Member MemberName="RowHeight">
  188. <MemberSignature Language="C#" Value="public int RowHeight { get; }" />
  189. <MemberSignature Language="ILAsm" Value=".property instance int32 RowHeight" />
  190. <MemberType>Property</MemberType>
  191. <AssemblyInfo>
  192. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  193. </AssemblyInfo>
  194. <ReturnValue>
  195. <ReturnType>System.Int32</ReturnType>
  196. </ReturnValue>
  197. <Docs>
  198. <summary>
  199. Return row height.
  200. </summary>
  201. <value>To be added.</value>
  202. <remarks>To be added.</remarks>
  203. </Docs>
  204. </Member>
  205. <Member MemberName="Textures">
  206. <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList&lt;Urho.Texture2D&gt; Textures { get; }" />
  207. <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1&lt;class Urho.Texture2D&gt; Textures" />
  208. <MemberType>Property</MemberType>
  209. <AssemblyInfo>
  210. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  211. </AssemblyInfo>
  212. <ReturnValue>
  213. <ReturnType>System.Collections.Generic.IReadOnlyList&lt;Urho.Texture2D&gt;</ReturnType>
  214. </ReturnValue>
  215. <Docs>
  216. <summary>
  217. Return textures.
  218. </summary>
  219. <value>To be added.</value>
  220. <remarks>To be added.</remarks>
  221. </Docs>
  222. </Member>
  223. </Members>
  224. </Type>