RelativeFrameTimeHistogram.xml

<Type Name="RelativeFrameTimeHistogram" FullName="Android.App.Jank.RelativeFrameTimeHistogram">
  <TypeSignature Language="C#" Value="public class RelativeFrameTimeHistogram : Java.Lang.Object" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RelativeFrameTimeHistogram extends Java.Lang.Object" />
  <TypeSignature Language="DocId" Value="T:Android.App.Jank.RelativeFrameTimeHistogram" />
  <TypeSignature Language="F#" Value="type RelativeFrameTimeHistogram = class&#xA;    inherit Object" />
  <AssemblyInfo>
    <AssemblyName>Mono.Android</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Java.Lang.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Android.Runtime.Register("android/app/jank/RelativeFrameTimeHistogram", ApiSince=36, DoNotGenerateAcw=true)]</AttributeName>
      <AttributeName Language="F#">[&lt;Android.Runtime.Register("android/app/jank/RelativeFrameTimeHistogram", ApiSince=36, DoNotGenerateAcw=true)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android36.0")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android36.0")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>A histogram of frame times relative to their deadline.</summary>
    <remarks>
      <para>A histogram of frame times relative to their deadline.
            
            This class aids in reporting <c>AppJankStats</c> to the system and is designed for use by
            library widgets. It facilitates the recording of frame times in relation to the frame deadline.
            The class records the distribution of time remaining until a frame is considered janky or how
            janky the frame was.</para>
      <para>A frame's relative frame time value indicates whether it was delivered early, on time, or late.
            A negative relative frame time value indicates the frame was delivered early, a value of zero
            indicates the frame was delivered on time and a positive value indicates the frame was delivered
            late. The values of the endpoints indicate how early or late a frame was delivered.</para>
      <para>The relative frame times are recorded as a histogram: values are
            <c>#addRelativeFrameTimeMillis added</c> to a bucket by increasing the bucket's counter. The
            count of frames with a relative frame time between
            <c>#getBucketEndpointsMillis bucket endpoints</c><c>i</c> and <c>i+1</c> can be obtained
            through index <c>i</c> of <c>#getBucketCounters</c>.</para>
      <para>
        <format type="text/html">
          <a href="https://developer.android.com/reference/android/app/jank/RelativeFrameTimeHistogram" title="Reference documentation">Java documentation for <code>android.app.jank.RelativeFrameTimeHistogram</code>.</a>
        </format>
      </para>
      <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RelativeFrameTimeHistogram ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.App.Jank.RelativeFrameTimeHistogram.#ctor" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register(".ctor", "()V", "", ApiSince=36)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register(".ctor", "()V", "", ApiSince=36)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android36.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android36.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>Create a new instance of RelativeFrameTimeHistogram.</summary>
        <remarks>
          <para>Create a new instance of RelativeFrameTimeHistogram.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/app/jank/RelativeFrameTimeHistogram#RelativeFrameTimeHistogram()" title="Reference documentation">Java documentation for <code>android.app.jank.RelativeFrameTimeHistogram.RelativeFrameTimeHistogram()</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected RelativeFrameTimeHistogram (IntPtr javaReference, Android.Runtime.JniHandleOwnership transfer);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(native int javaReference, valuetype Android.Runtime.JniHandleOwnership transfer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.App.Jank.RelativeFrameTimeHistogram.#ctor(System.IntPtr,Android.Runtime.JniHandleOwnership)" />
      <MemberSignature Language="F#" Value="new Android.App.Jank.RelativeFrameTimeHistogram : nativeint * Android.Runtime.JniHandleOwnership -&gt; Android.App.Jank.RelativeFrameTimeHistogram" Usage="new Android.App.Jank.RelativeFrameTimeHistogram (javaReference, transfer)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="javaReference" Type="System.IntPtr" />
        <Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
      </Parameters>
      <Docs>
        <param name="javaReference">To be added.</param>
        <param name="transfer">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddRelativeFrameTimeMillis">
      <MemberSignature Language="C#" Value="public virtual void AddRelativeFrameTimeMillis (int frameTimeMillis);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddRelativeFrameTimeMillis(int32 frameTimeMillis) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.App.Jank.RelativeFrameTimeHistogram.AddRelativeFrameTimeMillis(System.Int32)" />
      <MemberSignature Language="F#" Value="abstract member AddRelativeFrameTimeMillis : int -&gt; unit&#xA;override this.AddRelativeFrameTimeMillis : int -&gt; unit" Usage="relativeFrameTimeHistogram.AddRelativeFrameTimeMillis frameTimeMillis" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("addRelativeFrameTimeMillis", "(I)V", "GetAddRelativeFrameTimeMillis_IHandler", ApiSince=36)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("addRelativeFrameTimeMillis", "(I)V", "GetAddRelativeFrameTimeMillis_IHandler", ApiSince=36)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android36.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android36.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="frameTimeMillis" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="frameTimeMillis">relative frame time in millis, relative frame time is the difference
                                      between a frames deadline and when it was rendered.</param>
        <summary>Increases the count by one for the bucket representing the relative frame time.</summary>
        <remarks>
          <para>Increases the count by one for the bucket representing the relative frame time.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/app/jank/RelativeFrameTimeHistogram#addRelativeFrameTimeMillis(int)" title="Reference documentation">Java documentation for <code>android.app.jank.RelativeFrameTimeHistogram.addRelativeFrameTimeMillis(int)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetBucketCounters">
      <MemberSignature Language="C#" Value="public virtual int[] GetBucketCounters ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32[] GetBucketCounters() cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.App.Jank.RelativeFrameTimeHistogram.GetBucketCounters" />
      <MemberSignature Language="F#" Value="abstract member GetBucketCounters : unit -&gt; int[]&#xA;override this.GetBucketCounters : unit -&gt; int[]" Usage="relativeFrameTimeHistogram.GetBucketCounters " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("getBucketCounters", "()[I", "GetGetBucketCountersHandler", ApiSince=36)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("getBucketCounters", "()[I", "GetGetBucketCountersHandler", ApiSince=36)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android36.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android36.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32[]</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the counts for the all the relative frame time buckets.</summary>
        <returns>an array of integers representing the counts of relative frame times. This value
            cannot be null.</returns>
        <remarks>
          <para>Returns the counts for the all the relative frame time buckets.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/app/jank/RelativeFrameTimeHistogram#getBucketCounters()" title="Reference documentation">Java documentation for <code>android.app.jank.RelativeFrameTimeHistogram.getBucketCounters()</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetBucketEndpointsMillis">
      <MemberSignature Language="C#" Value="public virtual int[] GetBucketEndpointsMillis ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32[] GetBucketEndpointsMillis() cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.App.Jank.RelativeFrameTimeHistogram.GetBucketEndpointsMillis" />
      <MemberSignature Language="F#" Value="abstract member GetBucketEndpointsMillis : unit -&gt; int[]&#xA;override this.GetBucketEndpointsMillis : unit -&gt; int[]" Usage="relativeFrameTimeHistogram.GetBucketEndpointsMillis " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("getBucketEndpointsMillis", "()[I", "GetGetBucketEndpointsMillisHandler", ApiSince=36)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("getBucketEndpointsMillis", "()[I", "GetGetBucketEndpointsMillisHandler", ApiSince=36)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android36.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android36.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32[]</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the relative frame time endpoints for the histogram.</summary>
        <returns>array of integers representing the endpoints for the predefined histogram count
            buckets. This value cannot be null.</returns>
        <remarks>
          <para>Returns the relative frame time endpoints for the histogram.</para>
          <para>Index <c>i</c> of <c>#getBucketCounters</c> contains the count of frames that had a
            relative frame time between <c>endpoints[i]</c> (inclusive) and <c>endpoints[i+1]</c>
            (exclusive).</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/app/jank/RelativeFrameTimeHistogram#getBucketEndpointsMillis()" title="Reference documentation">Java documentation for <code>android.app.jank.RelativeFrameTimeHistogram.getBucketEndpointsMillis()</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="JniPeerMembers">
      <MemberSignature Language="C#" Value="public override Java.Interop.JniPeerMembers JniPeerMembers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Java.Interop.JniPeerMembers JniPeerMembers" />
      <MemberSignature Language="DocId" Value="P:Android.App.Jank.RelativeFrameTimeHistogram.JniPeerMembers" />
      <MemberSignature Language="F#" Value="member this.JniPeerMembers : Java.Interop.JniPeerMembers" Usage="Android.App.Jank.RelativeFrameTimeHistogram.JniPeerMembers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Java.Interop.JniPeerMembers</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdClass">
      <MemberSignature Language="C#" Value="protected override IntPtr ThresholdClass { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int ThresholdClass" />
      <MemberSignature Language="DocId" Value="P:Android.App.Jank.RelativeFrameTimeHistogram.ThresholdClass" />
      <MemberSignature Language="F#" Value="member this.ThresholdClass : nativeint" Usage="Android.App.Jank.RelativeFrameTimeHistogram.ThresholdClass" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdType">
      <MemberSignature Language="C#" Value="protected override Type ThresholdType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Type ThresholdType" />
      <MemberSignature Language="DocId" Value="P:Android.App.Jank.RelativeFrameTimeHistogram.ThresholdType" />
      <MemberSignature Language="F#" Value="member this.ThresholdType : Type" Usage="Android.App.Jank.RelativeFrameTimeHistogram.ThresholdType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Type</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>