OpenTypeVarAxisInfo.xml

<Type Name="OpenTypeVarAxisInfo" FullName="HarfBuzzSharp.OpenTypeVarAxisInfo">
  <TypeSignature Language="C#" Value="public struct OpenTypeVarAxisInfo : IEquatable&lt;HarfBuzzSharp.OpenTypeVarAxisInfo&gt;" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit OpenTypeVarAxisInfo extends System.ValueType implements class System.IEquatable`1&lt;valuetype HarfBuzzSharp.OpenTypeVarAxisInfo&gt;" />
  <TypeSignature Language="DocId" Value="T:HarfBuzzSharp.OpenTypeVarAxisInfo" />
  <AssemblyInfo>
    <AssemblyName>HarfBuzzSharp</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IEquatable&lt;HarfBuzzSharp.OpenTypeVarAxisInfo&gt;</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>Represents extended information about a variation axis in a variable font.</summary>
    <remarks>This structure provides detailed information about a font variation axis, including its range, default value, and flags.</remarks>
  </Docs>
  <Members>
    <Member MemberName="AxisIndex">
      <MemberSignature Language="C#" Value="public uint AxisIndex { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 AxisIndex" />
      <MemberSignature Language="DocId" Value="P:HarfBuzzSharp.OpenTypeVarAxisInfo.AxisIndex" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.UInt32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the index of the axis in the font's variation axis array.</summary>
        <value>The zero-based axis index.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="DefaultValue">
      <MemberSignature Language="C#" Value="public float DefaultValue { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float32 DefaultValue" />
      <MemberSignature Language="DocId" Value="P:HarfBuzzSharp.OpenTypeVarAxisInfo.DefaultValue" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the default value for this axis.</summary>
        <value>The default axis value.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public readonly bool Equals (HarfBuzzSharp.OpenTypeVarAxisInfo obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype HarfBuzzSharp.OpenTypeVarAxisInfo obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:HarfBuzzSharp.OpenTypeVarAxisInfo.Equals(HarfBuzzSharp.OpenTypeVarAxisInfo)" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" />
      </Parameters>
      <Docs>
        <param name="obj">The object to compare with the current instance.</param>
        <summary>Determines whether the specified <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> is equal to the current instance.</summary>
        <returns>
          <see langword="true" /> if the objects are equal; otherwise, <see langword="false" />.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override readonly bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:HarfBuzzSharp.OpenTypeVarAxisInfo.Equals(System.Object)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">The object to compare with the current instance.</param>
        <summary>Determines whether the specified object is equal to the current instance.</summary>
        <returns>
          <see langword="true" /> if the objects are equal; otherwise, <see langword="false" />.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Flags">
      <MemberSignature Language="C#" Value="public HarfBuzzSharp.OpenTypeVarAxisFlags Flags { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype HarfBuzzSharp.OpenTypeVarAxisFlags Flags" />
      <MemberSignature Language="DocId" Value="P:HarfBuzzSharp.OpenTypeVarAxisInfo.Flags" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>HarfBuzzSharp.OpenTypeVarAxisFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the axis flags.</summary>
        <value>The axis flags.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override readonly int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:HarfBuzzSharp.OpenTypeVarAxisInfo.GetHashCode" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns a hash code for this instance.</summary>
        <returns>A hash code for the current object.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="MaxValue">
      <MemberSignature Language="C#" Value="public float MaxValue { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float32 MaxValue" />
      <MemberSignature Language="DocId" Value="P:HarfBuzzSharp.OpenTypeVarAxisInfo.MaxValue" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the maximum value for this axis.</summary>
        <value>The maximum axis value.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="MinValue">
      <MemberSignature Language="C#" Value="public float MinValue { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float32 MinValue" />
      <MemberSignature Language="DocId" Value="P:HarfBuzzSharp.OpenTypeVarAxisInfo.MinValue" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the minimum value for this axis.</summary>
        <value>The minimum axis value.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="NameId">
      <MemberSignature Language="C#" Value="public HarfBuzzSharp.OpenTypeNameId NameId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype HarfBuzzSharp.OpenTypeNameId NameId" />
      <MemberSignature Language="DocId" Value="P:HarfBuzzSharp.OpenTypeVarAxisInfo.NameId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>HarfBuzzSharp.OpenTypeNameId</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the name identifier for the axis name in the font's name table.</summary>
        <value>The name table identifier.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool operator == (HarfBuzzSharp.OpenTypeVarAxisInfo left, HarfBuzzSharp.OpenTypeVarAxisInfo right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype HarfBuzzSharp.OpenTypeVarAxisInfo left, valuetype HarfBuzzSharp.OpenTypeVarAxisInfo right) cil managed" />
      <MemberSignature Language="DocId" Value="M:HarfBuzzSharp.OpenTypeVarAxisInfo.op_Equality(HarfBuzzSharp.OpenTypeVarAxisInfo,HarfBuzzSharp.OpenTypeVarAxisInfo)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" />
        <Parameter Name="right" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" />
      </Parameters>
      <Docs>
        <param name="left">The first value to compare.</param>
        <param name="right">The second value to compare.</param>
        <summary>Determines whether two <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> structures are equal.</summary>
        <returns>
          <see langword="true" /> if the values are equal; otherwise, <see langword="false" />.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool operator != (HarfBuzzSharp.OpenTypeVarAxisInfo left, HarfBuzzSharp.OpenTypeVarAxisInfo right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype HarfBuzzSharp.OpenTypeVarAxisInfo left, valuetype HarfBuzzSharp.OpenTypeVarAxisInfo right) cil managed" />
      <MemberSignature Language="DocId" Value="M:HarfBuzzSharp.OpenTypeVarAxisInfo.op_Inequality(HarfBuzzSharp.OpenTypeVarAxisInfo,HarfBuzzSharp.OpenTypeVarAxisInfo)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" />
        <Parameter Name="right" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" />
      </Parameters>
      <Docs>
        <param name="left">The first value to compare.</param>
        <param name="right">The second value to compare.</param>
        <summary>Determines whether two <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> structures are not equal.</summary>
        <returns>
          <see langword="true" /> if the values are not equal; otherwise, <see langword="false" />.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Tag">
      <MemberSignature Language="C#" Value="public uint Tag { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 Tag" />
      <MemberSignature Language="DocId" Value="P:HarfBuzzSharp.OpenTypeVarAxisInfo.Tag" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>HarfBuzzSharp</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.UInt32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the four-character tag identifying the axis (for example, 'wght' for weight).</summary>
        <value>The axis tag.</value>
        <remarks />
      </Docs>
    </Member>
  </Members>
</Type>